Repository health |
Calibration tools for simple climate models (and other things perhaps, surprise us with your applications).
Full documentation can be found at https://openscm-calibration.readthedocs.io/.
OpenSCM-Calibration can be installed with conda or pip:
pip install openscm-calibration
conda install -c conda-forge openscm-calibration
Additional dependencies can be installed using
# To add plotting dependencies
pip install openscm-calibration[plots]
# To run the notebooks
pip install openscm-calibration[notebooks, plots]
# If you are installing with conda, we recommend
# installing the extras by hand because there is no stable
# solution yet (issue here: https://github.com/conda/conda/issues/7502)
For development, we rely on poetry for all our dependency management. To get started, you will need to make sure that poetry is installed (https://python-poetry.org/docs/#installing-with-the-official-installer, we found that pipx and pip worked better to install on a Mac).
For all of work, we use our Makefile
.
You can read the instructions out and run the commands by hand if you wish,
but we generally discourage this because it can be error prone and doesn't
update if dependencies change (e.g. the environment is updated).
In order to create your environment, run make virtual-environment -B
.
If there are any issues, the messages from the Makefile
should guide you
through. If not, please raise an issue in the
issue tracker.