Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

idf-analysis

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

idf-analysis

heavy rainfall intensity as a function of duration and return period acc. to DWA-A 531 (2012)

  • 0.3.0
  • PyPI
  • Socket score

Maintainers
1

© Institute of Urban Water Management and Landscape Water Engineering, Graz University of Technology and Markus Pichler

Intensity duration frequency analysis (based on KOSTRA)

license PyPI DOI

PyPI - Downloads PyPI - Downloads PyPI - Downloads

Heavy rainfall intensity as a function of duration and return period acc. to DWA-A 531 (2012). 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.


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) 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


This package was developed by Markus Pichler during his bachelor thesis and finalised it in the course of his employment at the Institute of Urban Water Management and Landscape Water Engineering.

Documentation

Read the docs here 📖.

Please cite as

Pichler, M. (2024). idf_analysis: Intensity duration frequency analysis with python based on KOSTRA (v0.2.4). Zenodo. https://doi.org/10.5281/zenodo.10559992

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).

To use the command-line-tool, it is advisable to add the path to your Python binary to the environment variables 1. There is also an option during the installation to add python to the PATH automatically. 2

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 file.

Usage

The documentation of the python-API can be found here.

One basic usage could be:

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=...)

# 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

import pandas as pd
from idf_analysis import IntensityDurationFrequencyAnalyse

idf_table = pd.DataFrame(...)
# 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,DWA-A_531,DWA-A_531_advektiv}]
                   [-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,DWA-A_531,DWA-A_531_advektiv}, --worksheet {ATV-A_121,DWA-A_531,DWA-A_531_advektiv}
                        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

Example Jupyter notebook for the commandline

Example Jupyter notebook for the python api

Example python skript

Example Files

Interim Results of the idf analysis

Example Plot

IDF-Curves-Plot

Example IDF table

IDF-Table

return period in a
duration in min
1235102025305075100
59.3910.9711.8913.0414.6116.1916.6917.1118.2619.1819.83
1015.1517.6219.0620.8823.3525.8226.6227.2729.0930.5431.56
1519.0322.2524.1326.5129.7232.9433.9834.8337.2039.0840.42
2021.8325.7127.9930.8534.7338.6239.8740.8943.7546.0247.63
3025.6030.6633.6237.3542.4147.4749.1050.4354.1657.1259.22
4528.9235.5139.3744.2350.8357.4259.5461.2866.1469.9972.73
6030.9338.8943.5449.4057.3665.3167.8869.9775.8380.4983.79
9033.3741.7446.6452.8061.1769.5472.2374.4380.6085.4988.96
18038.0147.1352.4659.1868.3077.4280.3682.7689.4894.8198.60
27041.0150.6056.2163.2872.8782.4685.5588.0795.14100.75104.73
36043.2953.2359.0466.3776.3186.2589.4592.0699.39105.20109.33
45045.1455.3661.3368.8779.0889.3092.5995.28102.81108.79113.03
60047.6458.2364.4372.2382.8293.4196.8299.61107.42113.61118.01
72049.2960.1366.4774.4585.2996.1299.61102.46110.44116.78121.28
108054.4164.9771.1578.9489.50100.06103.46106.24114.02120.20124.58
144058.0267.7273.3980.5490.2499.93103.05105.61112.75118.42122.45
288066.7077.4183.6891.57102.29113.00116.45119.26127.16133.42137.87
432071.9385.7293.78103.95117.73131.52135.96139.58149.75157.81163.53
576078.9595.65105.42117.72134.43151.13156.50160.89173.20182.97189.90
720083.53101.38111.82124.98142.83160.68166.43171.12184.28194.72202.13
864085.38104.95116.40130.82150.38169.95176.25181.40195.82207.27215.39

Background

Pseudocode for the parameter calculation.

For every duration step
    calculating event sums
    
    if using annual event series:  # only recommeded for measurements longer than 20 year
        converting every max event sum 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 sums 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)

Footnotes

  1. https://geek-university.com/python/add-python-to-the-windows-path/

  2. https://datatofish.com/add-python-to-windows-path/

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc