Skip to content

Commit

Permalink
Add basic documentation of software packages (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhuppmann authored Feb 12, 2024
1 parent f5f7050 commit 9f49795
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 14 deletions.
13 changes: 3 additions & 10 deletions iamc.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _iamc-format:

The IAMC timeseries data format
===============================

Expand Down Expand Up @@ -68,13 +70,4 @@ Variable & region naming guidance
Related software packages
-------------------------

The *Scenario Services & Scientific Software team* at the IIASA Energy, Climate, and
Environment program (ECE) is developing several open-source Python packages
to work with the IAMC timeseries data format.

- **pyam**: Analysis and visualization of integrated-assessment & macro-energy scenarios
|br| https://pyam-iamc.readthedocs.io
- **nomenclature**: Management of IAMC-format project definitions |br|
https://nomenclature-iamc.readthedocs.io

Visit https://software.ece.iiasa.ac.at for more information.
Read more about related :ref:`software`.
9 changes: 5 additions & 4 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ tabular timeseries format to exchange scenario data related to energy systems mo
land-use change, demand sectors, and economic indicators in the context of
climate change mitigation pathways and the the Sustainable Development Goals (SDGs).

Read more about the `IAMC timeseries scenario format <iamc.html>`_...
Read more about the :ref:`iamc-format`...

.. _`IAMC`: http://iamconsortium.org/

Open-source software packages
-----------------------------
Scenario databases hosted by IIASA
----------------------------------


Coming soon...

Table of Contents
-----------------
Expand All @@ -38,6 +38,7 @@ Table of Contents
:maxdepth: 2

iamc
software

License & Source
----------------
Expand Down
30 changes: 30 additions & 0 deletions software.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _software:

Open-source software packages
=============================

The *Scenario Services & Scientific Software team* at the IIASA Energy, Climate, and
Environment program (ECE) is developing several open-source Python packages
to work with the IAMC timeseries data format.

Scenario analysis: **pyam**
---------------------------

Analysis and visualization of integrated-assessment & macro-energy scenarios

https://pyam-iamc.readthedocs.io

Scenario processing: **nomenclature**
-------------------------------------

Management of IAMC-format project definitions

https://nomenclature-iamc.readthedocs.io

Data warehouse: **ixmp4**
-------------------------

Data warehouse for high-powered scenario analysis in the domain of
integrated assessment of climate change and energy systems modeling

https://docs.ece.iiasa.ac.at/projects/ixmp4

0 comments on commit 9f49795

Please sign in to comment.