example/example_synthetic_rain.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "metadata": {
    "collapsed": true,
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.611913Z",
     "start_time": "2024-06-03T08:36:50.941055Z"
    }
   },
   "source": "from ehyd_tools.synthetic_rainseries import RainModeller",
   "outputs": [],
   "execution_count": 1
  },
  {
   "cell_type": "code",
   "source": [
    "model_rain = RainModeller()\n",
    "# bis jetzt implementiert: Blockregen, Eulerregen Typ 1 und 2\n",
    "model_rain"
   ],
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    },
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.616213Z",
     "start_time": "2024-06-03T08:36:51.613011Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<ehyd_tools.synthetic_rainseries.RainModeller at 0x107b8f550>"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "execution_count": 2
  },
  {
   "cell_type": "code",
   "source": [
    "# nur für ÖKOSTRA Auswertungen. (KOSTRA DWD wird aktuell nicht unterstützt)\n",
    "model_rain.set_idf_table_okostra(5214, kind='Bemessung')\n",
    "model_rain.idf_table\n",
    "# soll eine eigene IDF Tabelle verwendet werden, kann das Property \".idf_table\" mit dieser als pandas.DataFrame im unterhalb darstellten Format überschrieben werden.\n",
    "# model_rain.idf_table = custom_idf_table\n",
    "# Die Spaltennamen müssen als float oder integer definiert sein. Z.B.:\n",
    "# model_rain.idf_table.columns = model_rain.idf_table.columns.astype(int)"
   ],
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    },
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.775555Z",
     "start_time": "2024-06-03T08:36:51.616933Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "return period   1      2      3      5      10     20     25     30     50   \\\n",
       "duration                                                                      \n",
       "5               8.6   10.2   11.3   12.7   14.7   16.7   17.4   18.0   19.4   \n",
       "10             13.7   16.3   17.8   19.7   23.3   26.8   27.8   28.8   31.4   \n",
       "15             17.2   20.5   22.4   24.9   29.1   33.5   35.0   36.2   39.5   \n",
       "20             19.7   23.7   25.9   28.9   33.2   38.4   39.9   41.3   45.2   \n",
       "30             23.2   27.9   30.7   34.3   39.2   45.2   47.3   48.9   53.3   \n",
       "45             26.4   32.0   35.2   39.3   45.1   52.1   54.4   56.3   61.3   \n",
       "60             28.3   34.3   37.9   42.4   48.9   56.4   59.0   60.9   66.5   \n",
       "90             30.5   37.2   41.0   45.9   53.8   62.1   64.9   67.1   73.1   \n",
       "120            31.8   38.7   42.6   48.1   56.8   65.6   68.4   70.7   77.3   \n",
       "180            33.2   40.5   44.7   51.6   61.1   70.4   73.4   75.9   82.8   \n",
       "240            35.5   42.5   47.5   54.6   64.4   74.0   77.2   79.7   86.9   \n",
       "360            38.8   46.9   52.9   60.7   71.1   81.3   84.7   87.7   95.4   \n",
       "540            42.1   52.4   59.1   67.5   79.0   90.2   94.2   97.2  105.6   \n",
       "720            44.5   56.9   64.3   73.6   85.4   97.6  101.4  104.4  113.4   \n",
       "1080           50.7   65.4   74.0   84.3   96.8  109.4  113.1  116.4  125.6   \n",
       "1440           57.6   72.9   82.3   94.1  110.0  123.9  128.2  131.2  141.0   \n",
       "2880           67.4   86.4   97.5  111.5  130.7  149.5  155.6  160.8  172.3   \n",
       "4320           74.0   94.7  106.9  122.0  142.8  163.3  169.7  175.5  190.8   \n",
       "5760           80.0  101.1  113.7  130.0  151.6  173.6  180.4  186.4  202.0   \n",
       "7200           84.7  106.4  119.6  136.1  159.0  181.4  189.1  194.7  211.6   \n",
       "8640           89.6  110.8  124.4  141.8  164.9  188.6  195.9  201.9  219.2   \n",
       "\n",
       "return period    75     100  \n",
       "duration                     \n",
       "5               20.6   21.4  \n",
       "10              33.5   35.0  \n",
       "15              42.2   44.1  \n",
       "20              48.1   50.3  \n",
       "30              56.9   59.4  \n",
       "45              65.4   68.4  \n",
       "60              70.9   74.1  \n",
       "90              78.1   81.5  \n",
       "120             82.5   86.1  \n",
       "180             88.4   92.2  \n",
       "240             92.3   96.6  \n",
       "360            101.3  105.4  \n",
       "540            112.2  116.9  \n",
       "720            120.1  125.4  \n",
       "1080           132.7  137.9  \n",
       "1440           148.8  153.8  \n",
       "2880           182.2  188.4  \n",
       "4320           202.9  209.5  \n",
       "5760           215.3  224.0  \n",
       "7200           224.8  233.8  \n",
       "8640           232.9  242.9  "
      ],
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th>return period</th>\n",
       "      <th>1</th>\n",
       "      <th>2</th>\n",
       "      <th>3</th>\n",
       "      <th>5</th>\n",
       "      <th>10</th>\n",
       "      <th>20</th>\n",
       "      <th>25</th>\n",
       "      <th>30</th>\n",
       "      <th>50</th>\n",
       "      <th>75</th>\n",
       "      <th>100</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>duration</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>8.6</td>\n",
       "      <td>10.2</td>\n",
       "      <td>11.3</td>\n",
       "      <td>12.7</td>\n",
       "      <td>14.7</td>\n",
       "      <td>16.7</td>\n",
       "      <td>17.4</td>\n",
       "      <td>18.0</td>\n",
       "      <td>19.4</td>\n",
       "      <td>20.6</td>\n",
       "      <td>21.4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>10</th>\n",
       "      <td>13.7</td>\n",
       "      <td>16.3</td>\n",
       "      <td>17.8</td>\n",
       "      <td>19.7</td>\n",
       "      <td>23.3</td>\n",
       "      <td>26.8</td>\n",
       "      <td>27.8</td>\n",
       "      <td>28.8</td>\n",
       "      <td>31.4</td>\n",
       "      <td>33.5</td>\n",
       "      <td>35.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>15</th>\n",
       "      <td>17.2</td>\n",
       "      <td>20.5</td>\n",
       "      <td>22.4</td>\n",
       "      <td>24.9</td>\n",
       "      <td>29.1</td>\n",
       "      <td>33.5</td>\n",
       "      <td>35.0</td>\n",
       "      <td>36.2</td>\n",
       "      <td>39.5</td>\n",
       "      <td>42.2</td>\n",
       "      <td>44.1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>20</th>\n",
       "      <td>19.7</td>\n",
       "      <td>23.7</td>\n",
       "      <td>25.9</td>\n",
       "      <td>28.9</td>\n",
       "      <td>33.2</td>\n",
       "      <td>38.4</td>\n",
       "      <td>39.9</td>\n",
       "      <td>41.3</td>\n",
       "      <td>45.2</td>\n",
       "      <td>48.1</td>\n",
       "      <td>50.3</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>30</th>\n",
       "      <td>23.2</td>\n",
       "      <td>27.9</td>\n",
       "      <td>30.7</td>\n",
       "      <td>34.3</td>\n",
       "      <td>39.2</td>\n",
       "      <td>45.2</td>\n",
       "      <td>47.3</td>\n",
       "      <td>48.9</td>\n",
       "      <td>53.3</td>\n",
       "      <td>56.9</td>\n",
       "      <td>59.4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>45</th>\n",
       "      <td>26.4</td>\n",
       "      <td>32.0</td>\n",
       "      <td>35.2</td>\n",
       "      <td>39.3</td>\n",
       "      <td>45.1</td>\n",
       "      <td>52.1</td>\n",
       "      <td>54.4</td>\n",
       "      <td>56.3</td>\n",
       "      <td>61.3</td>\n",
       "      <td>65.4</td>\n",
       "      <td>68.4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>60</th>\n",
       "      <td>28.3</td>\n",
       "      <td>34.3</td>\n",
       "      <td>37.9</td>\n",
       "      <td>42.4</td>\n",
       "      <td>48.9</td>\n",
       "      <td>56.4</td>\n",
       "      <td>59.0</td>\n",
       "      <td>60.9</td>\n",
       "      <td>66.5</td>\n",
       "      <td>70.9</td>\n",
       "      <td>74.1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>90</th>\n",
       "      <td>30.5</td>\n",
       "      <td>37.2</td>\n",
       "      <td>41.0</td>\n",
       "      <td>45.9</td>\n",
       "      <td>53.8</td>\n",
       "      <td>62.1</td>\n",
       "      <td>64.9</td>\n",
       "      <td>67.1</td>\n",
       "      <td>73.1</td>\n",
       "      <td>78.1</td>\n",
       "      <td>81.5</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>120</th>\n",
       "      <td>31.8</td>\n",
       "      <td>38.7</td>\n",
       "      <td>42.6</td>\n",
       "      <td>48.1</td>\n",
       "      <td>56.8</td>\n",
       "      <td>65.6</td>\n",
       "      <td>68.4</td>\n",
       "      <td>70.7</td>\n",
       "      <td>77.3</td>\n",
       "      <td>82.5</td>\n",
       "      <td>86.1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>180</th>\n",
       "      <td>33.2</td>\n",
       "      <td>40.5</td>\n",
       "      <td>44.7</td>\n",
       "      <td>51.6</td>\n",
       "      <td>61.1</td>\n",
       "      <td>70.4</td>\n",
       "      <td>73.4</td>\n",
       "      <td>75.9</td>\n",
       "      <td>82.8</td>\n",
       "      <td>88.4</td>\n",
       "      <td>92.2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>240</th>\n",
       "      <td>35.5</td>\n",
       "      <td>42.5</td>\n",
       "      <td>47.5</td>\n",
       "      <td>54.6</td>\n",
       "      <td>64.4</td>\n",
       "      <td>74.0</td>\n",
       "      <td>77.2</td>\n",
       "      <td>79.7</td>\n",
       "      <td>86.9</td>\n",
       "      <td>92.3</td>\n",
       "      <td>96.6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>360</th>\n",
       "      <td>38.8</td>\n",
       "      <td>46.9</td>\n",
       "      <td>52.9</td>\n",
       "      <td>60.7</td>\n",
       "      <td>71.1</td>\n",
       "      <td>81.3</td>\n",
       "      <td>84.7</td>\n",
       "      <td>87.7</td>\n",
       "      <td>95.4</td>\n",
       "      <td>101.3</td>\n",
       "      <td>105.4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>540</th>\n",
       "      <td>42.1</td>\n",
       "      <td>52.4</td>\n",
       "      <td>59.1</td>\n",
       "      <td>67.5</td>\n",
       "      <td>79.0</td>\n",
       "      <td>90.2</td>\n",
       "      <td>94.2</td>\n",
       "      <td>97.2</td>\n",
       "      <td>105.6</td>\n",
       "      <td>112.2</td>\n",
       "      <td>116.9</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>720</th>\n",
       "      <td>44.5</td>\n",
       "      <td>56.9</td>\n",
       "      <td>64.3</td>\n",
       "      <td>73.6</td>\n",
       "      <td>85.4</td>\n",
       "      <td>97.6</td>\n",
       "      <td>101.4</td>\n",
       "      <td>104.4</td>\n",
       "      <td>113.4</td>\n",
       "      <td>120.1</td>\n",
       "      <td>125.4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1080</th>\n",
       "      <td>50.7</td>\n",
       "      <td>65.4</td>\n",
       "      <td>74.0</td>\n",
       "      <td>84.3</td>\n",
       "      <td>96.8</td>\n",
       "      <td>109.4</td>\n",
       "      <td>113.1</td>\n",
       "      <td>116.4</td>\n",
       "      <td>125.6</td>\n",
       "      <td>132.7</td>\n",
       "      <td>137.9</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1440</th>\n",
       "      <td>57.6</td>\n",
       "      <td>72.9</td>\n",
       "      <td>82.3</td>\n",
       "      <td>94.1</td>\n",
       "      <td>110.0</td>\n",
       "      <td>123.9</td>\n",
       "      <td>128.2</td>\n",
       "      <td>131.2</td>\n",
       "      <td>141.0</td>\n",
       "      <td>148.8</td>\n",
       "      <td>153.8</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2880</th>\n",
       "      <td>67.4</td>\n",
       "      <td>86.4</td>\n",
       "      <td>97.5</td>\n",
       "      <td>111.5</td>\n",
       "      <td>130.7</td>\n",
       "      <td>149.5</td>\n",
       "      <td>155.6</td>\n",
       "      <td>160.8</td>\n",
       "      <td>172.3</td>\n",
       "      <td>182.2</td>\n",
       "      <td>188.4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4320</th>\n",
       "      <td>74.0</td>\n",
       "      <td>94.7</td>\n",
       "      <td>106.9</td>\n",
       "      <td>122.0</td>\n",
       "      <td>142.8</td>\n",
       "      <td>163.3</td>\n",
       "      <td>169.7</td>\n",
       "      <td>175.5</td>\n",
       "      <td>190.8</td>\n",
       "      <td>202.9</td>\n",
       "      <td>209.5</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5760</th>\n",
       "      <td>80.0</td>\n",
       "      <td>101.1</td>\n",
       "      <td>113.7</td>\n",
       "      <td>130.0</td>\n",
       "      <td>151.6</td>\n",
       "      <td>173.6</td>\n",
       "      <td>180.4</td>\n",
       "      <td>186.4</td>\n",
       "      <td>202.0</td>\n",
       "      <td>215.3</td>\n",
       "      <td>224.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7200</th>\n",
       "      <td>84.7</td>\n",
       "      <td>106.4</td>\n",
       "      <td>119.6</td>\n",
       "      <td>136.1</td>\n",
       "      <td>159.0</td>\n",
       "      <td>181.4</td>\n",
       "      <td>189.1</td>\n",
       "      <td>194.7</td>\n",
       "      <td>211.6</td>\n",
       "      <td>224.8</td>\n",
       "      <td>233.8</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8640</th>\n",
       "      <td>89.6</td>\n",
       "      <td>110.8</td>\n",
       "      <td>124.4</td>\n",
       "      <td>141.8</td>\n",
       "      <td>164.9</td>\n",
       "      <td>188.6</td>\n",
       "      <td>195.9</td>\n",
       "      <td>201.9</td>\n",
       "      <td>219.2</td>\n",
       "      <td>232.9</td>\n",
       "      <td>242.9</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "execution_count": 3
  },
  {
   "cell_type": "code",
   "source": [
    "# zum Erstellen einer einfachen Serie mit dem Index als vergangene Zeit in minuten\n",
    "model_rain.block.get_time_series(return_period=2, duration=60, interval=5)"
   ],
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    },
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.780137Z",
     "start_time": "2024-06-03T08:36:51.776443Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "0     0.000000\n",
       "5     2.858333\n",
       "10    2.858333\n",
       "15    2.858333\n",
       "20    2.858333\n",
       "25    2.858333\n",
       "30    2.858333\n",
       "35    2.858333\n",
       "40    2.858333\n",
       "45    2.858333\n",
       "50    2.858333\n",
       "55    2.858333\n",
       "60    2.858333\n",
       "dtype: float64"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "execution_count": 4
  },
  {
   "cell_type": "code",
   "source": [
    "# oder als Zeitserie mit speizifischem Startzeitpunkt\n",
    "model_rain.block.get_time_series(return_period=2, duration=60, interval=5, start_time='2021-05-27 16:00')"
   ],
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    },
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.787480Z",
     "start_time": "2024-06-03T08:36:51.781785Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "2021-05-27 16:00:00    0.000000\n",
       "2021-05-27 16:05:00    2.858333\n",
       "2021-05-27 16:10:00    2.858333\n",
       "2021-05-27 16:15:00    2.858333\n",
       "2021-05-27 16:20:00    2.858333\n",
       "2021-05-27 16:25:00    2.858333\n",
       "2021-05-27 16:30:00    2.858333\n",
       "2021-05-27 16:35:00    2.858333\n",
       "2021-05-27 16:40:00    2.858333\n",
       "2021-05-27 16:45:00    2.858333\n",
       "2021-05-27 16:50:00    2.858333\n",
       "2021-05-27 16:55:00    2.858333\n",
       "2021-05-27 17:00:00    2.858333\n",
       "Freq: 5min, dtype: float64"
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "execution_count": 5
  },
  {
   "cell_type": "code",
   "source": [
    "custom_idf_table = model_rain.idf_table"
   ],
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    },
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.789901Z",
     "start_time": "2024-06-03T08:36:51.788115Z"
    }
   },
   "outputs": [],
   "execution_count": 6
  },
  {
   "cell_type": "code",
   "source": [
    "# auch als Euler-Typ-2 Modellregen\n",
    "model_rain2 = RainModeller()\n",
    "model_rain2.idf_table = custom_idf_table\n",
    "model_rain2.euler.get_time_series(return_period=2, duration=60, interval=5, kind=2, start_time='2021-05-27 16:00')"
   ],
   "metadata": {
    "collapsed": false,
    "pycharm": {
     "name": "#%%\n"
    },
    "ExecuteTime": {
     "end_time": "2024-06-03T08:36:51.796229Z",
     "start_time": "2024-06-03T08:36:51.790714Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "2021-05-27 16:00:00     0.000000\n",
       "2021-05-27 16:05:00     3.200000\n",
       "2021-05-27 16:10:00     4.200000\n",
       "2021-05-27 16:15:00     6.100000\n",
       "2021-05-27 16:20:00    10.200000\n",
       "2021-05-27 16:25:00     2.100000\n",
       "2021-05-27 16:30:00     2.100000\n",
       "2021-05-27 16:35:00     1.366667\n",
       "2021-05-27 16:40:00     1.366667\n",
       "2021-05-27 16:45:00     1.366667\n",
       "2021-05-27 16:50:00     0.766667\n",
       "2021-05-27 16:55:00     0.766667\n",
       "2021-05-27 17:00:00     0.766667\n",
       "Freq: 5min, dtype: float64"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "execution_count": 7
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}