Skip to content

Commit

Permalink
update docs and readme to point to groups.io and RTD (#264)
Browse files Browse the repository at this point in the history
* reorder badges on index page

* rewrite of pyam teaser to focus on 'scenario' (rather than ' model')

* switch from googlegroups to `groups.io`

* add reference to Slack workspace

* minor rewrite in `CONTRIBUTING`

* update docs page reference to RTD

* add Slack email with predefined subject
  • Loading branch information
danielhuppmann authored and gidden committed Aug 26, 2019
1 parent e50ddf6 commit 127680a
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 23 deletions.
11 changes: 7 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand All @@ -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.
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
------------------
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
24 changes: 11 additions & 13 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
**pyam**: analysis and visualization of assessment models
=========================================================
**pyam**: analysis and visualization of integrated-assessment scenarios
=======================================================================

.. |br| raw:: html

<br>

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/

Expand All @@ -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

Expand All @@ -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
--------

Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/pyam_first_steps.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 127680a

Please sign in to comment.