diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 654902b..2eb66e7 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -19,7 +19,7 @@ master Added ~~~~~ - +- (`#15 `_) Fix packaging issues and add installation instructions - (`#6 `_) Added example run notebooks and tests thereof - (`#1 `_) Added :func:`climate_assessment.cli.run_workflow` diff --git a/MANIFEST.in b/MANIFEST.in index 07313d1..0ede516 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,3 @@ -include src/climate_assessment/data/*.csv +prune .github +prune .benchmarks +prune tests diff --git a/README.rst b/README.rst index 64beda3..5f1d88d 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,32 @@ 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 :mod:`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 :mod:`pip` is also usable. +:mod:`pip` can also be used when Python is installed directly, *without* using Anaconda. + +1. Ensure :mod:`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 :mod:`climate-assessment`, installing +directly from `source `_ 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 ------------- @@ -42,8 +68,10 @@ 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): -.. highlight:: bash +.. 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/ diff --git a/doc/install.rst b/doc/install.rst index eac48a3..6912bdd 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -10,6 +10,9 @@ Installation This package is tested using python 3.9, and has also been used with python 3.7, though continuous integration tests are not run for 3.7. +.. attention:: Due to the better dependency resolution installing with ``pip>=22`` is recommended. + + Using :mod:`pip` ================