FOREST - Forecast and Observation Research and Evaluation Survey Tool
This repository hosts the code to visualise forecast model output and observation data in a web portal, as well as the scripts and configuration files to deploy the server infrastructure.
Installation
The easiest way to install forest is with conda:
conda install -c conda-forge forest
Documentation
Please read the docs, they should address all of the most common issues, frequently asked questions, developer guides, tutorials, api references. They are a work in progress but should quickly become an invaluable resource over time.
Lite implementation
FOREST uses Bokeh's Tornado server and websocket connection to provide interactive plotting. An alternative architecture has been developed which uses a RESTful API and a JS front-end to make client-side interactions smoother.
The benefit of this approach is a stateless and scalable server-side. It is a work in progress and by no means a drop in replacement for FOREST.
Get in touch
As FOREST is a small code base with a small but dedicated team of developers we have fewer ways to communicate than larger projects. In any case we are very happy to hear from you and always appreciate help wherever we can find it. If you have suggestions for improvements, bugs that need reporting or sage advice to developers feel free to open/comment on issues.
Contributor instructions
To contribute to FOREST, please read the developer guide
To make things easier for ourselves and to allow contributions from as wide an audience as possible we recommend the following steps:
- Fork the repository
- Create a branch
- Write some code
- Submit a pull request
One of the core development team members will review your changes and offer advice to documentation, testing and styling before accepting your contribution. We look forward to hearing from you!
License
FOREST is licensed under the BSD 3-clause license
© Crown copyright 2019, Met Office.