© [Institute of Urban Water Management and Landscape Water Engineering](https://www.tugraz.at),
[Graz University of Technology](https://www.tugraz.at/home/) and [Markus Pichler](mailto:markus.pichler@tugraz.at)
# eHYD Tools
[](https://github.com/MarkusPic/ehyd_tools/blob/master/LICENSE)
[](https://pypi.python.org/pypi/ehyd-tools)
Reading and analyzing hydro(geo)logic time series from the Austrian government's "ehyd.gv.at" platform.
Various tools for exporting and analyzing >10a rain time-series from the [ehyd.gv.at](https://ehyd.gv.at) platform of the Austian government.
If you are interested in a statistical heavy rain analysis like on *(Ö)Kostra*, take a look at my other python package [intensity_duration_frequency_analysis](https://github.com/MarkusPic/intensity_duration_frequency_analysis) which is compatible with this package.
# Install
The script is written in Python3. (use a version > 3.5)
## Windows
You have to install python (i.e. the original python from the [website](https://www.python.org/downloads/)).
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
and you have to add the path to your python binary to the environment variables [^path1].
[^path1]: https://geek-university.com/python/add-python-to-the-windows-path/
There is also an option during the installation to add python to the PATH automatically. [^path2]
[^path2]: https://datatofish.com/add-python-to-windows-path/
## Linux/Unix
Python is pre-installed on most operating systems (as you probably knew).
## Required python packages
Packages required for this program will be installed with pip during the installation process and can be seen in the 'requirements.txt' file.
## Fresh install
```bash
pip install ehyd-tools
```
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
# Alternative Repositories
- https://github.com/hydrogeology-graz/ehyd
- https://github.com/joha1/ehyd_reader
# Usage for general time-series data
### Examples Jupyter notebooks for Extended python API
> links only work on GitHub!
- [the design rainfall](example/example_design_rainfall.ipynb)
- [model rain creator](example/example_synthetic_rain.ipynb)
- [the general data-reader](example/example_python_api_general.ipynb)
- [the gis extract](example/example_gis_export.ipynb)
# Usage for high-res precipitation time-series
To start the script use following commands in the terminal/Prompt
```ehyd_tools```
## Commandline tool
With the `-h` (help) flag you can see the complete functionality of the tool.
```bash
ehyd_tools -h
```
> ```
> usage: __main__.py [-h] [-id ID] [--input INPUT] [--max10a] [--start START]
> [--end END] [--add_gaps] [--to_csv] [--to_parquet] [--plot]
> [--statistics] [--meta] [--unix]
>
> optional arguments:
> -h, --help show this help message and exit
> -id ID the id number for the station from the ehyd.gv.at platform
> --input INPUT path to the rain input file including the filename
> --max10a consider only 10 years with the most availability (for
> clipping the data)
> --start START custom start time (Format="YYYY-MM-DD") for clipping the data
> --end END custom end time (Format="YYYY-MM-DD") for clipping the data
> --add_gaps save a gaps-table as a csv-file
> --to_csv save the time-series as csv-file (to the current directory if
> the id is used or in the directory of the input-file)
> --to_parquet save the time-series as parquet-file (to the current
> directory if the id is used or in the directory of the input-
> file) - parquet is a much faster as csv to read and write
> --plot save a bar-plot with monthly sums and availability as a png-
> file
> --statistics save the basic statistics (sum, max & min) as a txt-file
> --meta save the meta-data presented in ehyd as a txt-file
> --unix export the csv files with a "," as separator and a "." as
> decimal sign (otherwise ";" as separator and a "," as decimal
> sign will be used)
> ```
## The high-res precipitation stations
> links only work on GitHub!
[List of ehyd-stations with the id-number and the label](ehyd_tools/ehyd_stations.json)
## Examples
> links only work on GitHub!
[Example Jupyter notebook for the commandline](example/example_commandline.ipynb)
[Example Jupyter notebook for the python api](example/example_python_api.ipynb)
[Example python skript](example/example_python_api.py)
### Example results files
> links only work on GitHub!
[Data-gaps in the series](example/ehyd_112086_gaps.csv)
[Meta-data of the series](example/ehyd_112086_meta.txt)
### Example Plot
> links only work on GitHub!
Raw data
{
"_id": null,
"home_page": "",
"name": "ehyd-tools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "austria,precipitation,groundwater,hydrology,data,environment,civil_engineering,api",
"author": "",
"author_email": "Markus Pichler <markus.pichler@tugraz.at>",
"download_url": "https://files.pythonhosted.org/packages/13/bd/963d6651eda4343a988be1d9354acf77ca3a366f54aa200a9182e423131d/ehyd-tools-0.1.2.tar.gz",
"platform": null,
"description": "\u00a9 [Institute of Urban Water Management and Landscape Water Engineering](https://www.tugraz.at), \n[Graz University of Technology](https://www.tugraz.at/home/) and [Markus Pichler](mailto:markus.pichler@tugraz.at)\n\n# eHYD Tools\n\n[](https://github.com/MarkusPic/ehyd_tools/blob/master/LICENSE)\n[](https://pypi.python.org/pypi/ehyd-tools)\n\nReading and analyzing hydro(geo)logic time series from the Austrian government's \"ehyd.gv.at\" platform.\n\nVarious tools for exporting and analyzing >10a rain time-series from the [ehyd.gv.at](https://ehyd.gv.at) platform of the Austian government.\n\nIf you are interested in a statistical heavy rain analysis like on *(\u00d6)Kostra*, take a look at my other python package [intensity_duration_frequency_analysis](https://github.com/MarkusPic/intensity_duration_frequency_analysis) which is compatible with this package.\n\n# Install\n\nThe script is written in Python3. (use a version > 3.5)\n\n## Windows\n\nYou have to install python (i.e. the original python from the [website](https://www.python.org/downloads/)).\n\nThe following commands show the usage for Linux/Unix systems. \n\nTo use these features on Windows you have to add ```python -m``` before each command \nand you have to add the path to your python binary to the environment variables [^path1].\n\n[^path1]: https://geek-university.com/python/add-python-to-the-windows-path/\n\nThere is also an option during the installation to add python to the PATH automatically. [^path2]\n\n[^path2]: https://datatofish.com/add-python-to-windows-path/\n\n\n\n## Linux/Unix\n\nPython is pre-installed on most operating systems (as you probably knew).\n\n## Required python packages\n\nPackages required for this program will be installed with pip during the installation process and can be seen in the 'requirements.txt' file.\n\n## Fresh install\n\n```bash\npip install ehyd-tools\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# Alternative Repositories\n\n- https://github.com/hydrogeology-graz/ehyd\n- https://github.com/joha1/ehyd_reader\n\n# Usage for general time-series data\n\n### Examples Jupyter notebooks for Extended python API\n\n> links only work on GitHub!\n\n- [the design rainfall](example/example_design_rainfall.ipynb)\n- [model rain creator](example/example_synthetic_rain.ipynb)\n- [the general data-reader](example/example_python_api_general.ipynb)\n- [the gis extract](example/example_gis_export.ipynb)\n\n# Usage for high-res precipitation time-series\n\nTo start the script use following commands in the terminal/Prompt\n\n```ehyd_tools```\n\n## Commandline tool \n\nWith the `-h` (help) flag you can see the complete functionality of the tool.\n\n```bash\nehyd_tools -h\n```\n\n> ```\n> usage: __main__.py [-h] [-id ID] [--input INPUT] [--max10a] [--start START]\n> [--end END] [--add_gaps] [--to_csv] [--to_parquet] [--plot]\n> [--statistics] [--meta] [--unix]\n> \n> optional arguments:\n> -h, --help show this help message and exit\n> -id ID the id number for the station from the ehyd.gv.at platform\n> --input INPUT path to the rain input file including the filename\n> --max10a consider only 10 years with the most availability (for\n> clipping the data)\n> --start START custom start time (Format=\"YYYY-MM-DD\") for clipping the data\n> --end END custom end time (Format=\"YYYY-MM-DD\") for clipping the data\n> --add_gaps save a gaps-table as a csv-file\n> --to_csv save the time-series as csv-file (to the current directory if\n> the id is used or in the directory of the input-file)\n> --to_parquet save the time-series as parquet-file (to the current\n> directory if the id is used or in the directory of the input-\n> file) - parquet is a much faster as csv to read and write\n> --plot save a bar-plot with monthly sums and availability as a png-\n> file\n> --statistics save the basic statistics (sum, max & min) as a txt-file\n> --meta save the meta-data presented in ehyd as a txt-file\n> --unix export the csv files with a \",\" as separator and a \".\" as\n> decimal sign (otherwise \";\" as separator and a \",\" as decimal\n> sign will be used)\n> ```\n\n## The high-res precipitation stations\n\n> links only work on GitHub!\n\n[List of ehyd-stations with the id-number and the label](ehyd_tools/ehyd_stations.json)\n\n## Examples\n\n> links only work on GitHub!\n\n[Example Jupyter notebook for the commandline](example/example_commandline.ipynb)\n\n[Example Jupyter notebook for the python api](example/example_python_api.ipynb)\n\n[Example python skript](example/example_python_api.py)\n\n### Example results files\n\n> links only work on GitHub!\n\n[Data-gaps in the series](example/ehyd_112086_gaps.csv)\n\n[Meta-data of the series](example/ehyd_112086_meta.txt)\n\n\n### Example Plot\n\n> links only work on GitHub!\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Reading and analyzing hydro(geo)logic time series from the Austrian government's \"ehyd.gv.at\" platform.",
"version": "0.1.2",
"project_urls": {
"Changelog": "https://github.com/MarkusPic/ehyd_tools/blob/master/CHANGELOG.md",
"homepage": "https://github.com/MarkusPic/ehyd_tools"
},
"split_keywords": [
"austria",
"precipitation",
"groundwater",
"hydrology",
"data",
"environment",
"civil_engineering",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4eb7ec76755f8ea6a6f5f90ad0e7fd10cebc6ed01ff61914d6217f537d54e0d",
"md5": "d9e1b525a1b423342ab3dd927c31fc2c",
"sha256": "418498712e7a2896ac821495005ba922a08fc55a1a4d27996a4cd1c2e15bd0e1"
},
"downloads": -1,
"filename": "ehyd_tools-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d9e1b525a1b423342ab3dd927c31fc2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 86245,
"upload_time": "2023-08-07T14:05:38",
"upload_time_iso_8601": "2023-08-07T14:05:38.910501Z",
"url": "https://files.pythonhosted.org/packages/f4/eb/7ec76755f8ea6a6f5f90ad0e7fd10cebc6ed01ff61914d6217f537d54e0d/ehyd_tools-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13bd963d6651eda4343a988be1d9354acf77ca3a366f54aa200a9182e423131d",
"md5": "d9a3913501425fd96a7934a1202d8f3b",
"sha256": "0970af471761b5a656c86092d0a3f41b2a6cc49cdd7a362dc92777b1f1d7a6ea"
},
"downloads": -1,
"filename": "ehyd-tools-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d9a3913501425fd96a7934a1202d8f3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 83747,
"upload_time": "2023-08-07T14:05:40",
"upload_time_iso_8601": "2023-08-07T14:05:40.520454Z",
"url": "https://files.pythonhosted.org/packages/13/bd/963d6651eda4343a988be1d9354acf77ca3a366f54aa200a9182e423131d/ehyd-tools-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-07 14:05:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarkusPic",
"github_project": "ehyd_tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ehyd-tools"
}
JSON
