https://github.com/openscm/pymagicc
Python wrapper for the simple climate model MAGICC
https://github.com/openscm/pymagicc
climate-model magicc-model python-wrapper
Last synced: 3 months ago
JSON representation
Python wrapper for the simple climate model MAGICC
- Host: GitHub
- URL: https://github.com/openscm/pymagicc
- Owner: openscm
- License: bsd-3-clause
- Created: 2017-02-03T10:34:12.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T08:30:34.000Z (9 months ago)
- Last Synced: 2024-10-29T22:30:39.207Z (6 months ago)
- Topics: climate-model, magicc-model, python-wrapper
- Language: Jupyter Notebook
- Homepage: https://pymagicc.readthedocs.io/
- Size: 46.3 MB
- Stars: 39
- Watchers: 10
- Forks: 27
- Open Issues: 38
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - Pymagicc - A Python wrapper around the reduced complexity climate model. (Climate Change / Earth and Climate Modeling)
README
Pymagicc
========
+-------------------+----------------+--------------+--------+
| Repository health | |CI CD| | |Coverage| | |Docs| |
+-------------------+----------------+--------------+--------+
+------+------------------+----------------+------------------+
| Pypi | |PyPI Install| | |PyPI| | |PyPI Version| |
+------+------------------+----------------+------------------+
+-------+-----------------+-------------------+-----------------+
| Conda | |conda install| | |conda platforms| | |conda version| |
+-------+-----------------+-------------------+-----------------+
+-------+--------+----------+
| Paper | |JOSS| | |Zenodo| |
+-------+--------+----------+
+--------+-----------------+
| Binder | |Launch Binder| |
+--------+-----------------+
+-----------------+----------------+---------------+-----------+
| Other info | |Contributors| | |Last Commit| | |License| |
+-----------------+----------------+---------------+-----------+
.. sec-begin-links
.. |CI CD| image:: https://github.com/openscm/pymagicc/workflows/pymagicc%20CI-CD/badge.svg
:target: https://github.com/openscm/pymagicc/actions?query=workflow%3A%22pymagicc+CI-CD%22
.. |Coverage| image:: https://codecov.io/gh/openscm/pymagicc/branch/master/graph/badge.svg
:target: https://codecov.io/gh/openscm/pymagicc
.. |Docs| image:: https://readthedocs.org/projects/pymagicc/badge/?version=latest
:target: https://pymagicc.readthedocs.io/en/latest/?badge=latest
.. |PyPI Install| image:: https://github.com/openscm/pymagicc/workflows/Test%20PyPI%20install/badge.svg
:target: https://github.com/openscm/pymagicc/actions?query=workflow%3A%22Test+PyPI+install%22
.. |PyPI| image:: https://img.shields.io/pypi/pyversions/pymagicc.svg
:target: https://pypi.org/project/pymagicc/
.. |PyPI Version| image:: https://img.shields.io/pypi/v/pymagicc.svg
:target: https://pypi.org/project/pymagicc/
.. |conda install| image:: https://github.com/openscm/pymagicc/workflows/Test%20conda%20install/badge.svg
:target: https://github.com/openscm/pymagicc/actions?query=workflow%3A%22Test+conda+install%22
.. |conda platforms| image:: https://img.shields.io/conda/pn/conda-forge/pymagicc.svg
:target: https://anaconda.org/conda-forge/pymagicc
.. |conda version| image:: https://img.shields.io/conda/vn/conda-forge/pymagicc.svg
.. |JOSS| image:: https://joss.theoj.org/papers/85eb9a9401fe968073bb429ea361924e/status.svg
:target: https://joss.theoj.org/papers/85eb9a9401fe968073bb429ea361924e
.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1111815.svg
:target: https://zenodo.org/record/1111815
.. |Launch Binder| image:: https://img.shields.io/badge/launch-binder-e66581.svg
:target: https://mybinder.org/v2/gh/openscm/pymagicc/master?filepath=notebooks/Example.ipynb
.. |Contributors| image:: https://img.shields.io/github/contributors/openscm/pymagicc.svg
:target: https://github.com/openscm/pymagicc/graphs/contributors
.. |Last Commit| image:: https://img.shields.io/github/last-commit/openscm/pymagicc.svg
:target: https://github.com/openscm/pymagicc/commits/master
.. |License| image:: https://img.shields.io/github/license/openscm/pymagicc.svg
:target: https://github.com/openscm/pymagicc/blob/master/LICENSE
.. sec-end-links
.. sec-begin-index
.. sec-begin-long-description
Pymagicc is a Python wrapper around the reduced complexity climate model
`MAGICC6 `_. It wraps the CC-BY-NC-SA licensed
`MAGICC6 binary `_. Pymagicc itself is BSD-3 licensed.
MAGICC (Model for the Assessment of Greenhouse Gas Induced Climate Change)
is widely used in the assessment of future emissions pathways in climate policy analyses,
e.g. in the Fifth Assessment Report of the
Intergovernmental Panel on Climate Change or to model the physical aspects of climate change in Integrated Assessment Models (IAMs).
Pymagicc makes the MAGICC model easily installable and usable from Python and allows for the easy modification of all MAGICC model parameters and emissions scenarios directly from Python.
In climate research it can, for example, be used in the analysis of mitigation scenarios, in Integrated Assessment Models, complex climate model emulation, and uncertainty analyses, as well as in climate science education and communication.
See `www.magicc.org `_ and `Meinshausen et al. 2011 `_ for further information.
.. sec-end-long-description
.. sec-end-index
Basic Usage
-----------
.. sec-begin-usage
.. code:: python
import matplotlib.pyplot as plt
import pymagicc
import scmdata
from pymagicc import rcps
results = []
for scen in rcps.groupby("scenario"):
results_scen = pymagicc.run(scen)
results.append(results_scen)
results = scmdata.run_append(results)
temperature_rel_to_1850_1900 = (
results
.filter(variable="Surface Temperature", region="World")
.relative_to_ref_period_mean(year=range(1850, 1900 + 1))
)
temperature_rel_to_1850_1900.lineplot()
plt.title("Global Mean Temperature Projection")
plt.ylabel("°C over pre-industrial (1850-1900 mean)");
# Run `plt.show()` to display the plot when running this example
# interactively or add `%matplotlib inline` on top when in a Jupyter Notebook.
.. sec-begin-example-plot
.. image:: scripts/example-plot.png
:align: center
.. sec-end-example-plot
For more example usage see this `Jupyter Notebook `_.
Thanks to the `Binder project `_ the `Notebook `_ can be run and modified without installing anything locally.
.. sec-end-usage
.. sec-begin-installation
Installation
------------
::
pip install pymagicc
On Linux and OS X the original compiled Windows binary available on
``_ and included in Pymagicc
can run using `Wine `_.
On modern 64-bit systems one needs to use the 32-bit version of Wine
::
sudo dpkg --add-architecture i386
sudo apt-get install wine32
On 32-bit systems Debian/Ubuntu-based systems ``wine`` can be installed with
::
sudo apt-get install wine
On OS X ``wine`` is available in the Homebrew package manager:
::
brew install wine
It should also be available in other package managers, as well as directly from the `Wine project `_.
Note that after the first install the first run of Pymagicc might be slow due
to setting up of the `wine` configuration and be accompanied by pop-ups or
debug output.
To run an example session using Jupyter Notebook and Python 3 you can run the
following commands to create a virtual environment ``venv`` and install an
editable version for local development:
.. code:: bash
git clone https://github.com/openscm/pymagicc.git
cd pymagicc
make venv
./venv/bin/pip install --editable .
./venv/bin/jupyter-notebook notebooks/Example.ipynb
.. sec-end-installation
.. sec-begin-development
Development
-----------
Setup
*****
For local development, install dependencies and an editable version of Pymagicc from a clone or download of the Pymagicc repository with
::
make venv
./venv/bin/pip install --editable .
Running the tests
*****************
To run the tests run
::
./venv/bin/pytest tests --verbose
To skip tests which run MAGICC and take longer use
::
./venv/bin/pytest tests --skip-slow
To get a test coverage report, run
::
./venv/bin/pytest --cov
Conventions
***********
Style
~~~~~
To unify coding style, allowing us to focus more on writing useful code and less time worrying about formatting, `black `_ is used.
To format the files in ``pymagicc`` and ``tests`` as well as ``setup.py`` run
::
make black
Csvs
~~~~
In our miscellaneous csv's, for example the definitional csv's, we follow the following conventions to make our lives easier:
- column names are all lower case, with underscores as separators (i.e. no spaces)
Dependencies
~~~~~~~~~~~~
A user of pymagicc should be able to pip install and run all of our notebooks.
This means that all of the libraries for running notebooks should be explicit dependencies, rather than being included in an extras requirement.
Whilst this means that we have more dependencies, it makes it easier for end users and avoids extremely cryptic import errors.
Building the documentation
**************************
The docs use Sphinx and can be rebuilt locally in ``docs/builds/html/`` with
::
make docs
.. sec-end-development
More usage examples
-------------------
.. sec-begin-more-usage
Use an included scenario
************************
.. code:: python
from pymagicc.scenarios import rcp26
rcp26.head()
Read a MAGICC scenario file
***************************
.. code:: python
from pymagicc.scenarios import read_scen_file
scenario = read_scen_file("PATHWAY.SCEN")
Run MAGICC for a scenario
*************************
.. code:: python
import pymagicc
from pymagicc.scenarios import read_scen_file
scenario = read_scen_file("PATHWAY.SCEN")
results = pymagicc.run(scenario)
temperature_rel_to_1850_1900 = (
results
.filter(variable="Surface Temperature")
.relative_to_ref_period_mean(year=range(1850, 1900 + 1))
)
Using a different MAGICC version
********************************
A custom version of MAGICC may be used with ``pymagicc`` using the
``MAGICC_EXECUTABLE_6`` and ``MAGICC_EXECUTABLE_7`` environment variables for MAGICC6
and MAGICC7 respectively. These environment variables should be set to the
location of the magicc executable (either ``magicc`` for linux/mac or
``magicc.exe`` for Windows).
For example, a custom MAGICC7 folder located at ``/tmp/magicc`` can be used on
under Linux by setting ``MAGICC_EXECUTABLE_7`` to ``/tmp/magicc/run/magicc``.
Example usage in Bash:
.. code:: bash
MAGICC_EXECUTABLE_7=/tmp/magicc/run/magicc.exe make test
Or in a script:
.. code:: bash
#!/bin/bash
export MAGICC_EXECUTABLE_7=tmp/magicc/run/magicc.exe
make test
.. sec-end-more-usage
Contributing
------------
.. sec-begin-contributing
Please report issues or discuss feature requests on Pymagicc's
`issue tracker `_.
You can also contact the `pymagicc` authors via email:
``_
.. sec-end-contributing
.. sec-begin-license
License
-------
The `compiled MAGICC binary `_ by Tom Wigley,
Sarah Raper, and Malte Meinshausen included in this package is licensed under a `Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License `_.
See also the `MAGICC website `_ and
`Wiki `_
for further information.
The ``pymagicc`` wrapper itself is released under a BSD-3 license. For details, see `LICENSE <./LICENSE>`_.
Citation
--------
If you make any use of MAGICC, its license requires citing of:
M. Meinshausen, S. C. B. Raper and T. M. L. Wigley (2011). "Emulating coupled
atmosphere-ocean and carbon cycle models with a simpler model, MAGICC6: Part I
"Model Description and Calibration." Atmospheric Chemistry and Physics 11: 1417-1456.
`https://doi.org/10.5194/acp-11-1417-2011 `_
If you use Pymagicc in your research, please additionally cite
R. Gieseke, S. N. Willner and M. Mengel, (2018). Pymagicc: A Python wrapper
for the simple climate model MAGICC. Journal of Open Source Software, 3(22),
516, `https://doi.org/10.21105/joss.00516 `_
For proper reproducibility please reference the version of Pymagicc used. In
Python it can be printed with
.. code:: python
import pymagicc
print(pymagicc.__version__)
Pymagicc releases are archived at Zenodo and the version used should also be cited.
See ``_.
.. sec-end-license