release notes

.github/workflows/black.yml

@@ -0,0 +1,10 @@
+name: black
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

.github/workflows/build-docs.yml

@@ -10,27 +10,15 @@ on:
     branches: [ '**' ]
 
 jobs:
-  pytest:
-    strategy:
-      matrix:
-        os:
-        - ubuntu-latest
-        python-version:
-        - '3.9'
-
-      fail-fast: false
-
-
-    runs-on: ${{ matrix.os }}
-    name: ${{ matrix.os }} py${{ matrix.python-version }}
-
+  docs:
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: '3.10'
 
     - name: Install Pandoc
       uses: r-lib/actions/setup-pandoc@v1
@@ -39,4 +27,4 @@ jobs:
       run: pip install -e .[tutorials,optional_plotting,docs]
 
     - name: Build the docs
-      run: make --directory=doc html
+      run: make --directory=docs html

.github/workflows/nightly.yml

@@ -1,4 +1,4 @@
-# This workflow installs the package on Python 3.8, runs the tests and builds the docs
+# This workflow installs the package, runs the tests and builds the docs
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: nightly
@@ -18,7 +18,7 @@ jobs:
         os:
         - ubuntu-latest
         python-version:
-        - '3.9'
+        - '3.10'
 
       fail-fast: false
 
@@ -48,6 +48,6 @@ jobs:
 
     - name: Build the docs
       run: |
-        cd doc
+        cd docs
         make html
         cd ..

.github/workflows/pytest-legacy.yml

@@ -20,15 +20,15 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.7.13'
+        python-version: '3.10'
 
     - name: Install specific out-dated version of dependencies
       # Update the package requirements when changing minimum dependency versions
       # Please also add a section "Dependency changes" to the release notes
-      run: pip install pandas==1.2.0 numpy==1.19.0 matplotlib==3.5.0 iam-units==2020.4.21 xlrd==2.0 pint==0.13
+      run: pip install pandas==2.0.0 numpy==1.23.0 matplotlib==3.6.0 iam-units==2020.4.21 xlrd==2.0.1 pint==0.13
 
     - name: Install other dependencies and package
       run: pip install .[tests,optional_plotting,optional_io_formats,tutorials]
 
     - name: Test with pytest
-      run: pytest tests --mpl
+      run: pytest tests

.github/workflows/pytest.yml

@@ -19,10 +19,7 @@ jobs:
         - windows-latest
         python-version:
         - '3.10'
-        - '3.9'
-        - '3.8'
-        # Remove dependency `importlib_metadata` when dropping support for Python 3.7
-        - '3.7'
+        - '3.11'
 
       fail-fast: false
 
@@ -40,18 +37,19 @@ jobs:
     - name: Install dependencies and package
       run: pip install .[tests,optional_plotting,optional_io_formats,tutorials]
 
+    # run tests without Matplotlib & CodeCode tests on earlier Python versions
     - name: Test with pytest
-      if: ${{ matrix.python-version != '3.9' }}
+      if: ${{ matrix.python-version != '3.11' }}
       run: pytest tests
 
-    # only execute Matplotlib tests on latest Python version
+    # run tests with Matplotlib & CodeCov on latest Python version
     - name: Test with pytest including Matplotlib & Codecov
-      if: ${{ matrix.python-version == '3.9' }}
+      if: ${{ matrix.python-version == '3.11' }}
       run: pytest tests --mpl --cov=./ --cov-report=xml
 
     - name: Upload coverage report to Codecov
-      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.9' }}
-      uses: codecov/codecov-action@v1
+      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' }}
+      uses: codecov/codecov-action@v3
       with:
         file: ./coverage.xml
         env_vars: ${{ matrix.os }} py${{ matrix.python-version }}

.gitignore

@@ -76,9 +76,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-
 # PyBuilder
 target/
 

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Declare the Python requirements
+python:
+  install:
+  - method: pip
+    path: .
+    extra_requirements: [docs,tutorials,optional_plotting]

AUTHORS.rst

@@ -1,11 +1,10 @@
 Authors and Developers
 ======================
 
-The following persons contributed to the development of the |pyam| framework:
+The following persons contributed to the development of the |pyam| package:
 
 - Matthew Gidden `@gidden <https://github.com/gidden>`_
-- Daniel Huppmann `@danielhuppmann <https://github.com/danielhuppmann>`_,
-  `iiasa <https://www.iiasa.ac.at/staff/huppmann>`_
+- Daniel Huppmann `@danielhuppmann <https://github.com/danielhuppmann>`_
 - Zebedee Nicholls `@znicholls <https://github.com/znicholls>`_
 - Nikolay Kushin `@zikolach <https://github.com/zikolach>`_
 - Robin Lamboll `@Rlamboll <https://github.com/Rlamboll>`_
@@ -21,3 +20,9 @@ The following persons contributed to the development of the |pyam| framework:
 - Florian Maczek `@macflo8 <https://github.com/macflo8>`_
 - Laura Wienpahl `@LauWien <https://github.com/LauWien>`_
 - Philip Hackstock `@phackstock <https://github.com/phackstock>`_
+- Pietro Monticone `@pitmonticone <https://github.com/pitmonticone>`_
+
+| The core maintenance of the |pyam| package is done by
+  the *Scenario Services & Scientific Software* research theme
+  at the IIASA Energy, Climate, and Enviroment program.
+| Visit https://software.ece.iiasa.ac.at for more information.

CONTRIBUTING.rst

@@ -1,4 +1,3 @@
-
 Have a question? Get in touch!
 ------------------------------
 
@@ -11,7 +10,6 @@ Have a question? Get in touch!
 .. _`email`: mailto:[email protected]?subject=[pyam]%20Please%20add%20me%20to%20the%20Slack%20workspace
 .. _Slack: https://slack.com
 
-
 Interested in contributing? Join the team!
 ------------------------------------------
 

NOTICE.md

@@ -1,14 +1,13 @@
-   Copyright 2017-2022 IIASA and the pyam developer team
+Copyright 2017-2023 IIASA and the pyam developer team
 
-   The **pyam** package is licensed under
-   the Apache License, Version 2.0 (the "License");
-   you may not use the package except in compliance with the License.
-   You may obtain a copy of the License at
+The **pyam** package is licensed under the Apache License, Version 2.0 (the "License");
+you may not use the package except in compliance with the License.
+You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+    http://www.apache.org/licenses/LICENSE-2.0
 
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1,15 +1,15 @@
 pyam: analysis & visualization <br /> of integrated-assessment and macro-energy scenarios
 =========================================================================================
 
-[![license](https://img.shields.io/badge/License-Apache%202.0-black)](https://github.com/IAMconsortium/pyam/blob/main/LICENSE)
+[![license](https://img.shields.io/badge/license-Apache%202.0-black)](https://github.com/IAMconsortium/pyam/blob/main/LICENSE)
 [![pypi](https://img.shields.io/pypi/v/pyam-iamc.svg)](https://pypi.python.org/pypi/pyam-iamc/)
-[![conda](https://anaconda.org/conda-forge/pyam/badges/version.svg)](https://anaconda.org/conda-forge/pyam)
-[![latest](https://anaconda.org/conda-forge/pyam/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/pyam)
+[![conda](https://img.shields.io/conda/vn/conda-forge/pyam?logo=anaconda)](https://anaconda.org/conda-forge/pyam)
+[![last-release](https://img.shields.io/github/release-date/iamconsortium/pyam?logo=github&label=last%20release)](https://github.com/IAMconsortium/pyam/releases)
 
 <!-- replace python version by dynamic reference to pypi once Python versions are configured there -->
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![python](https://img.shields.io/badge/python-3.7_|_3.8_|_3.9_|_3.10-blue?logo=python&logoColor=white)](https://github.com/IAMconsortium/pyam)
-[![pytest](https://github.com/IAMconsortium/pyam/actions/workflows/pytest.yml/badge.svg)](https://github.com/IAMconsortium/pyam/actions/workflows/pytest.yml)
+[![python](https://img.shields.io/badge/python-≥3.10,<3.12-blue?logo=python&logoColor=white)](https://github.com/IAMconsortium/pyam)
+[![pytest](https://img.shields.io/github/actions/workflow/status/iamconsortium/pyam/pytest.yml?logo=GitHub&label=pytest)](https://github.com/IAMconsortium/pyam/actions/workflows/pytest.yml)
 [![ReadTheDocs](https://readthedocs.org/projects/pyam-iamc/badge/?version=latest)](https://pyam-iamc.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/IAMconsortium/pyam/branch/main/graph/badge.svg)](https://codecov.io/gh/IAMconsortium/pyam)
 
@@ -73,30 +73,34 @@ Tutorials
 ---------
 
 An introduction to the basic functions is shown
-in [the "first-steps" notebook](doc/source/tutorials/pyam_first_steps.ipynb).
+in [the "first-steps" notebook](docs/tutorials/pyam_first_steps.ipynb).
 
 All tutorials are available in rendered format (i.e., with output) as part of
 the [online documentation](https://pyam-iamc.readthedocs.io/en/stable/tutorials.html).
 The source code of the tutorials notebooks is available
-in the folder [doc/source/tutorials](doc/source/tutorials) of this repository.
+in the folder [docs/tutorials](docs/tutorials) of this repository.
 
 Documentation
 -------------
 
 The comprehensive documentation is hosted on [Read the Docs](https://pyam-iamc.readthedocs.io).
 
 The documentation pages can be built locally,
-refer to the instruction in [doc/README](doc/README.md).
+refer to the instruction in [docs/README](docs/README.md).
 
 Authors & Contributors
 ----------------------
 
 This package was initiated and is currently maintained
 by Matthew Gidden ([@gidden](https://github.com/gidden))
 and Daniel Huppmann ([@danielhuppmann](https://github.com/danielhuppmann/)).
-
 See the complete [list of contributors](AUTHORS.rst).
 
+The core maintenance of the package is done by 
+the *Scenario Services & Scientific Software* research theme
+at the IIASA Energy, Climate, and Enviroment program.
+Visit https://software.ece.iiasa.ac.at for more information.
+
 Scientific publications
 -----------------------
 
@@ -133,7 +137,7 @@ doi: [10.21105/joss.01095](https://doi.org/10.21105/joss.01095).
 License
 -------
 
-Copyright 2017-2022 IIASA and the pyam developer team
+Copyright 2017-2023 IIASA and the pyam developer team
 
 The **pyam** package is licensed
 under the Apache License, Version 2.0 (the "License");