`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/
Raw data
{
"_id": null,
"home_page": "https://github.com/iiasa/climate-assessment",
"name": "climate-assessment",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "climate,integrated assessment,emissions,temperature,IPCC",
"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",
"download_url": "https://files.pythonhosted.org/packages/29/bc/a81c0c0f4b8829cb9a0911e5a6cda39207ca57fe414afb9b9db98bd54eaa/climate-assessment-0.1.3.tar.gz",
"platform": null,
"description": "`climate-assessment` - Assessing the climate outcomes of future emissions scenarios\n===================================================================================\n.. image:: https://zenodo.org/badge/501176611.svg\n :target: https://zenodo.org/badge/latestdoi/501176611\n\n****\n\n*Please note that ``climate-assessment`` is still in early developmental stages, thus all interfaces are subject to change.*\n\nThe 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.\nIt also allows for assessing new emissions pathways in a way that is fully consistent with AR6.\n\nInstallation\n------------\n\nUsing ``pip``\n~~~~~~~~~~~~~~~~\n\n`pip`_ is Python's default package management system.\n\n.. attention:: Due to the better dependency resolution installing with ``pip>=22`` is recommended.\n\nIf you install Anaconda, then ``pip`` is also usable.\n``pip`` can also be used when Python is installed directly, *without* using Anaconda.\n\n1. Ensure ``pip`` is installed\u2014with Anaconda, or according to the pip documentation.\n\n2. Open a command prompt and run::\n\n $ pip install climate-assessment\n\nFrom source\n~~~~~~~~~~~\n\n(Optional) If you intend to contribute changes to ``climate-assessment``, installing\ndirectly from `source <https://github.com/iiasa/climate-assessment>`_ is the way to go.\n\nDetailed instructions on how to do this can be found in the documentation under https://climate-assessment.readthedocs.io/en/latest/install.html.\n\nDocumentation\n-------------\n\nAll documentation, including installation instructions, can be found at https://climate-assessment.readthedocs.io/.\n\n\nLicense\n-------\n\nLicensed under an MIT License. See the LICENSE file for more information.\n\n\nDevelopment\n-----------\n\nRaising an issue\n~~~~~~~~~~~~~~~~\nIf you have a suggestion for development, or find a bug, please report this under: https://github.com/iiasa/climate-assessment/issues.\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nThe tests can be run with ``pytest``. On a Linux system, you should run something like ``MAGICC_PROBABILISTIC_FILE=path/to/probabilistic-file pytest tests``.\nNote that for the tests to work properly, you must set up your ``.env`` file (see \"Environment\" section above).\nOn Windows, the environment variables (like ``MAGICC_PROBABILISTIC_FILE=path/to/probabilistic-file``) should be set system-wide, and the command reads ``pytest tests``.\n\nFormatting code\n~~~~~~~~~~~~~~~\n\nBefore 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):\n\n.. code:: bash\n\n black src scripts tests setup.py\n isort src scripts tests setup.py\n flake8 src scripts tests setup.py\n\n.. _pip: https://pip.pypa.io/en/stable/user_guide/\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Climate assessment of long-term emissions pathways: IPCC AR6 WGIII version",
"version": "0.1.3",
"project_urls": {
"Bug_Reports": "https://github.com/iiasa/climate-assessment/issues",
"Documentation": "https://climate-assessment.readthedocs.io/",
"Homepage": "https://github.com/iiasa/climate-assessment",
"Source": "http://github.com/iiasa/climate-assessment"
},
"split_keywords": [
"climate",
"integrated assessment",
"emissions",
"temperature",
"ipcc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f726462bb23a1539a039a4f1fb5da4574184b9aef04c78d720c4bced09463228",
"md5": "fb22901f24d8a6188b1df9c471d51cfd",
"sha256": "a642dfafd844f094ee3e867b827797e9150a0e3fd819ecff5038559a6a5c9d21"
},
"downloads": -1,
"filename": "climate_assessment-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb22901f24d8a6188b1df9c471d51cfd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 464844,
"upload_time": "2023-08-01T14:13:24",
"upload_time_iso_8601": "2023-08-01T14:13:24.180336Z",
"url": "https://files.pythonhosted.org/packages/f7/26/462bb23a1539a039a4f1fb5da4574184b9aef04c78d720c4bced09463228/climate_assessment-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29bca81c0c0f4b8829cb9a0911e5a6cda39207ca57fe414afb9b9db98bd54eaa",
"md5": "b478c54ca079fc8881f6067a9fa733ea",
"sha256": "0417e2c2e621c85a09de1f8335356a785a5bb3be82db9acc73308d941a90cdd5"
},
"downloads": -1,
"filename": "climate-assessment-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "b478c54ca079fc8881f6067a9fa733ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 846981,
"upload_time": "2023-08-01T14:13:25",
"upload_time_iso_8601": "2023-08-01T14:13:25.774339Z",
"url": "https://files.pythonhosted.org/packages/29/bc/a81c0c0f4b8829cb9a0911e5a6cda39207ca57fe414afb9b9db98bd54eaa/climate-assessment-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-01 14:13:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iiasa",
"github_project": "climate-assessment",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "climate-assessment"
}
JSON
