© [Institute of Urban Water Management and Landscape Water Engineering](https://www.sww.tugraz.at), [Graz University of Technology](https://www.tugraz.at/home/) and [Markus Pichler](mailto:markus.pichler@tugraz.at)
# Intensity duration frequency analysis (based on KOSTRA)
[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/LICENSE)
[](https://pypi.python.org/pypi/idf-analysis)
[](https://zenodo.org/doi/10.5281/zenodo.10559991)
[](https://www.buymeacoffee.com/MarkusP)
[](https://doi.org/10.21105/joss.07607)
[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CONTRIBUTING.md)
[](https://markuspic.github.io/intensity_duration_frequency_analysis/)
[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CODE_OF_CONDUCT.md)
[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/actions/workflows/tests.yaml)
[](https://codecov.io/gh/MarkusPic/intensity_duration_frequency_analysis)
[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/actions/workflows/sphinx_docs_to_gh_pages.yaml)
[](https://pypi.python.org/pypi/idf-analysis)
[](https://pypi.python.org/pypi/idf-analysis)
[](https://pypi.python.org/pypi/idf-analysis)
Heavy rainfall intensity as a function of duration and return period acc. to [DWA-A 531 (2012)](https://shop.dwa.de/DWA-A-531-Starkregen-in-Abhaengigkeit-von-Wiederkehrzeit-und-Dauer-September-2012-Stand-korrigierte-Fassung-Mai-2017/A-531-Hauptprodukt-12-main).
This program reads the measurement data of the rainfall
and calculates the distribution of the design rainfall as a function of the return period and the duration
for duration steps up to 12 hours (and more) and return period in a range of '0.5a ≤ T_n ≤ 100a'.
The guideline was used in the application [KOSTRA-DWD](https://www.dwd.de/DE/leistungen/kostra_dwd_rasterwerte/kostra_dwd_rasterwerte.html).
Since version v0.4 the new guidelines of [DWA-A 531 (2025)](https://shop.dwa.de/DWA-A-531-Starkregen-in-Abhaengigkeit-von-Wiederkehrzeit-und-Dauer-Juni-2025/A-531-Hauptprodukt-25-main) are also implemented.
----
> Heavy rainfall data are among the most important planning parameters in water management and hydraulic engineering practice. In urban areas, for example, they are required as initial parameters for the design of rainwater drainage systems and in watercourses for the dimensioning of hydraulic structures. The accuracy of the target values of the corresponding calculation methods and models depends crucially on their accuracy. Their overestimation can lead to considerable additional costs in the structural implementation, their underestimation to an unacceptable, excessive residual risk of failure during the operation of water management and hydraulic engineering facilities. Despite the area-wide availability of heavy rainfall data through "Coordinated Heavy Rainfall Regionalisation Analyses" (KOSTRA), there is still a need for local station analyses, e.g. to evaluate the now extended data series, to evaluate recent developments or to classify local peculiarities in comparison to the KOSTRA data. However, this is only possible without restrictions if the methodological approach recommended in the worksheet is followed.
**[DWA-A 531 (2012)](http://www.dwa.de/dwa/shop/shop.nsf/Produktanzeige?openform&produktid=P-DWAA-8XMUY2) Translated with www.DeepL.com/Translator**
----
> An intensity-duration-frequency (IDF) curve is a mathematical function that relates the rainfall intensity with its duration and frequency of occurrence. These curves are commonly used in hydrology for flood forecasting and civil engineering for urban drainage design. However, the IDF curves are also analysed in hydrometeorology because of the interest in the time concentration or time-structure of the rainfall.
**[Wikipedia](https://en.wikipedia.org/wiki/Intensity-duration-frequency_curve)**
----
This package was developed by [Markus Pichler](mailto:markus.pichler@tugraz.at) during his bachelor thesis and finalised it in the course of his employment at the [Institute of Urban Water Management and Landscape Water Engineering](https://www.sww.tugraz.at).
## Documentation
Read the docs [here 📖](https://markuspic.github.io/intensity_duration_frequency_analysis).
## Please cite as
Pichler, M. (2025). idf-analysis: Heavy rainfall intensity as a function of duration and return period. Journal of Open Source Software, 10(106), 7607. https://doi.org/10.21105/joss.07607
## Installation
This package is written in Python3. (use a version > 3.5)
```
pip install idf-analysis
```
Add the following tags to the command for special options:
- ```--user```: To install the package only for the local user account (no admin rights needed)
- ```--upgrade```: To update the package
### Windows
You have to install python first (i.e. the original python from the [website](https://www.python.org/downloads/)).
To use the command-line-tool, it is advisable to add the path to your Python binary to the environment variables [^path1].
There is also an option during the installation to add python to the PATH automatically. [^path2]
[^path1]: https://geek-university.com/python/add-python-to-the-windows-path/
[^path2]: https://datatofish.com/add-python-to-windows-path/
### Linux/Unix
Python is pre-installed on most operating systems (as you probably knew).
### Dependencies
Packages required for this program will be installed with pip during the installation process and can be seen
in the [`requirements.txt`](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/requirements.txt) file.
```mermaid
flowchart TD
contourpy["contourpy<br>1.3.1"]
cycler["cycler<br>0.12.1"]
fonttools["fonttools<br>4.54.1"]
kiwisolver["kiwisolver<br>1.4.7"]
matplotlib["matplotlib<br>3.9.2"]
mpmath["mpmath<br>1.3.0"]
numpy["numpy<br>2.1.3"]
packaging["packaging<br>24.2"]
pandas["pandas<br>2.2.3"]
pillow["pillow<br>11.0.0"]
pyparsing["pyparsing<br>3.2.0"]
python-dateutil["python-dateutil<br>2.9.0.post0"]
pytz["pytz<br>2024.2"]
pyyaml["PyYAML<br>6.0.2"]
scipy["scipy<br>1.14.1"]
six["six<br>1.16.0"]
sympy["sympy<br>1.13.3"]
tqdm["tqdm<br>4.67.0"]
tzdata["tzdata<br>2024.2"]
contourpy -- "≥1.23" --> numpy
matplotlib -- "≥0.10" --> cycler
matplotlib -- "≥1.0.1" --> contourpy
matplotlib -- "≥1.23" --> numpy
matplotlib -- "≥1.3.1" --> kiwisolver
matplotlib -- "≥2.3.1" --> pyparsing
matplotlib -- "≥2.7" --> python-dateutil
matplotlib -- "≥20.0" --> packaging
matplotlib -- "≥4.22.0" --> fonttools
matplotlib -- "≥8" --> pillow
pandas -- "≥1.26.0" --> numpy
pandas -- "≥2.8.2" --> python-dateutil
pandas -- "≥2020.1" --> pytz
pandas -- "≥2022.7" --> tzdata
python-dateutil -- "≥1.5" --> six
scipy -- "≥1.23.5,<2.3" --> numpy
sympy -- "≥1.1.0,<1.4" --> mpmath
```
## Usage
The documentation of the python-package can be found [here](https://markuspic.github.io/intensity_duration_frequency_analysis/api.html).
One basic usage could be:
```python
import pandas as pd
from idf_analysis import IntensityDurationFrequencyAnalyse
from idf_analysis.definitions import *
# initialize of the analysis class
idf = IntensityDurationFrequencyAnalyse(series_kind=SERIES.PARTIAL, worksheet=METHOD.KOSTRA, extended_durations=True)
series = pd.Series(index=pd.DatetimeIndex(...), data=...) # this is just a placeholder
# setting the series for the analysis
idf.set_series(series)
# auto-save the calculated parameter so save time for a later use, as the parameters doesn't have to be calculated again.
idf.auto_save_parameters('idf_parameters.yaml')
```
If you only want to analyse an already existing IDF-table
```python
import pandas as pd
from idf_analysis import IntensityDurationFrequencyAnalyse
idf_table = pd.DataFrame(...) # this is just a placeholder
# index: Duration Steps in minutes as int or float
# columns: Return Periods in years as int or float
# values: rainfall height in mm
idf = IntensityDurationFrequencyAnalyse.from_idf_table(idf_table)
```
## Commandline tool
The following commands show the usage for Linux/Unix systems.
To use these features on Windows you have to add ```python -m``` before each command.
To start the script use following commands in the terminal/Prompt
```idf_analysis```
> ```idf_analysis -h```
```
usage: __main__.py [-h] -i INPUT
[-ws {ATV-A_121,KOSTRA,convective_vs_advective}]
[-kind {partial,annual}] [-t {>= 0.5 a and <= 100 a}]
[-d {>= 5 min and <= 8640 min}] [-r {>= 0 L/s*ha}]
[-h_N {>= 0 mm}] [--r_720_1] [--plot] [--export_table]
heavy rain as a function of the duration and the return period acc. to DWA-A
531 (2012) All files will be saved in the same directory of the input file but
in a subfolder called like the inputfile + "_idf_data". Inside this folder a
file called "idf_parameter.yaml"-file will be saved and contains interim-
calculation-results and will be automatically reloaded on the next call.
optional arguments:
-h, --help show this help message and exit
-i INPUT, --input INPUT
input file with the rain time-series (csv or parquet)
-ws {ATV-A_121,KOSTRA,convective_vs_advective}, --worksheet {ATV-A_121,KOSTRA,convective_vs_advective}
From which worksheet the recommendations for
calculating the parameters should be taken.
-kind {partial,annual}, --series_kind {partial,annual}
The kind of series used for the calculation.
(Calculation with partial series is more precise and
recommended.)
-t {>= 0.5 a and <= 100 a}, --return_period {>= 0.5 a and <= 100 a}
return period in years (If two of the three variables
(rainfall (height or flow-rate), duration, return
period) are given, the third variable is calculated.)
-d {>= 5 min and <= 8640 min}, --duration {>= 5 min and <= 8640 min}
duration in minutes (If two of the three variables
(rainfall (height or flow-rate), duration, return
period) are given, the third variable is calculated.)
-r {>= 0 L/(s*ha)}, --flow_rate_of_rainfall {>= 0 L/(s*ha)}
rainfall in Liter/(s * ha) (If two of the three
variables (rainfall (height or flow-rate), duration,
return period) are given, the third variable is
calculated.)
-h_N {>= 0 mm}, --height_of_rainfall {>= 0 mm}
rainfall in mm or Liter/m^2 (If two of the three
variables (rainfall (height or flow-rate), duration,
return period) are given, the third variable is
calculated.)
--r_720_1 design rainfall with a duration of 720 minutes (=12 h)
and a return period of 1 year
--plot get a plot of the idf relationship
--export_table get a table of the most frequent used values
```
## Example
In these examples you can see the usage in a reproducible way. This examples uses open data provided from the Austrian government. You can also find a link to the script used to download this data.
[Example Jupyter notebook for the commandline](examples/example_commandline.ipynb) (or in the [docs](https://markuspic.github.io/intensity_duration_frequency_analysis/examples/example_python_api.html))
[Example Jupyter notebook for the python api](examples/example_python_api.ipynb) (or in the [docs](https://markuspic.github.io/intensity_duration_frequency_analysis/examples/example_python_api.html))
[Example Jupyter notebook for the python api of the DWA 2025 methodology](examples/example_python_api_2025.ipynb) (or in the [docs](https://markuspic.github.io/intensity_duration_frequency_analysis/examples/example_python_api_2025.html))
[Example python skript](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/examples/example_python_api.py)
### Example Files
[Interim Results of the idf analysis](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/examples/ehyd_112086_idf_data/idf_parameters.yaml)
### Example Plot using the DWA 2012 methodology
### Example Plot using the DWA 2025 methodology
### Example IDF table
[IDF-Table](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/examples/ehyd_112086_idf_data/idf_table_UNIX.csv)
| return period in a<br>duration in min | 1 | 2 | 3 | 5 | 10 | 20 | 25 | 30 | 50 | 75 | 100 |
|--------------------------------------:|------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|
| 5 | 9.39 | 10.97 | 11.89 | 13.04 | 14.61 | 16.19 | 16.69 | 17.11 | 18.26 | 19.18 | 19.83 |
| 10 | 15.15 | 17.62 | 19.06 | 20.88 | 23.35 | 25.82 | 26.62 | 27.27 | 29.09 | 30.54 | 31.56 |
| 15 | 19.03 | 22.25 | 24.13 | 26.51 | 29.72 | 32.94 | 33.98 | 34.83 | 37.20 | 39.08 | 40.42 |
| 20 | 21.83 | 25.71 | 27.99 | 30.85 | 34.73 | 38.62 | 39.87 | 40.89 | 43.75 | 46.02 | 47.63 |
| 30 | 25.60 | 30.66 | 33.62 | 37.35 | 42.41 | 47.47 | 49.10 | 50.43 | 54.16 | 57.12 | 59.22 |
| 45 | 28.92 | 35.51 | 39.37 | 44.23 | 50.83 | 57.42 | 59.54 | 61.28 | 66.14 | 69.99 | 72.73 |
| 60 | 30.93 | 38.89 | 43.54 | 49.40 | 57.36 | 65.31 | 67.88 | 69.97 | 75.83 | 80.49 | 83.79 |
| 90 | 33.37 | 41.74 | 46.64 | 52.80 | 61.17 | 69.54 | 72.23 | 74.43 | 80.60 | 85.49 | 88.96 |
| 180 | 38.01 | 47.13 | 52.46 | 59.18 | 68.30 | 77.42 | 80.36 | 82.76 | 89.48 | 94.81 | 98.60 |
| 270 | 41.01 | 50.60 | 56.21 | 63.28 | 72.87 | 82.46 | 85.55 | 88.07 | 95.14 | 100.75 | 104.73 |
| 360 | 43.29 | 53.23 | 59.04 | 66.37 | 76.31 | 86.25 | 89.45 | 92.06 | 99.39 | 105.20 | 109.33 |
| 450 | 45.14 | 55.36 | 61.33 | 68.87 | 79.08 | 89.30 | 92.59 | 95.28 | 102.81 | 108.79 | 113.03 |
| 600 | 47.64 | 58.23 | 64.43 | 72.23 | 82.82 | 93.41 | 96.82 | 99.61 | 107.42 | 113.61 | 118.01 |
| 720 | 49.29 | 60.13 | 66.47 | 74.45 | 85.29 | 96.12 | 99.61 | 102.46 | 110.44 | 116.78 | 121.28 |
| 1080 | 54.41 | 64.97 | 71.15 | 78.94 | 89.50 | 100.06 | 103.46 | 106.24 | 114.02 | 120.20 | 124.58 |
| 1440 | 58.02 | 67.72 | 73.39 | 80.54 | 90.24 | 99.93 | 103.05 | 105.61 | 112.75 | 118.42 | 122.45 |
| 2880 | 66.70 | 77.41 | 83.68 | 91.57 | 102.29 | 113.00 | 116.45 | 119.26 | 127.16 | 133.42 | 137.87 |
| 4320 | 71.93 | 85.72 | 93.78 | 103.95 | 117.73 | 131.52 | 135.96 | 139.58 | 149.75 | 157.81 | 163.53 |
| 5760 | 78.95 | 95.65 | 105.42 | 117.72 | 134.43 | 151.13 | 156.50 | 160.89 | 173.20 | 182.97 | 189.90 |
| 7200 | 83.53 | 101.38 | 111.82 | 124.98 | 142.83 | 160.68 | 166.43 | 171.12 | 184.28 | 194.72 | 202.13 |
| 8640 | 85.38 | 104.95 | 116.40 | 130.82 | 150.38 | 169.95 | 176.25 | 181.40 | 195.82 | 207.27 | 215.39 |
## Contributing and Support
If you're interested in contributing or need help, check out the [CONTRIBUTING.md](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CONTRIBUTING.md) file for guidelines.
## Testing
The code is written in pure python so no compiling is needed.
Most of the code is (or at least will be) automatically tested using the test suite in the [./tests](./tests) folder. To run the tests, use:
```sh
pytest tests
```
## Background
Pseudocode for the parameter calculation.
```
For every duration step
calculating maximum rainfall intensity for each event for the corresponding duration step
if using annual event series: # only recommeded for measurements longer than 20 year
converting max event rainfall intensities per year to a series
calculating parameters u and w using the gumbel distribution
elif using partial event series:
converting the n (approximatly 2.72 x measurement duration in years) biggest event rainfall intensities to a series
calculating parameters u and w using the exponential distribution
Splitting IDF curve formulation in to several duration ranges
For each duration range:
For each parameter (u and w):
balancing the parameter over all duation steps (in the range) using a given formulation (creating parameters a and b)
# one-folded-logaritmic | two-folded-logarithmic | hyperbolic
u(D) = f(a_u, b_u, D)
w(D) = f(a_w, b_w, D)
h(D,Tn) = u(D) + w(D) * ln(Tn)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "idf-analysis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "duration, analysis, rainfall, dwd, idf, measurement-data, precipitation, kostra, dwa, heavy-rain, intensity-duration-frequency, design-rainfall, duration-steps, return-period, dwa-a-531",
"author": null,
"author_email": "Markus Pichler <markus.pichler@tugraz.at>",
"download_url": "https://files.pythonhosted.org/packages/81/94/9889cf76c3c912187516044a00008ba079c8183c2200ccc277ff36416d32/idf_analysis-0.4.0.tar.gz",
"platform": null,
"description": "\u00a9 [Institute of Urban Water Management and Landscape Water Engineering](https://www.sww.tugraz.at), [Graz University of Technology](https://www.tugraz.at/home/) and [Markus Pichler](mailto:markus.pichler@tugraz.at)\n\n\n# Intensity duration frequency analysis (based on KOSTRA)\n\n\n[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/LICENSE)\n[](https://pypi.python.org/pypi/idf-analysis)\n[](https://zenodo.org/doi/10.5281/zenodo.10559991)\n[](https://www.buymeacoffee.com/MarkusP)\n[](https://doi.org/10.21105/joss.07607)\n[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CONTRIBUTING.md)\n[](https://markuspic.github.io/intensity_duration_frequency_analysis/)\n[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CODE_OF_CONDUCT.md)\n[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/actions/workflows/tests.yaml)\n[](https://codecov.io/gh/MarkusPic/intensity_duration_frequency_analysis)\n[](https://github.com/MarkusPic/intensity_duration_frequency_analysis/actions/workflows/sphinx_docs_to_gh_pages.yaml)\n\n[](https://pypi.python.org/pypi/idf-analysis)\n[](https://pypi.python.org/pypi/idf-analysis)\n[](https://pypi.python.org/pypi/idf-analysis)\n\nHeavy rainfall intensity as a function of duration and return period acc. to [DWA-A 531 (2012)](https://shop.dwa.de/DWA-A-531-Starkregen-in-Abhaengigkeit-von-Wiederkehrzeit-und-Dauer-September-2012-Stand-korrigierte-Fassung-Mai-2017/A-531-Hauptprodukt-12-main).\nThis program reads the measurement data of the rainfall\nand calculates the distribution of the design rainfall as a function of the return period and the duration\nfor duration steps up to 12 hours (and more) and return period in a range of '0.5a ≤ T_n ≤ 100a'.\n\nThe guideline was used in the application [KOSTRA-DWD](https://www.dwd.de/DE/leistungen/kostra_dwd_rasterwerte/kostra_dwd_rasterwerte.html).\n\nSince version v0.4 the new guidelines of [DWA-A 531 (2025)](https://shop.dwa.de/DWA-A-531-Starkregen-in-Abhaengigkeit-von-Wiederkehrzeit-und-Dauer-Juni-2025/A-531-Hauptprodukt-25-main) are also implemented.\n\n----\n\n> Heavy rainfall data are among the most important planning parameters in water management and hydraulic engineering practice. In urban areas, for example, they are required as initial parameters for the design of rainwater drainage systems and in watercourses for the dimensioning of hydraulic structures. The accuracy of the target values of the corresponding calculation methods and models depends crucially on their accuracy. Their overestimation can lead to considerable additional costs in the structural implementation, their underestimation to an unacceptable, excessive residual risk of failure during the operation of water management and hydraulic engineering facilities. Despite the area-wide availability of heavy rainfall data through \"Coordinated Heavy Rainfall Regionalisation Analyses\" (KOSTRA), there is still a need for local station analyses, e.g. to evaluate the now extended data series, to evaluate recent developments or to classify local peculiarities in comparison to the KOSTRA data. However, this is only possible without restrictions if the methodological approach recommended in the worksheet is followed. \n\n**[DWA-A 531 (2012)](http://www.dwa.de/dwa/shop/shop.nsf/Produktanzeige?openform&produktid=P-DWAA-8XMUY2) Translated with www.DeepL.com/Translator**\n\n----\n\n> An intensity-duration-frequency (IDF) curve is a mathematical function that relates the rainfall intensity with its duration and frequency of occurrence. These curves are commonly used in hydrology for flood forecasting and civil engineering for urban drainage design. However, the IDF curves are also analysed in hydrometeorology because of the interest in the time concentration or time-structure of the rainfall.\n\n**[Wikipedia](https://en.wikipedia.org/wiki/Intensity-duration-frequency_curve)**\n\n----\n\nThis package was developed by [Markus Pichler](mailto:markus.pichler@tugraz.at) during his bachelor thesis and finalised it in the course of his employment at the [Institute of Urban Water Management and Landscape Water Engineering](https://www.sww.tugraz.at).\n\n## Documentation\n\nRead the docs [here \ud83d\udcd6](https://markuspic.github.io/intensity_duration_frequency_analysis).\n\n## Please cite as\n\nPichler, M. (2025). idf-analysis: Heavy rainfall intensity as a function of duration and return period. Journal of Open Source Software, 10(106), 7607. https://doi.org/10.21105/joss.07607\n\n## Installation\n\nThis package is written in Python3. (use a version > 3.5)\n\n```\npip install idf-analysis\n```\n\nAdd the following tags to the command for special options:\n\n- ```--user```: To install the package only for the local user account (no admin rights needed)\n- ```--upgrade```: To update the package\n\n### Windows\n\nYou have to install python first (i.e. the original python from the [website](https://www.python.org/downloads/)).\n\nTo use the command-line-tool, it is advisable to add the path to your Python binary to the environment variables [^path1].\nThere is also an option during the installation to add python to the PATH automatically. [^path2]\n\n[^path1]: https://geek-university.com/python/add-python-to-the-windows-path/\n[^path2]: https://datatofish.com/add-python-to-windows-path/\n\n\n### Linux/Unix\n\nPython is pre-installed on most operating systems (as you probably knew).\n\n### Dependencies\n\nPackages required for this program will be installed with pip during the installation process and can be seen \nin the [`requirements.txt`](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/requirements.txt) file.\n\n\n```mermaid\nflowchart TD\n contourpy[\"contourpy<br>1.3.1\"]\n cycler[\"cycler<br>0.12.1\"]\n fonttools[\"fonttools<br>4.54.1\"]\n kiwisolver[\"kiwisolver<br>1.4.7\"]\n matplotlib[\"matplotlib<br>3.9.2\"]\n mpmath[\"mpmath<br>1.3.0\"]\n numpy[\"numpy<br>2.1.3\"]\n packaging[\"packaging<br>24.2\"]\n pandas[\"pandas<br>2.2.3\"]\n pillow[\"pillow<br>11.0.0\"]\n pyparsing[\"pyparsing<br>3.2.0\"]\n python-dateutil[\"python-dateutil<br>2.9.0.post0\"]\n pytz[\"pytz<br>2024.2\"]\n pyyaml[\"PyYAML<br>6.0.2\"]\n scipy[\"scipy<br>1.14.1\"]\n six[\"six<br>1.16.0\"]\n sympy[\"sympy<br>1.13.3\"]\n tqdm[\"tqdm<br>4.67.0\"]\n tzdata[\"tzdata<br>2024.2\"]\n contourpy -- \"≥1.23\" --> numpy\n matplotlib -- \"≥0.10\" --> cycler\n matplotlib -- \"≥1.0.1\" --> contourpy\n matplotlib -- \"≥1.23\" --> numpy\n matplotlib -- \"≥1.3.1\" --> kiwisolver\n matplotlib -- \"≥2.3.1\" --> pyparsing\n matplotlib -- \"≥2.7\" --> python-dateutil\n matplotlib -- \"≥20.0\" --> packaging\n matplotlib -- \"≥4.22.0\" --> fonttools\n matplotlib -- \"≥8\" --> pillow\n pandas -- \"≥1.26.0\" --> numpy\n pandas -- \"≥2.8.2\" --> python-dateutil\n pandas -- \"≥2020.1\" --> pytz\n pandas -- \"≥2022.7\" --> tzdata\n python-dateutil -- \"≥1.5\" --> six\n scipy -- \"≥1.23.5,<2.3\" --> numpy\n sympy -- \"≥1.1.0,<1.4\" --> mpmath\n```\n\n## Usage\n\nThe documentation of the python-package can be found [here](https://markuspic.github.io/intensity_duration_frequency_analysis/api.html).\n\nOne basic usage could be:\n\n```python\nimport pandas as pd\nfrom idf_analysis import IntensityDurationFrequencyAnalyse\nfrom idf_analysis.definitions import *\n\n# initialize of the analysis class\nidf = IntensityDurationFrequencyAnalyse(series_kind=SERIES.PARTIAL, worksheet=METHOD.KOSTRA, extended_durations=True)\n\nseries = pd.Series(index=pd.DatetimeIndex(...), data=...) # this is just a placeholder\n\n# setting the series for the analysis\nidf.set_series(series)\n# auto-save the calculated parameter so save time for a later use, as the parameters doesn't have to be calculated again.\nidf.auto_save_parameters('idf_parameters.yaml')\n```\n\nIf you only want to analyse an already existing IDF-table\n\n```python\nimport pandas as pd\nfrom idf_analysis import IntensityDurationFrequencyAnalyse\n\nidf_table = pd.DataFrame(...) # this is just a placeholder\n# index: Duration Steps in minutes as int or float\n# columns: Return Periods in years as int or float\n# values: rainfall height in mm\nidf = IntensityDurationFrequencyAnalyse.from_idf_table(idf_table)\n```\n\n## Commandline tool\n\nThe following commands show the usage for Linux/Unix systems.\nTo use these features on Windows you have to add ```python -m``` before each command.\n\nTo start the script use following commands in the terminal/Prompt\n\n```idf_analysis```\n\n> ```idf_analysis -h```\n\n```\nusage: __main__.py [-h] -i INPUT\n [-ws {ATV-A_121,KOSTRA,convective_vs_advective}]\n [-kind {partial,annual}] [-t {>= 0.5 a and <= 100 a}]\n [-d {>= 5 min and <= 8640 min}] [-r {>= 0 L/s*ha}]\n [-h_N {>= 0 mm}] [--r_720_1] [--plot] [--export_table]\n\nheavy rain as a function of the duration and the return period acc. to DWA-A\n531 (2012) All files will be saved in the same directory of the input file but\nin a subfolder called like the inputfile + \"_idf_data\". Inside this folder a\nfile called \"idf_parameter.yaml\"-file will be saved and contains interim-\ncalculation-results and will be automatically reloaded on the next call.\n\noptional arguments:\n -h, --help show this help message and exit\n -i INPUT, --input INPUT\n input file with the rain time-series (csv or parquet)\n -ws {ATV-A_121,KOSTRA,convective_vs_advective}, --worksheet {ATV-A_121,KOSTRA,convective_vs_advective}\n From which worksheet the recommendations for\n calculating the parameters should be taken.\n -kind {partial,annual}, --series_kind {partial,annual}\n The kind of series used for the calculation.\n (Calculation with partial series is more precise and\n recommended.)\n -t {>= 0.5 a and <= 100 a}, --return_period {>= 0.5 a and <= 100 a}\n return period in years (If two of the three variables\n (rainfall (height or flow-rate), duration, return\n period) are given, the third variable is calculated.)\n -d {>= 5 min and <= 8640 min}, --duration {>= 5 min and <= 8640 min}\n duration in minutes (If two of the three variables\n (rainfall (height or flow-rate), duration, return\n period) are given, the third variable is calculated.)\n -r {>= 0 L/(s*ha)}, --flow_rate_of_rainfall {>= 0 L/(s*ha)}\n rainfall in Liter/(s * ha) (If two of the three\n variables (rainfall (height or flow-rate), duration,\n return period) are given, the third variable is\n calculated.)\n -h_N {>= 0 mm}, --height_of_rainfall {>= 0 mm}\n rainfall in mm or Liter/m^2 (If two of the three\n variables (rainfall (height or flow-rate), duration,\n return period) are given, the third variable is\n calculated.)\n --r_720_1 design rainfall with a duration of 720 minutes (=12 h)\n and a return period of 1 year\n --plot get a plot of the idf relationship\n --export_table get a table of the most frequent used values\n```\n\n## Example\n\nIn these examples you can see the usage in a reproducible way. This examples uses open data provided from the Austrian government. You can also find a link to the script used to download this data.\n\n[Example Jupyter notebook for the commandline](examples/example_commandline.ipynb) (or in the [docs](https://markuspic.github.io/intensity_duration_frequency_analysis/examples/example_python_api.html))\n\n[Example Jupyter notebook for the python api](examples/example_python_api.ipynb) (or in the [docs](https://markuspic.github.io/intensity_duration_frequency_analysis/examples/example_python_api.html))\n\n[Example Jupyter notebook for the python api of the DWA 2025 methodology](examples/example_python_api_2025.ipynb) (or in the [docs](https://markuspic.github.io/intensity_duration_frequency_analysis/examples/example_python_api_2025.html))\n\n[Example python skript](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/examples/example_python_api.py)\n\n\n### Example Files\n\n[Interim Results of the idf analysis](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/examples/ehyd_112086_idf_data/idf_parameters.yaml)\n\n### Example Plot using the DWA 2012 methodology\n\n\n\n### Example Plot using the DWA 2025 methodology\n\n\n\n\n### Example IDF table\n\n[IDF-Table](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/examples/ehyd_112086_idf_data/idf_table_UNIX.csv)\n\n\n| return period in a<br>duration in min | 1 | 2 | 3 | 5 | 10 | 20 | 25 | 30 | 50 | 75 | 100 |\n|--------------------------------------:|------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|\n| 5 | 9.39 | 10.97 | 11.89 | 13.04 | 14.61 | 16.19 | 16.69 | 17.11 | 18.26 | 19.18 | 19.83 |\n| 10 | 15.15 | 17.62 | 19.06 | 20.88 | 23.35 | 25.82 | 26.62 | 27.27 | 29.09 | 30.54 | 31.56 |\n| 15 | 19.03 | 22.25 | 24.13 | 26.51 | 29.72 | 32.94 | 33.98 | 34.83 | 37.20 | 39.08 | 40.42 |\n| 20 | 21.83 | 25.71 | 27.99 | 30.85 | 34.73 | 38.62 | 39.87 | 40.89 | 43.75 | 46.02 | 47.63 |\n| 30 | 25.60 | 30.66 | 33.62 | 37.35 | 42.41 | 47.47 | 49.10 | 50.43 | 54.16 | 57.12 | 59.22 |\n| 45 | 28.92 | 35.51 | 39.37 | 44.23 | 50.83 | 57.42 | 59.54 | 61.28 | 66.14 | 69.99 | 72.73 |\n| 60 | 30.93 | 38.89 | 43.54 | 49.40 | 57.36 | 65.31 | 67.88 | 69.97 | 75.83 | 80.49 | 83.79 |\n| 90 | 33.37 | 41.74 | 46.64 | 52.80 | 61.17 | 69.54 | 72.23 | 74.43 | 80.60 | 85.49 | 88.96 |\n| 180 | 38.01 | 47.13 | 52.46 | 59.18 | 68.30 | 77.42 | 80.36 | 82.76 | 89.48 | 94.81 | 98.60 |\n| 270 | 41.01 | 50.60 | 56.21 | 63.28 | 72.87 | 82.46 | 85.55 | 88.07 | 95.14 | 100.75 | 104.73 |\n| 360 | 43.29 | 53.23 | 59.04 | 66.37 | 76.31 | 86.25 | 89.45 | 92.06 | 99.39 | 105.20 | 109.33 |\n| 450 | 45.14 | 55.36 | 61.33 | 68.87 | 79.08 | 89.30 | 92.59 | 95.28 | 102.81 | 108.79 | 113.03 |\n| 600 | 47.64 | 58.23 | 64.43 | 72.23 | 82.82 | 93.41 | 96.82 | 99.61 | 107.42 | 113.61 | 118.01 |\n| 720 | 49.29 | 60.13 | 66.47 | 74.45 | 85.29 | 96.12 | 99.61 | 102.46 | 110.44 | 116.78 | 121.28 |\n| 1080 | 54.41 | 64.97 | 71.15 | 78.94 | 89.50 | 100.06 | 103.46 | 106.24 | 114.02 | 120.20 | 124.58 |\n| 1440 | 58.02 | 67.72 | 73.39 | 80.54 | 90.24 | 99.93 | 103.05 | 105.61 | 112.75 | 118.42 | 122.45 |\n| 2880 | 66.70 | 77.41 | 83.68 | 91.57 | 102.29 | 113.00 | 116.45 | 119.26 | 127.16 | 133.42 | 137.87 |\n| 4320 | 71.93 | 85.72 | 93.78 | 103.95 | 117.73 | 131.52 | 135.96 | 139.58 | 149.75 | 157.81 | 163.53 |\n| 5760 | 78.95 | 95.65 | 105.42 | 117.72 | 134.43 | 151.13 | 156.50 | 160.89 | 173.20 | 182.97 | 189.90 |\n| 7200 | 83.53 | 101.38 | 111.82 | 124.98 | 142.83 | 160.68 | 166.43 | 171.12 | 184.28 | 194.72 | 202.13 |\n| 8640 | 85.38 | 104.95 | 116.40 | 130.82 | 150.38 | 169.95 | 176.25 | 181.40 | 195.82 | 207.27 | 215.39 |\n\n## Contributing and Support\n\nIf you're interested in contributing or need help, check out the [CONTRIBUTING.md](https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CONTRIBUTING.md) file for guidelines.\n\n\n## Testing\n\nThe code is written in pure python so no compiling is needed.\n\nMost of the code is (or at least will be) automatically tested using the test suite in the [./tests](./tests) folder. To run the tests, use:\n\n```sh\npytest tests\n```\n\n## Background\n\nPseudocode for the parameter calculation.\n\n```\nFor every duration step\n calculating maximum rainfall intensity for each event for the corresponding duration step\n \n if using annual event series: # only recommeded for measurements longer than 20 year\n converting max event rainfall intensities per year to a series\n calculating parameters u and w using the gumbel distribution\n \n elif using partial event series:\n converting the n (approximatly 2.72 x measurement duration in years) biggest event rainfall intensities to a series\n calculating parameters u and w using the exponential distribution\n \nSplitting IDF curve formulation in to several duration ranges\nFor each duration range:\n For each parameter (u and w):\n balancing the parameter over all duation steps (in the range) using a given formulation (creating parameters a and b)\n # one-folded-logaritmic | two-folded-logarithmic | hyperbolic\n\nu(D) = f(a_u, b_u, D)\nw(D) = f(a_w, b_w, D)\n\nh(D,Tn) = u(D) + w(D) * ln(Tn)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "heavy rainfall intensity as a function of duration and return period acc. to DWA-A 531 (2012)",
"version": "0.4.0",
"project_urls": {
"Changelog": "https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CHANGELOG.md",
"Documentation": "https://markuspic.github.io/intensity_duration_frequency_analysis/",
"funding": "https://www.buymeacoffee.com/MarkusP",
"homepage": "https://github.com/MarkusPic/intensity_duration_frequency_analysis"
},
"split_keywords": [
"duration",
" analysis",
" rainfall",
" dwd",
" idf",
" measurement-data",
" precipitation",
" kostra",
" dwa",
" heavy-rain",
" intensity-duration-frequency",
" design-rainfall",
" duration-steps",
" return-period",
" dwa-a-531"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f4b56fd796e235dccbd3fce2a918d098e3ea3b67821ddefbb9ada28e8bd3a98e",
"md5": "28282b4097c5cd84b15a56cedec6421e",
"sha256": "206628ccb833f8f84a209ac356772736ae9a2376ab6ee588803bc04e5b293da2"
},
"downloads": -1,
"filename": "idf_analysis-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28282b4097c5cd84b15a56cedec6421e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 58239,
"upload_time": "2025-07-10T08:37:56",
"upload_time_iso_8601": "2025-07-10T08:37:56.960390Z",
"url": "https://files.pythonhosted.org/packages/f4/b5/6fd796e235dccbd3fce2a918d098e3ea3b67821ddefbb9ada28e8bd3a98e/idf_analysis-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "81949889cf76c3c912187516044a00008ba079c8183c2200ccc277ff36416d32",
"md5": "6a07d412042990f0eb1a94d10cc7694d",
"sha256": "85171a3801ef8ddc5007d7c3f8537840ba1b0b187895814421090ea60a7bc525"
},
"downloads": -1,
"filename": "idf_analysis-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "6a07d412042990f0eb1a94d10cc7694d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 65558,
"upload_time": "2025-07-10T08:37:58",
"upload_time_iso_8601": "2025-07-10T08:37:58.571433Z",
"url": "https://files.pythonhosted.org/packages/81/94/9889cf76c3c912187516044a00008ba079c8183c2200ccc277ff36416d32/idf_analysis-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 08:37:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarkusPic",
"github_project": "intensity_duration_frequency_analysis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pandas",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "tqdm",
"specs": [
[
">=",
"4.67"
]
]
},
{
"name": "scipy",
"specs": []
},
{
"name": "PyYAML",
"specs": [
[
">=",
"5"
]
]
},
{
"name": "sympy",
"specs": []
}
],
"lcname": "idf-analysis"
}
JSON
