Adapt notebook to new names of p_values and cp_values

Author: birgits

example/basic_example.ipynb

@@ -33,7 +33,8 @@
     "import os\n",
     "import pandas as pd\n",
     "\n",
-    "from windpowerlib import modelchain\n",
+    "from windpowerlib.modelchain import ModelChain\n",
+    "from windpowerlib.wind_turbine import WindTurbine\n",
     "from windpowerlib import wind_turbine as wt"
    ]
   },
@@ -65,7 +66,7 @@
     "In order to use the windpowerlib you need to at least provide wind speed data for the time frame you want to analyse.\n",
     "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",
     "\n",
-    "To find out which weather data in which units need to be provided in order to use the ModelChain or other functions of the windpowerlib see the individual function documentation."
+    "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."
    ]
   },
   {
@@ -98,13 +99,13 @@
     "    Returns\n",
     "    -------\n",
     "    weather_df : pandas.DataFrame\n",
-    "            DataFrame with time series for wind speed `wind_speed` in m/s,\n",
-    "            temperature `temperature` in K, roughness length `roughness_length`\n",
-    "            in m, and pressure `pressure` in Pa.\n",
-    "            The columns of the DataFrame are a MultiIndex where the first level\n",
-    "            contains the variable name (e.g. wind_speed) and the second level\n",
-    "            contains the height at which it applies (e.g. 10, if it was\n",
-    "            measured at a height of 10 m).\n",
+    "        DataFrame with time series for wind speed `wind_speed` in m/s,\n",
+    "        temperature `temperature` in K, roughness length `roughness_length`\n",
+    "        in m, and pressure `pressure` in Pa.\n",
+    "        The columns of the DataFrame are a MultiIndex where the first level\n",
+    "        contains the variable name (e.g. wind_speed) and the second level\n",
+    "        contains the height at which it applies (e.g. 10, if it was\n",
+    "        measured at a height of 10 m).\n",
     "\n",
     "    \"\"\"\n",
     "\n",
@@ -162,7 +163,7 @@
     "# get power coefficient curves\n",
     "# write names of wind turbines for which power coefficient curves are provided\n",
     "# to 'turbines' DataFrame\n",
-    "turbines = wt.get_turbine_types(filename='cp_curves.csv', print_out=False)\n",
+    "turbines = wt.get_turbine_types(filename='power_coefficient_curves.csv', print_out=False)\n",
     "# find all Enercons in 'turbines' DataFrame\n",
     "print(turbines[turbines[\"turbine_id\"].str.contains(\"ENERCON\")])"
    ]
@@ -180,13 +181,13 @@
     "    'nominal_power': 3e6,  # in W\n",
     "    'hub_height': 105,  # in m\n",
     "    'rotor_diameter': 90,  # in m\n",
-    "    'p_values': pd.Series(\n",
-    "        data=[p * 1000 for p in [\n",
-    "            0.0, 26.0, 180.0, 1500.0, 3000.0, 3000.0]],  # in W\n",
-    "        index=[0.0, 3.0, 5.0, 10.0, 15.0, 25.0])  # in m/s\n",
+    "    'power_curve': pd.DataFrame(\n",
+    "            data={'values': [p * 1000 for p in [\n",
+    "                      0.0, 26.0, 180.0, 1500.0, 3000.0, 3000.0]],  # in W\n",
+    "                  'wind_speed': [0.0, 3.0, 5.0, 10.0, 15.0, 25.0]})  # in m/s\n",
     "    }  \n",
     "# initialise WindTurbine object\n",
-    "my_turbine = wt.WindTurbine(**myTurbine)"
+    "my_turbine = WindTurbine(**myTurbine)"
    ]
   },
   {
@@ -198,15 +199,15 @@
    "outputs": [],
    "source": [
     "# specification of wind turbine where power curve is provided\n",
-    "# if you want to use the power coefficient curve add {'fetch_curve': 'cp'}\n",
-    "# to the dictionary\n",
+    "# if you want to use the power coefficient curve add\n",
+    "# {'fetch_curve': 'power_coefficient_curve'} to the dictionary\n",
     "enerconE126 = {\n",
     "    'turbine_name': 'ENERCON E 126 7500',  # turbine name as in register\n",
     "    'hub_height': 135,  # in m\n",
     "    'rotor_diameter': 127  # in m\n",
     "    }\n",
     "# initialise WindTurbine object\n",
-    "e126 = wt.WindTurbine(**enerconE126)"
+    "e126 = WindTurbine(**enerconE126)"
    ]
   },
   {
@@ -227,7 +228,7 @@
     "# power output calculation for my_turbine\n",
     "# initialise ModelChain with default parameters and use run_model\n",
     "# method to calculate power output\n",
-    "mc_my_turbine = modelchain.ModelChain(my_turbine).run_model(weather)\n",
+    "mc_my_turbine = ModelChain(my_turbine).run_model(weather)\n",
     "# write power output timeseries to WindTurbine object\n",
     "my_turbine.power_output = mc_my_turbine.power_output"
    ]
@@ -241,21 +242,22 @@
     "# power output calculation for e126\n",
     "# own specifications for ModelChain setup\n",
     "modelchain_data = {\n",
-    "    'obstacle_height': 0,                   # default: 0\n",
     "    'wind_speed_model': 'logarithmic',      # 'logarithmic' (default),\n",
     "                                            # 'hellman' or\n",
     "                                            # 'interpolation_extrapolation'\n",
-    "    'density_model': 'ideal_gas',           # 'barometric' (default) or 'ideal_gas'\n",
+    "    'density_model': 'ideal_gas',           # 'barometric' (default), 'ideal_gas'\n",
+    "                                            #  or 'interpolation_extrapolation'\n",
     "    'temperature_model': 'linear_gradient', # 'linear_gradient' (def.) or\n",
     "                                            # 'interpolation_extrapolation'\n",
     "    'power_output_model': 'power_curve',    # 'power_curve' (default) or\n",
     "                                            # 'power_coefficient_curve'\n",
     "    'density_correction': True,             # False (default) or True\n",
+    "    'obstacle_height': 0,                   # default: 0\n",
     "    'hellman_exp': None}                    # None (default) or None\n",
     "\n",
     "# initialise ModelChain with own specifications and use run_model method to\n",
     "# calculate power output\n",
-    "mc_e126 = modelchain.ModelChain(e126, **modelchain_data).run_model(\n",
+    "mc_e126 = ModelChain(e126, **modelchain_data).run_model(\n",
     "    weather)\n",
     "# write power output timeseries to WindTurbine object\n",
     "e126.power_output = mc_e126.power_output"
@@ -308,17 +310,23 @@
    "source": [
     "# plot power (coefficient) curves\n",
     "if plt:\n",
-    "    if e126.cp_values is not None:\n",
-    "        e126.cp_values.plot(style='*', title='Enercon E126')\n",
+    "    if e126.power_coefficient_curve is not None:\n",
+    "        e126.power_coefficient_curve.plot(\n",
+    "            x='wind_speed', y='values', style='*',\n",
+    "            title='Enercon E126 power coefficient curve')\n",
     "        plt.show()\n",
-    "    if e126.p_values is not None:\n",
-    "        e126.p_values.plot(style='*', title='Enercon E126')\n",
+    "    if e126.power_curve is not None:\n",
+    "        e126.power_curve.plot(x='wind_speed', y='values', style='*',\n",
+    "                              title='Enercon E126 power curve')\n",
     "        plt.show()\n",
-    "    if my_turbine.cp_values is not None:\n",
-    "        my_turbine.cp_values.plot(style='*', title='myTurbine')\n",
+    "    if my_turbine.power_coefficient_curve is not None:\n",
+    "        my_turbine.power_coefficient_curve.plot(\n",
+    "            x='wind_speed', y='values', style='*',\n",
+    "            title='myTurbine power coefficient curve')\n",
     "        plt.show()\n",
-    "    if my_turbine.p_values is not None:\n",
-    "        my_turbine.p_values.plot(style='*', title='myTurbine')\n",
+    "    if my_turbine.power_curve is not None:\n",
+    "        my_turbine.power_curve.plot(x='wind_speed', y='values', style='*',\n",
+    "                                    title='myTurbine power curve')\n",
     "        plt.show()"
    ]
   },