Global-mean climate assessment of global emissions scenarios.
Full documentation can be found at: gegca.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.
Global Emissions Global Climate Assessment can be installed with pip, mamba or conda:
pip install gegca
mamba install -c conda-forge gegca
conda install -c conda-forge gegca
Additional dependencies can be installed using
# To add plotting dependencies
pip install gegca[plots]
# To add notebook dependencies
pip install gegca[notebooks]
# 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 (instructions here, 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.
In order to create your environment, run make virtual-environment
.
If there are any issues, the messages from the Makefile
should guide you
through. If not, please raise an issue in the
issue tracker.