Skip to content

Commit

Permalink
Merge 9a7af35 into 063875b
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhuppmann committed May 6, 2020
2 parents 063875b + 9a7af35 commit cf91475
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
17 changes: 13 additions & 4 deletions doc/source/api/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ DataFrames and xlsx/csv files

A :class:`pandas.DataFrame` or a path to an :code:`xlsx` or :code:`csv`
with data in the required structure (i.e., index/columns) can be imported
directly by initializing an :class:`IamDataFrame` -
see this tutorial_ for more information.

.. _tutorial: ../tutorials/data_table_formats.html
directly by initializing an :class:`IamDataFrame` - see
`this tutorial <../tutorials/data_table_formats.html>`_ for more information.

Exporting to these formats is implemented via the following functions:

Expand All @@ -30,3 +28,14 @@ The |pyam| package supports reading and writing to the
.. autofunction:: read_datapackage

.. automethod:: IamDataFrame.to_datapackage

Connecting to an IIASA scenario explorer instance
-------------------------------------------------

IIASA's ixmp scenario explorer infrastructure includes a RestAPI
to query data directly from the database server.
The |pyam| package uses this interface to read resources
and initialize an :class:`IamDataFrame`.
See `this tutorial ../tutorials/iiasa_dbs.html>`_ for more information.

.. autofunction:: read_iiasa
2 changes: 0 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,8 @@
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.mathbase',
'sphinxcontrib.bibtex',
'sphinxcontrib.programoutput',
'cloud_sptheme.ext.table_styling',
Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Release v\ |version|.
.. |coveralls| image:: https://coveralls.io/repos/github/IAMconsortium/pyam/badge.svg?branch=master
:target: https://coveralls.io/github/IAMconsortium/pyam?branch=master

.. |joss| image:: http://joss.theoj.org/papers/356bc013105642ec4e94a3b951836cfe/status.svg
:target: http://joss.theoj.org/papers/356bc013105642ec4e94a3b951836cfe
.. |joss| image:: https://joss.theoj.org/papers/10.21105/joss.01095/status.svg
:target: https://joss.theoj.org/papers/10.21105/joss.01095

.. |doi| image:: https://zenodo.org/badge/113359260.svg
:target: https://zenodo.org/badge/latestdoi/113359260
Expand Down
1 change: 1 addition & 0 deletions doc/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ The source code of the tutorials is available in the folder
tutorials/aggregating_downscaling_consistency.ipynb
tutorials/ipcc_colors.ipynb
tutorials/iiasa_dbs.ipynb
tutorials/legends.ipynb
tutorials/aggregating_variables_and_plotting_with_negative_values.ipynb
tutorials/pyam_logo.ipynb
13 changes: 10 additions & 3 deletions doc/source/tutorials/legends.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Customizing Legends\n",
"# Customizing legends\n",
"\n",
"This is a short tutorial showing how different arguments to the `legend` keyword in the **pyam** plotting library affects where the legend is located.\n",
"\n",
Expand All @@ -17,8 +17,15 @@
"metadata": {},
"outputs": [],
"source": [
"import pyam\n",
"\n",
"import pyam"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"df = (\n",
" pyam.IamDataFrame(data='tutorial_data.csv')\n",
" .filter(variable='Emissions|CO2', region='World')\n",
Expand Down

0 comments on commit cf91475

Please sign in to comment.