diff --git a/README.md b/README.md index 1ff756ad7..e0f8539b6 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Data model ---------- An illustrative example of the timeseries format developed by the -[Integrated Assessment Modeling Consortium](http://www.globalchange.umd.edu/iamc/) (IAMC) +[Integrated Assessment Modeling Consortium](https://www.iamconsortium.org) (IAMC) is shown below. The row is taken from the [IAMC 1.5°C scenario explorer](https://data.ene.iiasa.ac.at/iamc-1.5c-explorer), showing a scenario from the [CD-LINKS](https://www.cd-links.org) project. diff --git a/doc/source/_static/iamc-logo.png b/doc/source/_static/iamc-logo.png new file mode 100644 index 000000000..68d19cb2c Binary files /dev/null and b/doc/source/_static/iamc-logo.png differ diff --git a/doc/source/_static/iamc_logo.jpg b/doc/source/_static/iamc_logo.jpg deleted file mode 100644 index 87ff43399..000000000 Binary files a/doc/source/_static/iamc_logo.jpg and /dev/null differ diff --git a/doc/source/data.rst b/doc/source/data.rst index f31bd0e23..27316eba9 100644 --- a/doc/source/data.rst +++ b/doc/source/data.rst @@ -4,8 +4,8 @@ Data Model The IAMC timeseries format for scenario data -------------------------------------------- -.. figure:: _static/iamc_logo.jpg - :width: 120px +.. figure:: _static/iamc-logo.png + :width: 150px :align: right `IAMC website`_ diff --git a/doc/source/tutorials/_static/IAMC_logo.jpg b/doc/source/tutorials/_static/IAMC_logo.jpg deleted file mode 100644 index a2341a3a8..000000000 Binary files a/doc/source/tutorials/_static/IAMC_logo.jpg and /dev/null differ diff --git a/doc/source/tutorials/_static/iamc-logo.png b/doc/source/tutorials/_static/iamc-logo.png new file mode 100644 index 000000000..68d19cb2c Binary files /dev/null and b/doc/source/tutorials/_static/iamc-logo.png differ diff --git a/doc/source/tutorials/data_table_formats.ipynb b/doc/source/tutorials/data_table_formats.ipynb index 0b525c317..0741365ce 100644 --- a/doc/source/tutorials/data_table_formats.ipynb +++ b/doc/source/tutorials/data_table_formats.ipynb @@ -9,7 +9,7 @@ "The default input/output (io) format of the **pyam** package is the *tabular, wide data format*,\n", "where the columns represent the time domain.\n", "This follows the standard established by the *Integrated Assessment Modeling Consortium*\n", - "([IAMC](http://www.globalchange.umd.edu/iamc/));\n", + "([IAMC](https://www.iamconsortium.org/));\n", "[read the docs](https://pyam-iamc.readthedocs.io/en/stable/data.html) for more information.\n", "\n", "Alas, to make using the package as easy as possible, iniatilizing an `IamDataFrame` will accept a variety of different table formats\n", diff --git a/doc/source/tutorials/pyam_first_steps.ipynb b/doc/source/tutorials/pyam_first_steps.ipynb index 52f47d430..be4dc2cbc 100644 --- a/doc/source/tutorials/pyam_first_steps.ipynb +++ b/doc/source/tutorials/pyam_first_steps.ipynb @@ -9,13 +9,13 @@ "## Scope and feature overview\n", "\n", "The **pyam** package provides a range of diagnostic tools and functions\n", - "for analyzing, visualizing and working with timeseries data following the format established by the *Integrated Assessment Modeling Consortium* ([IAMC](http://www.globalchange.umd.edu/iamc/)). The format has been used in several IPCC assessments and numerous model comparison exercises.\n", - "\n", - "\n", + "for analyzing, visualizing and working with timeseries data following the format established by the *Integrated Assessment Modeling Consortium* ([IAMC](https://www.iamconsortium.org)).\n", "\n", + "The format has been used in several IPCC assessments and numerous model comparison exercises.\n", "An illustrative example of this format template is shown below;\n", "[read the docs](https://pyam-iamc.readthedocs.io/en/stable/data.html) for more information.\n", "\n", + "\n", "\n", "| **Model** | **Scenario** | **Region** | **Variable** | **Unit** | **2005** | **2010** | **2015** |\n", "|-----------|--------------|------------|----------------|----------|----------|----------|----------|\n", diff --git a/pyam/iiasa.py b/pyam/iiasa.py index 6336cbfef..ed2611b72 100644 --- a/pyam/iiasa.py +++ b/pyam/iiasa.py @@ -353,13 +353,17 @@ def query(self, **kwargs): - region - variable - Example - ------- + Examples + -------- + + You can read from a :class:`pyam.iiasa.Connection` instance using + keyword arguments similar to filtering an :class:`IamDataFrame`: + + .. code-block:: python + + Connection.query(model='MESSAGE', scenario='SSP2*', + variable=['Emissions|CO2', 'Primary Energy']) - ``` - Connection.query(model='MESSAGE', scenario='SSP2*', - variable=['Emissions|CO2', 'Primary Energy']) - ``` """ headers = { 'Authorization': 'Bearer {}'.format(self._token),