znicholls / openscm

Unified access to simple climate models (work in progress)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OpenSCM

WIP Docs GithubActions

Warning: OpenSCM is still work in progress and cannot be fully used yet! However, we are very grateful for suggestions and critique on how you would like to use this framework. Please have a look at the issues and feel free to create new ones/upvote ones that would really help you.

The Open Simple Climate Model framework unifies access to several simple climate models (SCMs). It defines a standard interface for getting and setting model parameters, input and output data as well as for running the models. Additionally, OpenSCM provides a standardized file format for these parameters and scenarios including functions for reading and writing such files. It further adds convenience functions and easily enables ensemble runs, e.g. for scenario assessment or model tuning.

Being designed as a programming-language agnostic interface and standard in mind, this will be the reference implementation in Python 3.

This OpenSCM implementation comes with a command line tool openscm.

Documentation

Detailed documentation is given on ReadTheDocs.

Schema

docs/static/schema_small.png

Installation

To install OpenSCM run

pip install openscm

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

pip install openscm[notebooks]

OpenSCM comes with model adapters only for some very simple SCMs. If you want to run other models, you will also need to install their dependencies (see ReadTheDocs for a list).

Quickstart

Development

git clone git@github.com:openclimatedata/openscm.git
pip install -e .

Tests can be run locally with

python setup.py test

Maintainers

Current maintainers of OpenSCM are:

About

Unified access to simple climate models (work in progress)

License:GNU Affero General Public License v3.0


Languages

Language:Python 97.3%Language:HCL 1.4%Language:Makefile 1.3%