Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a few typos in tutorials #732

Merged
merged 3 commits into from
Feb 27, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ 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>`_
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- [#727](https://github.com/IAMconsortium/pyam/pull/730) Refactor initialization code
- [#729](https://github.com/IAMconsortium/pyam/pull/729) Improve performance at initialization
- [#723](https://github.com/IAMconsortium/pyam/pull/723) Ensure correct order of `time` attribute
- [#732](https://github.com/IAMconsortium/pyam/pull/732) Fix a few typos in tutorials

# Release v1.7.0

Expand Down
2 changes: 1 addition & 1 deletion doc/source/R_tutorials/pyam_R_tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"This tutorial is an illustration on how to get started,\n",
"not a full-fledged documentation of a **pyam-R** interface... \n",
"The integration between Python and R using **reticulate** is a bit fickle -\n",
"having multiple Python installations/enviroments\n",
"having multiple Python installations/environments\n",
"or outdated versions of **reticulate**/**pandas** can cause issues. \n",
"Please [read the docs](https://rstudio.github.io/reticulate/) if you experience any problems!\n",
"\n",
Expand Down
6 changes: 3 additions & 3 deletions doc/source/tutorials/GAMS_to_pyam.ipynb
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
s{
pitmonticone marked this conversation as resolved.
Show resolved Hide resolved
"cells": [
{
"cell_type": "markdown",
Expand All @@ -20,7 +20,7 @@
"1. Manually install the GAMS API,\n",
" follow one of the options in [this description](https://www.gams.com/latest/docs/API_PY_TUTORIAL.html).\n",
" \n",
" > **TL;DR**: seach for the folder \"api_38\" in the GAMS installation folder on your machine\n",
" > **TL;DR**: search for the folder \"api_38\" in the GAMS installation folder on your machine\n",
" > and run\n",
" > ```\n",
" > python setup.py install\n",
Expand Down Expand Up @@ -468,7 +468,7 @@
"and we use the demand center as the region.\n",
"\n",
"This is implemented by adding a column 'type' to the shipment-dataframe\n",
"and appending a new object to the results **IamDataFrame** concatening the 'type' column and the orgin column 'i'."
"and appending a new object to the results **IamDataFrame** concatening the 'type' column and the origin column 'i'."
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@
"The following cells show:\n",
"\n",
"0. The carbon price data across the regions\n",
"1. A (failing) validation that the regional aggretion (without weights) matches the reported prices at the `World` level\n",
"1. A (failing) validation that the regional aggregation (without weights) matches the reported prices at the `World` level\n",
"2. The emissions-weighted average of carbon prices returned as a new **IamDataFrame**"
]
},
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/algebraic_operations.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@
"source": [
"## 5. Working on other dimensions of timeseries data\n",
"\n",
"By default, algebraic operations in **pyam** will work on the *variable* dimenion.\n",
"By default, algebraic operations in **pyam** will work on the *variable* dimension.\n",
"But you can pass an ``axis`` keyword argument to, for example, perform computations\n",
"between scenarios or regions.\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/iiasa_dbs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
"source": [
"In this example, we will be retrieving data from the *IAMC 1.5°C Scenario Explorer hosted by IIASA*\n",
"([link](https://data.ene.iiasa.ac.at/iamc-1.5c-explorer)),\n",
"which provides the quantiative scenario ensemble underpinning\n",
"which provides the quantitative scenario ensemble underpinning\n",
"the *IPCC Special Report on Global Warming of 1.5C* (SR15).\n",
"\n",
"This can be done either via the constructor:\n",
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/ipcc_colors.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The full list of the IPCC color palette colors avaialable in **pyam** can be retrieved by the following code."
"The full list of the IPCC color palette colors available in **pyam** can be retrieved by the following code."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/legends.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"metadata": {},
"source": [
"By using the `color` argument, we tell the **pyam** plotting library to apply colours by model family.\n",
"This reduces the number of legend entries (from 38 model-scenario combinations to 8 model families), and the legend will be shown by default with **matplotib** standard settings."
"This reduces the number of legend entries (from 38 model-scenario combinations to 8 model families), and the legend will be shown by default with **matplotlib** standard settings."
]
},
{
Expand Down
8 changes: 4 additions & 4 deletions doc/source/tutorials/pyam_first_steps.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"compiled for the IPCC's *Special Report on Global Warming of 1.5°C* ([SR15](http://ipcc.ch/sr15/)).\n",
"The complete scenario ensemble data is publicly available from the [IAMC 1.5°C Scenario Explorer and Data hosted by IIASA](https://data.ene.iiasa.ac.at/iamc-1.5c-explorer). \n",
"\n",
"Please read the [License](https://data.ene.iiasa.ac.at/iamc-1.5c-explorer/#/license) page of the IAMC 1.5°C Scenario Explorer before using the full scenario data for scientific analyis or other work.\n",
"Please read the [License](https://data.ene.iiasa.ac.at/iamc-1.5c-explorer/#/license) page of the IAMC 1.5°C Scenario Explorer before using the full scenario data for scientific analysis or other work.\n",
"\n",
"<img style=\"float: right; margin: 10px;\" src=\"_static/cdlinks_logo.png\">\n",
"\n",
Expand Down Expand Up @@ -265,7 +265,7 @@
"> Filtering for ``Primary Energy|*`` will return all sub-categories of \n",
"> primary energy (and only the sub-categories)\n",
"\n",
"In additon, variables can be filtered by their **level**,\n",
"In addition, variables can be filtered by their **level**,\n",
"i.e., the \"depth\" of the variable in a hierarchical reading of the string separated by `|` (*pipe*, not L or i).\n",
"That is, the variable ``Primary Energy`` has level 0, while ``Primary Energy|Fossil`` has level 1.\n",
"\n",
Expand Down Expand Up @@ -578,7 +578,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The next two cells perform validation to exclude all scenarios that have unplausibly low emissions in 2020 (i.e., unrealistic near-term behaviour) as well as those that do not reduce emissions over the century (i.e., exceed a value of 45000 MT CO2 in any year)."
"The next two cells perform validation to exclude all scenarios that have implausibly low emissions in 2020 (i.e., unrealistic near-term behaviour) as well as those that do not reduce emissions over the century (i.e., exceed a value of 45000 MT CO2 in any year)."
]
},
{
Expand Down Expand Up @@ -761,7 +761,7 @@
"source": [
"### Apply categories to timeseries analysis\n",
"\n",
"Now, we again display the median global temperature increase for all scenarios, but we use the colouring by category to illustrate the common charateristics across scenarios."
"Now, we again display the median global temperature increase for all scenarios, but we use the colouring by category to illustrate the common characteristics across scenarios."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/unit_conversion.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
"and their abbreviations (`P`, `G`, `M`, `m`, ...)\n",
"as well as common units (centimeter, inch, kilometer, mile).\n",
"It also handles combined units like exajoule per year with various spellings:\n",
"`PWh/yr`, `PWh / yr` and `petawatthour / year` will all be treated as synomyms by the conversion.\n",
"`PWh/yr`, `PWh / yr` and `petawatthour / year` will all be treated as synonyms by the conversion.\n",
"The only difference is the format in the resulting **IamDataFrame**.\n",
"\n",
"[Read the docs](https://pint.readthedocs.io) for more information!"
Expand Down