Adapt notebook and comments/docstrings to commit 2cd4e78

Author: SabineHaas

doc/modelchain_example_notebook.ipynb

@@ -152,7 +152,7 @@
    "source": [
     "To initialize a specific turbine you need a dictionary that contains the basic parameters. A turbine is defined by its nominal power, hub height, rotor diameter, and power or power coefficient curve.\n",
     "\n",
-    "There are three ways to initialize a WindTurbine object in the windpowerlib. You can either specify your own turbine, as done below for 'myTurbine', or fetch power and/or power coefficient curve data from data files provided by the windpowerlib, as done for the 'enerconE126', or provide your turbine data in csv files as done for the 'example_turbine' with an example file.\n",
+    "There are three ways to initialize a WindTurbine object in the windpowerlib. You can either specify your own turbine, as done below for 'my_turbine', or fetch power and/or power coefficient curve data from data files provided by the windpowerlib, as done for the 'enercon_e126', or provide your turbine data in csv files as done for the 'dummy_turbine' with an example file.\n",
     "\n",
     "You can execute the following to get a table of all wind turbines for which power and/or power coefficient curves are provided."
    ]
@@ -230,7 +230,7 @@
    "source": [
     "# specification of own wind turbine (Note: power coefficient values and\n",
     "# nominal power have to be in Watt)\n",
-    "myTurbine = {\n",
+    "my_turbine = {\n",
     "    'name': 'myTurbine',\n",
     "    'nominal_power': 3e6,  # in W\n",
     "    'hub_height': 105,  # in m\n",
@@ -241,7 +241,7 @@
     "                  'wind_speed': [0.0, 3.0, 5.0, 10.0, 15.0, 25.0]})  # in m/s\n",
     "    }  \n",
     "# initialisze WindTurbine object\n",
-    "my_turbine = WindTurbine(**myTurbine)"
+    "my_turbine = WindTurbine(**my_turbine)"
    ]
   },
   {
@@ -265,15 +265,15 @@
     "# specification of wind turbine where power curve is provided\n",
     "# if you want to use the power coefficient curve change the value of\n",
     "# 'fetch_curve' to 'power_coefficient_curve'\n",
-    "enerconE126 = {\n",
+    "enercon_e126 = {\n",
     "        'name': 'E-126/4200',  # turbine type as in register #\n",
     "        'hub_height': 135,  # in m\n",
     "        'rotor_diameter': 127,  # in m\n",
     "        'fetch_curve': 'power_curve',  # fetch power curve #\n",
     "        'data_source': 'oedb'  # data source oedb or name of csv file\n",
     "    }\n",
     "# initialize WindTurbine object\n",
-    "e126 = WindTurbine(**enerconE126)"
+    "e126 = WindTurbine(**enercon_e126)"
    ]
   },
   {
@@ -284,15 +284,15 @@
    "source": [
     "# specification of wind turbine where power coefficient curve is provided\n",
     "# by a csv file\n",
-    "dummyTurbine = {\n",
+    "dummy_turbine = {\n",
     "    'name': 'DUMMY 1',  # turbine type as in file #\n",
     "    'hub_height': 100,  # in m\n",
     "    'rotor_diameter': 70,  # in m\n",
     "    'fetch_curve': 'power_coefficient_curve',  # fetch cp curve #\n",
     "    'data_source': 'example_power_coefficient_curves.csv'  # data source\n",
     "}\n",
     "# initialize WindTurbine object\n",
-    "dummy_turbine = WindTurbine(**dummyTurbine)"
+    "dummy_turbine = WindTurbine(**dummy_turbine)"
    ]
   },
   {

example/modelchain_example.ipynb

@@ -152,7 +152,7 @@
    "source": [
     "To initialize a specific turbine you need a dictionary that contains the basic parameters. A turbine is defined by its nominal power, hub height, rotor diameter, and power or power coefficient curve.\n",
     "\n",
-    "There are three ways to initialize a WindTurbine object in the windpowerlib. You can either specify your own turbine, as done below for 'myTurbine', or fetch power and/or power coefficient curve data from data files provided by the windpowerlib, as done for the 'enerconE126', or provide your turbine data in csv files as done for the 'example_turbine' with an example file.\n",
+    "There are three ways to initialize a WindTurbine object in the windpowerlib. You can either specify your own turbine, as done below for 'my_turbine', or fetch power and/or power coefficient curve data from data files provided by the windpowerlib, as done for the 'enercon_e126', or provide your turbine data in csv files as done for the 'dummy_turbine' with an example file.\n",
     "\n",
     "You can execute the following to get a table of all wind turbines for which power and/or power coefficient curves are provided."
    ]
@@ -230,7 +230,7 @@
    "source": [
     "# specification of own wind turbine (Note: power coefficient values and\n",
     "# nominal power have to be in Watt)\n",
-    "myTurbine = {\n",
+    "my_turbine = {\n",
     "    'name': 'myTurbine',\n",
     "    'nominal_power': 3e6,  # in W\n",
     "    'hub_height': 105,  # in m\n",
@@ -241,7 +241,7 @@
     "                  'wind_speed': [0.0, 3.0, 5.0, 10.0, 15.0, 25.0]})  # in m/s\n",
     "    }  \n",
     "# initialisze WindTurbine object\n",
-    "my_turbine = WindTurbine(**myTurbine)"
+    "my_turbine = WindTurbine(**my_turbine)"
    ]
   },
   {
@@ -265,15 +265,15 @@
     "# specification of wind turbine where power curve is provided\n",
     "# if you want to use the power coefficient curve change the value of\n",
     "# 'fetch_curve' to 'power_coefficient_curve'\n",
-    "enerconE126 = {\n",
+    "enercon_e126 = {\n",
     "        'name': 'E-126/4200',  # turbine type as in register #\n",
     "        'hub_height': 135,  # in m\n",
     "        'rotor_diameter': 127,  # in m\n",
     "        'fetch_curve': 'power_curve',  # fetch power curve #\n",
     "        'data_source': 'oedb'  # data source oedb or name of csv file\n",
     "    }\n",
     "# initialize WindTurbine object\n",
-    "e126 = WindTurbine(**enerconE126)"
+    "e126 = WindTurbine(**enercon_e126)"
    ]
   },
   {
@@ -284,15 +284,15 @@
    "source": [
     "# specification of wind turbine where power coefficient curve is provided\n",
     "# by a csv file\n",
-    "dummyTurbine = {\n",
+    "dummy_turbine = {\n",
     "    'name': 'DUMMY 1',  # turbine type as in file #\n",
     "    'hub_height': 100,  # in m\n",
     "    'rotor_diameter': 70,  # in m\n",
     "    'fetch_curve': 'power_coefficient_curve',  # fetch cp curve #\n",
     "    'data_source': 'example_power_coefficient_curves.csv'  # data source\n",
     "}\n",
     "# initialize WindTurbine object\n",
-    "dummy_turbine = WindTurbine(**dummyTurbine)"
+    "dummy_turbine = WindTurbine(**dummy_turbine)"
    ]
   },
   {

example/modelchain_example.py

@@ -85,17 +85,17 @@ def initialize_wind_turbines():
     Initializes two :class:`~.wind_turbine.WindTurbine` objects.
 
     Function shows three ways to initialize a WindTurbine object. You can
-    either specify your own turbine, as done below for 'myTurbine', or fetch
+    either specify your own turbine, as done below for 'my_turbine', or fetch
     power and/or power coefficient curve data from the Open Energy Database
-    (oedb), as done for the 'enerconE126', or provide your turbine data in csv
-    files as done for 'dummyTurbine' with an example file.
+    (oedb), as done for the 'enercon_e126', or provide your turbine data in csv
+    files as done for 'dummy_turbine' with an example file.
     Execute ``windpowerlib.wind_turbine.get_turbine_types()`` to get a table
     including all wind turbines for which power and/or power coefficient curves
     are provided.
 
     Returns
     -------
-    Tuple (WindTurbine, WindTurbine)
+    Tuple (WindTurbine, WindTurbine, WindTurbine)
 
     """