Skip to content

Commit 8bb2a05

Browse files
committed
Spelling and minor changes
1 parent 1b3cb6b commit 8bb2a05

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ As the windpowerlib started with contributors from the `oemof developer group <h
8787

8888
**Generally the following steps are required when changing, adding or removing code:**
8989

90-
* Add new tests if you have written new functions/classes
91-
* Add/change the documentation (new feature, API changes ...)
92-
* Add a whatsnew entry and your name to Contributors
90+
* Add new tests if you have written new functions/classes.
91+
* Add/change the documentation (new feature, API changes ...).
92+
* Add a whatsnew entry and your name to Contributors.
9393
* Check if all tests still work by simply executing pytest in your windpowerlib directory:
9494

9595
.. role:: bash(code)

doc/basic_example_notebook.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"# Basic usage\n",
88
"\n",
99
"This example shows you the basic usage of the windpowerlib. \n",
10-
"There are mainly three steps. First you have to import your weather data, then you need to specify your wind turbine, and in the last step call the windpowerlib functions to calculate the feedin timeseries.\n",
10+
"There are mainly three steps. First you have to import your weather data, then you need to specify your wind turbine, and in the last step call the windpowerlib functions to calculate the feedin time series.\n",
1111
"\n",
1212
"Before you start you have to import the packages needed for these steps."
1313
]
@@ -59,7 +59,7 @@
5959
"source": [
6060
"### Import weather data\n",
6161
"\n",
62-
"In order to use the windpowerlib you need to at least provide wind speed data for the time frame you want to analyse.\n",
62+
"In order to use the windpowerlib you need to at least provide wind speed data for the time frame you want to analyze.\n",
6363
"The function below imports example weather data from the weather.csv file provided along with the windpowerlib. The data include wind speed at two different heights in m/s, air temperature in two different heights in K, surface roughness length in m and air pressure in Pa.\n",
6464
"\n",
6565
"To find out which weather data in which units need to be provided to use the ModelChain or other functions of the windpowerlib see the individual function documentation."
@@ -266,7 +266,7 @@
266266
"# initialize ModelChain with default parameters and use run_model\n",
267267
"# method to calculate power output\n",
268268
"mc_my_turbine = ModelChain(my_turbine).run_model(weather)\n",
269-
"# write power output timeseries to WindTurbine object\n",
269+
"# write power output time series to WindTurbine object\n",
270270
"my_turbine.power_output = mc_my_turbine.power_output"
271271
]
272272
},
@@ -307,7 +307,7 @@
307307
"# calculate power output\n",
308308
"mc_e126 = ModelChain(e126, **modelchain_data).run_model(\n",
309309
" weather)\n",
310-
"# write power output timeseries to WindTurbine object\n",
310+
"# write power output time series to WindTurbine object\n",
311311
"e126.power_output = mc_e126.power_output"
312312
]
313313
},

doc/example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:toctree: temp/
55

66
basic_example.get_weather_data
7-
basic_example.initialise_wind_turbines
7+
basic_example.initialize_wind_turbines
88
basic_example.calculate_power_output
99
basic_example.plot_or_print
1010
basic_example.run_basic_example

doc/example_2.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
.. autosummary::
44
:toctree: temp/
55

6-
further_example.initialise_wind_farms
7-
further_example.initialise_wind_turbine_cluster
6+
further_example.initialize_wind_farms
7+
further_example.initialize_wind_turbine_cluster
88
further_example.calculate_power_output
99
further_example.plot_or_print
1010
further_example.run_example

doc/getting_started.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ As the windpowerlib started with contributors from the `oemof developer group <h
8484

8585
**Generally the following steps are required when changing, adding or removing code:**
8686

87-
* Add new tests if you have written new functions/classes
88-
* Add/change the documentation (new feature, API changes ...)
89-
* Add a whatsnew entry and your name to Contributors
87+
* Add new tests if you have written new functions/classes.
88+
* Add/change the documentation (new feature, API changes ...).
89+
* Add a whatsnew entry and your name to Contributors.
9090
* Check if all tests still work by simply executing pytest in your windpowerlib directory:
9191

9292
.. role:: bash(code)

example/basic_example.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"# Basic usage\n",
88
"\n",
99
"This example shows you the basic usage of the windpowerlib. \n",
10-
"There are mainly three steps. First you have to import your weather data, then you need to specify your wind turbine, and in the last step call the windpowerlib functions to calculate the feedin timeseries.\n",
10+
"There are mainly three steps. First you have to import your weather data, then you need to specify your wind turbine, and in the last step call the windpowerlib functions to calculate the feedin time series.\n",
1111
"\n",
1212
"Before you start you have to import the packages needed for these steps."
1313
]
@@ -59,7 +59,7 @@
5959
"source": [
6060
"### Import weather data\n",
6161
"\n",
62-
"In order to use the windpowerlib you need to at least provide wind speed data for the time frame you want to analyse.\n",
62+
"In order to use the windpowerlib you need to at least provide wind speed data for the time frame you want to analyze.\n",
6363
"The function below imports example weather data from the weather.csv file provided along with the windpowerlib. The data include wind speed at two different heights in m/s, air temperature in two different heights in K, surface roughness length in m and air pressure in Pa.\n",
6464
"\n",
6565
"To find out which weather data in which units need to be provided to use the ModelChain or other functions of the windpowerlib see the individual function documentation."
@@ -266,7 +266,7 @@
266266
"# initialize ModelChain with default parameters and use run_model\n",
267267
"# method to calculate power output\n",
268268
"mc_my_turbine = ModelChain(my_turbine).run_model(weather)\n",
269-
"# write power output timeseries to WindTurbine object\n",
269+
"# write power output time series to WindTurbine object\n",
270270
"my_turbine.power_output = mc_my_turbine.power_output"
271271
]
272272
},
@@ -307,7 +307,7 @@
307307
"# calculate power output\n",
308308
"mc_e126 = ModelChain(e126, **modelchain_data).run_model(\n",
309309
" weather)\n",
310-
"# write power output timeseries to WindTurbine object\n",
310+
"# write power output time series to WindTurbine object\n",
311311
"e126.power_output = mc_e126.power_output"
312312
]
313313
},

example/basic_example.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def calculate_power_output(weather, my_turbine, e126):
150150
# initialize ModelChain with default parameters and use run_model method
151151
# to calculate power output
152152
mc_my_turbine = ModelChain(my_turbine).run_model(weather)
153-
# write power output timeseries to WindTurbine object
153+
# write power output time series to WindTurbine object
154154
my_turbine.power_output = mc_my_turbine.power_output
155155

156156
# power output calculation for e126

0 commit comments

Comments
 (0)