Metadata-Version: 2.1
Name: climate-assessment
Version: 0.1.2
Summary: Climate assessment of long-term emissions pathways: IPCC AR6 WGIII version
Home-page: https://github.com/iiasa/climate-assessment
Author: Jarmo S. Kikstra, Zebedee R.J. Nicholls, Jared Lewis, Christopher J. Smith, Robin D. Lamboll, Edward Byers, Marit Sandstad, Laura Wienpahl, Philip Hackstock
Author-email: kikstra@iiasa.ac.at
License: MIT License
Project-URL: Source, http://github.com/iiasa/climate-assessment
Project-URL: Documentation, https://climate-assessment.readthedocs.io/
Project-URL: Bug_Reports, https://github.com/iiasa/climate-assessment/issues
Keywords: climate,integrated assessment,emissions,temperature,IPCC
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: aneris-iamc (==0.3.1)
Requires-Dist: awscli (==1.27.134)
Requires-Dist: click
Requires-Dist: fair (==1.6.2)
Requires-Dist: importlib-metadata
Requires-Dist: joblib
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: openscm-units (==0.5.0)
Requires-Dist: openscm-runner (==0.9.1)
Requires-Dist: pandas
Requires-Dist: pint (<=0.20,>=0.13)
Requires-Dist: pooch
Requires-Dist: pyam-iamc (==1.7.0)
Requires-Dist: pymagicc (==2.1.3)
Requires-Dist: requests
Requires-Dist: scmdata (==0.15.0)
Requires-Dist: silicone (==1.3.0)
Requires-Dist: tqdm
Requires-Dist: xarray
Provides-Extra: deploy
Requires-Dist: twine (>=1.11.0) ; extra == 'deploy'
Requires-Dist: wheel (>=0.31.0) ; extra == 'deploy'
Provides-Extra: dev
Requires-Dist: sphinx (==5.3.0) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: codecov ; extra == 'dev'
Requires-Dist: nbval ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-console-scripts ; extra == 'dev'
Requires-Dist: pytest (>=4.0) ; extra == 'dev'
Requires-Dist: twine (>=1.11.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.31.0) ; extra == 'dev'
Requires-Dist: bandit ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: black-nb ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: notebook ; extra == 'dev'
Requires-Dist: ipywidgets ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (==5.3.0) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: linter
Requires-Dist: bandit ; extra == 'linter'
Requires-Dist: black ; extra == 'linter'
Requires-Dist: black-nb ; extra == 'linter'
Requires-Dist: flake8 ; extra == 'linter'
Requires-Dist: isort ; extra == 'linter'
Provides-Extra: notebooks
Requires-Dist: notebook ; extra == 'notebooks'
Requires-Dist: ipywidgets ; extra == 'notebooks'
Provides-Extra: tests
Requires-Dist: codecov ; extra == 'tests'
Requires-Dist: nbval ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-console-scripts ; extra == 'tests'
Requires-Dist: pytest (>=4.0) ; extra == 'tests'

`climate-assessment` - Assessing the climate outcomes of future emissions scenarios
===================================================================================
.. image:: https://zenodo.org/badge/501176611.svg
   :target: https://zenodo.org/badge/latestdoi/501176611

****

*Please note that ``climate-assessment`` is still in early developmental stages, thus all interfaces are subject to change.*

The package ``climate-assessment`` provides the possibility to reproduce the climate variable data for the working group III (WGIII or WG3) contribution to the IPCC Sixth Assessment (AR6) report, using climate emulators that were used in the working group I (WGI or WG1) contribution to AR6.
It also allows for assessing new emissions pathways in a way that is fully consistent with AR6.

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

Using ``pip``
~~~~~~~~~~~~~~~~

`pip`_ is Python's default package management system.

.. attention:: Due to the better dependency resolution installing with ``pip>=22`` is recommended.

If you install Anaconda, then ``pip`` is also usable.
``pip`` can also be used when Python is installed directly, *without* using Anaconda.

1. Ensure ``pip`` is installed—with Anaconda, or according to the pip documentation.

2. Open a command prompt and run::

    $ pip install climate-assessment

From source
~~~~~~~~~~~

(Optional) If you intend to contribute changes to ``climate-assessment``, installing
directly from `source <https://github.com/iiasa/climate-assessment>`_ is the way to go.

Detailed instructions on how to do this can be found in the documentation under https://climate-assessment.readthedocs.io/en/latest/install.html.

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

All documentation, including installation instructions, can be found at https://climate-assessment.readthedocs.io/.


License
-------

Licensed under an MIT License. See the LICENSE file for more information.


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

Raising an issue
~~~~~~~~~~~~~~~~
If you have a suggestion for development, or find a bug, please report this under: https://github.com/iiasa/climate-assessment/issues.

Running the tests
~~~~~~~~~~~~~~~~~

The tests can be run with ``pytest``. On a Linux system, you should run something like ``MAGICC_PROBABILISTIC_FILE=path/to/probabilistic-file pytest tests``.
Note that for the tests to work properly, you must set up your ``.env`` file (see "Environment" section above).
On Windows, the environment variables (like ``MAGICC_PROBABILISTIC_FILE=path/to/probabilistic-file``) should be set system-wide, and the command reads ``pytest tests``.

Formatting code
~~~~~~~~~~~~~~~

Before committing or merging code, the following lines should be run to ensure that the formatting is consistent with what is expected by the Continuous Integration setup (for users with ``make`` installed, ``make checks`` will run these for you):

.. code:: bash

    black src scripts tests setup.py
    isort src scripts tests setup.py
    flake8 src scripts tests setup.py

.. _pip: https://pip.pypa.io/en/stable/user_guide/
