From e3ff4c982cbc7ddc60f597978c812eb3b75c623d Mon Sep 17 00:00:00 2001 From: Pietro Monticone <38562595+pitmonticone@users.noreply.github.com> Date: Sat, 25 Feb 2023 01:18:57 +0100 Subject: [PATCH 1/3] Fix a few typos --- doc/source/R_tutorials/pyam_R_tutorial.ipynb | 2 +- doc/source/tutorials/GAMS_to_pyam.ipynb | 6 +++--- .../tutorials/aggregating_downscaling_consistency.ipynb | 2 +- doc/source/tutorials/algebraic_operations.ipynb | 2 +- doc/source/tutorials/iiasa_dbs.ipynb | 2 +- doc/source/tutorials/ipcc_colors.ipynb | 2 +- doc/source/tutorials/legends.ipynb | 2 +- doc/source/tutorials/pyam_first_steps.ipynb | 8 ++++---- doc/source/tutorials/unit_conversion.ipynb | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/source/R_tutorials/pyam_R_tutorial.ipynb b/doc/source/R_tutorials/pyam_R_tutorial.ipynb index 5a7287574..68edf802a 100644 --- a/doc/source/R_tutorials/pyam_R_tutorial.ipynb +++ b/doc/source/R_tutorials/pyam_R_tutorial.ipynb @@ -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", diff --git a/doc/source/tutorials/GAMS_to_pyam.ipynb b/doc/source/tutorials/GAMS_to_pyam.ipynb index 944b9d151..a5ac04aa9 100644 --- a/doc/source/tutorials/GAMS_to_pyam.ipynb +++ b/doc/source/tutorials/GAMS_to_pyam.ipynb @@ -1,4 +1,4 @@ -{ +s{ "cells": [ { "cell_type": "markdown", @@ -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", @@ -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'." ] }, { diff --git a/doc/source/tutorials/aggregating_downscaling_consistency.ipynb b/doc/source/tutorials/aggregating_downscaling_consistency.ipynb index e560138a3..8ad7940f2 100644 --- a/doc/source/tutorials/aggregating_downscaling_consistency.ipynb +++ b/doc/source/tutorials/aggregating_downscaling_consistency.ipynb @@ -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**" ] }, diff --git a/doc/source/tutorials/algebraic_operations.ipynb b/doc/source/tutorials/algebraic_operations.ipynb index a44078d9b..5651aa07d 100644 --- a/doc/source/tutorials/algebraic_operations.ipynb +++ b/doc/source/tutorials/algebraic_operations.ipynb @@ -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", diff --git a/doc/source/tutorials/iiasa_dbs.ipynb b/doc/source/tutorials/iiasa_dbs.ipynb index b7fac98f1..a5c695c88 100644 --- a/doc/source/tutorials/iiasa_dbs.ipynb +++ b/doc/source/tutorials/iiasa_dbs.ipynb @@ -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", diff --git a/doc/source/tutorials/ipcc_colors.ipynb b/doc/source/tutorials/ipcc_colors.ipynb index af4eb1dd5..3576b3593 100644 --- a/doc/source/tutorials/ipcc_colors.ipynb +++ b/doc/source/tutorials/ipcc_colors.ipynb @@ -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." ] }, { diff --git a/doc/source/tutorials/legends.ipynb b/doc/source/tutorials/legends.ipynb index 3e9ebbcf5..84f701889 100644 --- a/doc/source/tutorials/legends.ipynb +++ b/doc/source/tutorials/legends.ipynb @@ -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." ] }, { diff --git a/doc/source/tutorials/pyam_first_steps.ipynb b/doc/source/tutorials/pyam_first_steps.ipynb index ef773b4d3..5b1e3d04f 100644 --- a/doc/source/tutorials/pyam_first_steps.ipynb +++ b/doc/source/tutorials/pyam_first_steps.ipynb @@ -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", "\n", "\n", @@ -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", @@ -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)." ] }, { @@ -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." ] }, { diff --git a/doc/source/tutorials/unit_conversion.ipynb b/doc/source/tutorials/unit_conversion.ipynb index f10401a33..9d5e38d28 100644 --- a/doc/source/tutorials/unit_conversion.ipynb +++ b/doc/source/tutorials/unit_conversion.ipynb @@ -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!" From f3e3f8a779aae2c39ff2e82bae8bfd484b73dac1 Mon Sep 17 00:00:00 2001 From: Pietro Monticone <38562595+pitmonticone@users.noreply.github.com> Date: Sat, 25 Feb 2023 01:25:49 +0100 Subject: [PATCH 2/3] Update AUTHORS.rst and RELEASE_NOTES.md --- AUTHORS.rst | 1 + RELEASE_NOTES.md | 1 + 2 files changed, 2 insertions(+) diff --git a/AUTHORS.rst b/AUTHORS.rst index a5ab0bbd7..c43f1dda7 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -21,3 +21,4 @@ The following persons contributed to the development of the |pyam| framework: - Florian Maczek `@macflo8 `_ - Laura Wienpahl `@LauWien `_ - Philip Hackstock `@phackstock `_ +- Pietro Monticone `@pitmonticone `_ diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 83331ddbb..7bcbb0753 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -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 From 0924e07f3396ec7115e851d7fe4e11834a297a9e Mon Sep 17 00:00:00 2001 From: Pietro Monticone <38562595+pitmonticone@users.noreply.github.com> Date: Mon, 27 Feb 2023 17:21:37 +0100 Subject: [PATCH 3/3] Update doc/source/tutorials/GAMS_to_pyam.ipynb Co-authored-by: Daniel Huppmann --- doc/source/tutorials/GAMS_to_pyam.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/tutorials/GAMS_to_pyam.ipynb b/doc/source/tutorials/GAMS_to_pyam.ipynb index a5ac04aa9..7e048c98c 100644 --- a/doc/source/tutorials/GAMS_to_pyam.ipynb +++ b/doc/source/tutorials/GAMS_to_pyam.ipynb @@ -1,4 +1,4 @@ -s{ +{ "cells": [ { "cell_type": "markdown",