Skip to main content

Thin wrapper to run emissions scenarios with simple climate models

Project description

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 .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openscm_runner-0.13.0.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

openscm_runner-0.13.0-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file openscm_runner-0.13.0.tar.gz.

File metadata

  • Download URL: openscm_runner-0.13.0.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for openscm_runner-0.13.0.tar.gz
Algorithm Hash digest
SHA256 aa1887d9356c11ed4b6ae8f502440b40d17b82220a79949e170daa39d4fe8f7e
MD5 b9ac9bdf98c26d32d9fa9fc05ff4ef9b
BLAKE2b-256 91ec7db824e63c813a45b43c30235c5d7bc14030085f59fa86b50ae3d1a2525a

See more details on using hashes here.

Provenance

File details

Details for the file openscm_runner-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: openscm_runner-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for openscm_runner-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ffb5f311942d70961b1aa5f68b0a0187b1f7b064b1744ed3bd55bb1b25bc587
MD5 ebf084c54aa1925fe86c9446357065d2
BLAKE2b-256 867698b9b37a2117ea8c4daab698b73657115c5fee8a01600923155c60df504b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page