/openscm-runner

Thin wrapper to run simple climate models (emissions driven runs only)

Primary LanguageJupyter NotebookBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

OpenSCM Runner

Repository health CI CD Docs
Pypi PyPI Install PyPI PyPI Version
Conda conda install conda platforms conda version
Other info Contributors Last Commit License

Brief summary

OpenSCM-Runner is a thin wrapper to run simple climate models with a unified interface. At present, it supports emissions driven runs only. This wrapper is implemented whilst OpenSCM is still a work in progress.

License

OpenSCM-Runner is free software under a BSD 3-Clause License, see LICENSE.

Installation

OpenSCM-Runner can be installed with conda

conda install -c conda-forge openscm-runner

Note that the above only installs base dependencies. To install all the requirements for MAGICC, use the below

# MAGICC
conda install -c conda-forge openscm-runner pymagicc

To install all the requirements for FaIR, use the below

# FaIR
conda install -c conda-forge -c chrisroadmap openscm-runner fair

OpenSCM-Runner can also be installed with pip

pip install openscm-runner

To install the dependencies required by all models known to OpenSCM-Runner, add additional dependencies using

pip install openscm-runner[models]

To only install the dependencies required by a specific model, use one of the following instead

# MAGICC
pip install openscm-runner[magicc]
# FaIR
pip install openscm-runner[fair]

If you also want to run the example notebooks install additional dependencies using

pip install openscm-runner[notebooks]

Documentation

Documentation can be found at our documentation pages (we are thankful to Read the Docs for hosting us).

Contributing

Please see the Development section of the docs.