Skip to main content

scmcallib is a tool to make it easy to derive parameter sets for Simple Climate Models (SCMs). At the moment, the two focus use cases are:

  • “emulation” of other, typically more complex and computationally expensive models

  • “calibration” to observations i.e. the derivation of parameter sets which allow the SCM response to span the range of uncertainty of historical observations

This package fits into a wider ecosystem of tools which are aiming to create a transparent and reproducible way of generating parameter sets for a wide range of SCMs, observations and climate model outputs in a number of use cases. scmcallib uses scmdata and netcdf-scm to make it easy to interface to a range of SCMs and climate model output, hiding the complexity of running these ‘simple’ climate models and processing complex model output.

Getting Started

A number of the libraries used in scmcallib require compiled libraries and other system dependencies. To make it easier to get started with this project it is recommended to set up a new Conda environment to isolate these libraries. As this package is not currently installable via pypi, you have to install it from source.

$ git clone git://gitlab.com/magicc/scmcallib
$ cd scmcallib
$ conda env create --name scmcallib --file environment.yml
$ conda activate scmcallib
$ pip install -e .

Having installed, the scmcallib package is ready to generate parameter sets.

Emulation

Emulation is the process of finding a set of parameters which best fit output from another model. Once this best fit point in parameter space has been found, the SCM provides a computationally cheap method for exploring how the these larger models would respond under various scenarios.

TODO: Add documention about extracting

Before we can start emulating a model we must define the initial guess of the parameter distributions (i.e. the priors), for the parameters that are being constrained.

[TODO: decide whether to put this example in e.g. a notebook so it’s under CI]

from scmcallib import ParameterSet

best_guess_c1 = 0.631
best_guess_c2 = 0.429
best_guess_a1 = 0.2240

param_set = ParameterSet()
param_set.set_tune('c1', Bound(Normal(mu=best_guess_c1, sd=1.), lower=0.1))
param_set.set_tune('c2', Bound(Normal(mu=best_guess_c2, sd=0.1), lower=0.1))
param_set.set_tune('a1', Bound(Normal(mu=best_guess_a1, sd=0.1), lower=0.0, upper=0.4))

Once we have the data and parameters which describe how the model will be constrained, we can instantiate the PointEstimateFinder. In this example we are using the A5IR SCM [TODO: fill out AR5IR SCM so it actually is the full things], a basic, but very fast model to speed up to emulation process. The first step in emulation is finding the initial starting point for optimisation. This start point is then used by the optimiser to find the point in parameter space which minimise the differences between the SCM output and the target timeseries (typically taken from a more complex model).

from scmcallib import PointEstimateFinder
from scmcallib.scm import AR5IR_SCM
emulator = PointEstimateFinder(param_set, reference_period=(2000, 2010))
emulator.set_target(observed=observed_gmt)

with AR5IR_SCM() as scm:
    results = emulator.find_best_fit(scm, optimiser_name='bayesopt')

results.plot_summary()
results.plot_fit()

scmcallib provides a method for reading tuningcore files which are used by simcap to describe how to tune magicc.

Calibration

Run simple calibration example

  • edit calibration.py and run_calibration.py to fit your personal settings

  • then run python run_calibration.py

  • visualise with notebooks/show_calibration.ipynb

Metadata

Release files for scmcallib 0.5.1

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

Source distribution (sdist)

Source distribution for scmcallib 0.5.1
File Size Uploaded
scmcallib-0.5.1.tar.gz 72.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scmcallib 0.5.1
File Interpreter ABI Platform
scmcallib-0.5.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 128.8 kB

Release files / scmcallib-0.5.1.tar.gz

Download URL scmcallib-0.5.1.tar.gz
Size 72.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4bc36c400723b2c96e9ea16572ccf49572305c4aed22e319a7943fa8f3c90bd9
BLAKE2b-256 checksum
How to use checksums
fb98d56776e798216daec3d6330406cc7b658a83a492f2304279350dc942933d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

Release files / scmcallib-0.5.1-py2.py3-none-any.whl

Download URL scmcallib-0.5.1-py2.py3-none-any.whl
Size 56.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
83be80e827ee73bcab79b9e15f8be4bf226de5ba76399397142423c2da37ebd9
BLAKE2b-256 checksum
How to use checksums
011d40d340006f44bed4cb0976e70c2bde3daaee602f7e7c70f3efd507b6e439
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
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