openscm

Unified access to simple climate models (work in progress)

https://github.com/openscm/openscm

Keywords

Keywords from Contributors

Repository

Unified access to simple climate models (work in progress)

README.rst

OpenSCM
=======

|WIP| |Docs| |GithubActions|

.. sec-begin-long-description
.. sec-begin-index

**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.

This OpenSCM implementation comes with a command line tool
``openscm``.

Use guidelines
--------------

We encourage use of OpenSCM as much as possible and are open to collaboration.
If you plan to publish using OpenSCM, please be respectful of the work and the `Maintainers`_' willingness to open source their code.

In particular, when using OpenSCM, please cite the DOI of the precise version of the package used and consider citing our package description paper [when it's written, which it's not yet :)].
As appropriate, please consider also citing the wrappers and models that OpenSCM relies on.
A way to cite OpenSCM alongside the references to the wrappers and original models can be found in the documentation and are available in bibtex format in the ``CITATION`` file.

Of course, there is a balance, and no single rule will fit all situations.
If in doubt, don't hestiate to contact the `Maintainers`_ and ask.

Maintainers
-----------

Current maintainers of OpenSCM are:

-  `Robert Gieseke `__
   <`robert.gieseke@pik-potsdam.de
   `__>
-  `Jared Lewis `__
   <`jared.lewis@climate-energy-college.org
   `__>
-  `Zebedee Nicholls `__
   <`zebedee.nicholls@climate-energy-college.org
   `__>
-  `Sven Willner `__
   <`sven.willner@pik-potsdam.de
   `__>

.. sec-end-index

Documentation
-------------

Detailed documentation is available at `ReadTheDocs
`_.

.. sec-end-long-description

Schema
------

.. image:: docs/static/schema_small.png
    :align: center

.. sec-begin-installation

Installation
------------

To install OpenSCM run

.. code:: bash

    pip install openscm

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

.. code:: bash

    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).

.. sec-end-installation
.. sec-begin-quickstart

Quickstart
----------

.. sec-end-quickstart
.. sec-begin-development

Development
-----------

.. code:: bash

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

Tests can be run locally with

.. code:: bash

    python setup.py test

.. sec-end-development

.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
    :target: https://openscm.readthedocs.io/en/latest/
.. |WIP| image:: https://img.shields.io/badge/state-work%20in%20progress-red.svg?style=flat
    :target: https://github.com/openclimatedata/openscm/milestone/1
.. |GithubActions| image:: https://wdp9fww0r9.execute-api.us-west-2.amazonaws.com/production/badge/openclimatedata/openscm?style=flat
    :target: https://github.com/openclimatedata/openscm/actions

Owner

Citation (CITATION)

OpenSCM
-------

To cite OpenSCM, please use the following citation (also provided in bibtex below).

[Citations to be written]

Wrappers
--------

@article{gieseke2018pymagicc,
  doi = {10.21105/joss.00516},
  year = 2018,
  month = {2},
  publisher = {The Open Journal},
  volume = {3},
  number = {22},
  pages = {516},
  author = {Robert Gieseke and Sven N Willner and Matthias Mengel},
  title = {Pymagicc: A Python wrapper for the simple climate model {MAGICC}},
  journal = {The Journal of Open Source Software}
}

@article{willner2017pyhector,
    doi = {10.21105/joss.00248},
    year = 2017,
    month = {4},
    publisher = {The Open Journal},
    volume = {2},
    number = {12},
    pages = {248},
    author = {Sven N Willner and Corinne Hartin and Robert Gieseke},
    title = {pyhector: A Python interface for the simple climate model Hector},
    journal = {The Journal of Open Source Software}
}


Models
------

@article{meinshausen2011magiccdescription,
    doi = {10.5194/acp-11-1417-2011},
    year = 2011,
    month = {feb},
    publisher = {Copernicus {GmbH}},
    volume = {11},
    number = {4},
    pages = {1417--1456},
    author = {M. Meinshausen and S. C. B. Raper and T. M. L. Wigley},
    title = {Emulating coupled atmosphere-ocean and carbon cycle models with a simpler model, {MAGICC}6 {\textendash} Part 1: Model description and calibration},
    journal = {Atmospheric Chemistry and Physics}
}

@article{smith2018fairv13,
    author = {Smith, C. J. and Forster, P. M. and Allen, M. and Leach, N. and Millar, R. J. and Passerello, G. A. and Regayre, L. A.},
    title = {FAIR v1.3: a simple emissions-based impulse response and carbon cycle model},
    journal = {Geoscientific Model Development},
    volume = {11},
    year = {2018},
    number = {6},
    pages = {2273--2297},
    url = {https://www.geosci-model-dev.net/11/2273/2018/},
    doi = {10.5194/gmd-11-2273-2018}
}

@article{hartin2015hectorv10,
    doi = {10.5194/gmd-8-939-2015},
    year = 2015,
    month = {4},
    publisher = {Copernicus {GmbH}},
    volume = {8},
    number = {4},
    pages = {939--955},
    author = {C. A. Hartin and P. Patel and A. Schwarber and R. P. Link and B. P. Bond-Lamberty},
    title = {A simple object-oriented and open-source model for scientific and policy analyses of the global climate system {\textendash} Hector v1.0},
    journal = {Geoscientific Model Development}
}

GitHub Events

Committers

Last synced: over 1 year ago

Issues and Pull Requests

Last synced: 6 months ago