https://github.com/ecmwf-projects/figbird
Statistical plotting templates with a focus on climate and meteorology applications
https://github.com/ecmwf-projects/figbird
Last synced: 5 months ago
JSON representation
Statistical plotting templates with a focus on climate and meteorology applications
- Host: GitHub
- URL: https://github.com/ecmwf-projects/figbird
- Owner: ecmwf-projects
- License: apache-2.0
- Created: 2022-09-22T14:34:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-27T16:17:48.000Z (over 3 years ago)
- Last Synced: 2024-12-29T00:59:14.971Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 63.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# figbird
Statistical plotting templates for climate applications
## Quick Start
```python
>>> import figbird
```
## Workflow for developers/contributors
For best experience create a new conda environment (e.g. DEVELOP) with Python 3.10:
```
conda create -n DEVELOP -c conda-forge python=3.10
conda activate DEVELOP
```
Before pushing to GitHub, run the following commands:
1. Update conda environment: `make conda-env-update`
1. Install this package: `pip install -e .`
1. Sync with the latest [template](https://github.com/ecmwf-projects/cookiecutter-conda-package) (optional): `make template-update`
1. Run quality assurance checks: `make qa`
1. Run tests: `make unit-tests`
1. Run the static type checker: `make type-check`
1. Build the documentation (see [Sphinx tutorial](https://www.sphinx-doc.org/en/master/tutorial/)): `make docs-build`
## License
```
Copyright 2022, European Centre for Medium Range Weather Forecasts.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```