OpenSCM Calibration

Calibration tools for simple climate models (with potential for applications elsewhere)

Key info :

PyPI :

Tests :

Other info :

Status

• development: the project is actively being worked on

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

Installation

As an application

If you want to use OpenSCM Calibration as an application, then we recommend using the 'locked' version of the package. This version pins the version of all dependencies too, which reduces the chance of installation issues because of breaking updates to dependencies.

The locked version of OpenSCM Calibration can be installed with

=== "pip" sh pip install openscm-calibration[locked]

As a library

If you want to use OpenSCM Calibration as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below. This method provides the loosest pins possible of all dependencies. This gives you, the package/application developer, as much freedom as possible to set the versions of different packages. However, the tradeoff with this freedom is that you may install incompatible versions of OpenSCM Calibration's dependencies (we cannot test all combinations of dependencies, particularly ones which haven't been released yet!). Hence, you may run into installation issues. If you believe these are because of a problem in OpenSCM Calibration, please raise an issue.

The (non-locked) version of OpenSCM Calibration can be installed with

=== "pip" sh pip install openscm-calibration

Additional dependencies can be installed using

=== "pip" sh # To add plotting dependencies pip install openscm-calibration[plots]

For developers

For development, we rely on pdm for all our dependency management. To get started, you will need to make sure that pdm is installed (instructions here, although we found that installing with pipx worked perfectly for us).

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 [development][development].

Original template

This project was generated from this template: copier core python repository. copier is used to manage and distribute this template.