Skip to main content

OpenSCM-Runner

OpenSCM-Runner provides a unified API for running emissions scenarios with different simple climate models.

CI Coverage Docs

PyPI : PyPI PyPI: Supported Python versions PyPI install

Other info : License Last Commit Contributors

Full documentation can be found at: openscm-runner.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.

Installation

OpenSCM-Runner can be installed with conda or pip:

pip install openscm-runner
conda install -c conda-forge openscm-runner

Additional dependencies can be installed using

# To add notebook dependencies
pip install openscm-runner[notebooks]

# To add dependencies for all models
pip install openscm-runner[models]

# To add dependencies for MAGICC
pip install openscm-runner[magicc]

# To add dependencies for FaIR
pip install openscm-runner[fair]

# CICERO-SCM's Fortran binary requires no additional dependencies to be
# installed

# To add dependencies for CICERO-SCM's Python port
pip install openscm-runner[ciceroscmpy]

# 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 developers

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.

For the rest of our developer docs, please see .

Metadata

Release files for openscm-runner 0.13.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openscm-runner 0.13.0
File Size Uploaded
openscm_runner-0.13.0.tar.gz 1.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for openscm-runner 0.13.0
File Interpreter ABI Platform
openscm_runner-0.13.0-py3-none-any.whl Python 3 none any Details

Total release size: 3.5 MB

Release files / openscm_runner-0.13.0.tar.gz

Download URL openscm_runner-0.13.0.tar.gz
Size 1.7 MB
Tags Source
SHA-256 checksum
How to use checksums
aa1887d9356c11ed4b6ae8f502440b40d17b82220a79949e170daa39d4fe8f7e
BLAKE2b-256 checksum
How to use checksums
91ec7db824e63c813a45b43c30235c5d7bc14030085f59fa86b50ae3d1a2525a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

Release files / openscm_runner-0.13.0-py3-none-any.whl

Download URL openscm_runner-0.13.0-py3-none-any.whl
Size 1.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
5ffb5f311942d70961b1aa5f68b0a0187b1f7b064b1744ed3bd55bb1b25bc587
BLAKE2b-256 checksum
How to use checksums
867698b9b37a2117ea8c4daab698b73657115c5fee8a01600923155c60df504b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page