diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bd47ea737..8f458516b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -2,11 +2,14 @@ Have a question? Get in touch! ------------------------------ -- Report bugs, suggest features or view the source code `on GitHub`_. -- For less well defined questions or ideas, use the `mailing list`_. +- Send bug reports, suggest new features or view the source code `on GitHub`_, +- Reach out via our community mailing list hosted by `groups.io`_, +- Or send us an `email`_ to join our Slack_ workspace! -.. _mailing list: https://groups.google.com/forum/#!forum/pyam .. _on GitHub: http://github.com/IAMconsortium/pyam +.. _`groups.io`: https://groups.io/g/pyam +.. _`email`: mailto:pyam+owner@groups.io?subject=[pyam]%20Please%20add%20me%20to%20the%20Slack%20workspace +.. _Slack: https://slack.com Interested in Contributing? Welcome to the team! @@ -25,7 +28,7 @@ including a detailed description of the new feature and unit tests to illustrate the intended functionality. Code submitted via pull requests must adhere to the `pep8`_ style formats. -We do not require anyone to sign a *Contributor License Agreement*, because we +We do not require users to sign a *Contributor License Agreement*, because we believe that when posting ideas or submitting code to an open-source project, it should be obvious and self-evident that any such contributions are made in the spirit of open collaborative development. diff --git a/README.md b/README.md index 59b35134e..1db4e6438 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ pyam: a Python toolkit for Integrated Assessment Modeling ========================================================= -**Documentation: http://software.ene.iiasa.ac.at/pyam** -**Questions? Start a discussion on our [listserv](https://groups.google.com/forum/#!forum/pyam)** +**Documentation on [Read the Docs](https://pyam-iamc.readthedocs.io)** + +**Questions? Start a discussion on our [mailing list](https://groups.io/g/pyam)** Overview and scope ------------------ @@ -64,8 +65,8 @@ see [LICENSE](LICENSE) and [NOTICE](NOTICE.md) for details. Install ------- -For basic instructions see our -[website](http://software.ene.iiasa.ac.at/pyam/install.html). +For basic instructions, +[read the docs](https://pyam-iamc.readthedocs.io/en/stable/install.html). To install from source after cloning this repository, simply run diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index 8e7c8e439..acb02d15e 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -30,7 +30,7 @@ 1. Update on conda-forge: - A PR should automatically be opened by the bot after the Github release - confirm that any new depedencies are added there -1. Announce it on our mailing list: https://groups.google.com/forum/#!forum/pyam +1. Announce it on our mailing list: https://groups.io/g/pyam - Again, just copy the now rendered HTML from the Github release directly in the email 1. Confirm that the doc page is updated to the latest release: https://pyam-iamc.readthedocs.io/ diff --git a/doc/source/index.rst b/doc/source/index.rst index e379145d1..e3d6e8981 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,5 +1,5 @@ -**pyam**: analysis and visualization of assessment models -========================================================= +**pyam**: analysis and visualization of integrated-assessment scenarios +======================================================================= .. |br| raw:: html @@ -7,16 +7,12 @@ Release v\ |version|. -|rtd| |pypi| |conda| |license| |latest| +|pypi| |conda| |license| |latest| -|travis| |appveyor| |coveralls| +|rtd| |travis| |appveyor| |coveralls| |joss| |doi| -.. |rtd| image:: https://readthedocs.org/projects/pyam-iamc/badge/?version=latest - :target: https://pyam-iamc.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - .. |pypi| image:: https://img.shields.io/pypi/v/pyam-iamc.svg :target: https://pypi.python.org/pypi/pyam-iamc/ @@ -29,6 +25,10 @@ Release v\ |version|. .. |latest| image:: https://anaconda.org/conda-forge/pyam/badges/latest_release_date.svg :target: https://anaconda.org/conda-forge/pyam +.. |rtd| image:: https://readthedocs.org/projects/pyam-iamc/badge/?version=latest + :target: https://pyam-iamc.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + .. |travis| image:: https://travis-ci.org/IAMconsortium/pyam.svg?branch=master :target: https://travis-ci.org/IAMconsortium/pyam @@ -44,17 +44,15 @@ Release v\ |version|. .. |doi| image:: https://zenodo.org/badge/113359260.svg :target: https://zenodo.org/badge/latestdoi/113359260 -The **pyam** Python package provides a range of diagnostic tools and functions -for analyzing and visualizing data from your favorite assessment model(s). +The **pyam** Python package provides a suite of diagnostic tools and functions +for analyzing and visualizing input data and scenario results +of your favorite integrated-assessment model(s). The source code for **pyam** is available on `Github`_. .. _`Github`: https://github.com/IAMconsortium/pyam -.. _`groups.google.com/d/forum/pyam` : - https://groups.google.com/d/forum/pyam - Overview -------- diff --git a/doc/source/tutorials/pyam_first_steps.ipynb b/doc/source/tutorials/pyam_first_steps.ipynb index b5cb45a25..a36a37607 100644 --- a/doc/source/tutorials/pyam_first_steps.ipynb +++ b/doc/source/tutorials/pyam_first_steps.ipynb @@ -16,7 +16,7 @@ "The ``pyam`` package provides a range of diagnostic tools and functions \n", "for analyzing and working with scenario data following the IAMC template format.\n", "A comprehensive documentation of the package is available\n", - "at [software.ene.iiasa.ac.at/pyam/](http://software.ene.iiasa.ac.at/pyam/)\n", + "at [pyam-iamc.readthedocs.io](http://pyam-iamc.readthedocs.io)\n", "\n", "An illustrative example of the IAMC template is shown below;\n", "see [data.ene.iiasa.ac.at/database/](http://data.ene.iiasa.ac.at/database/) for more information.\n",