# MFD Floods
A python script to model hidrologic behavior of downstream drainpaths. With a DTM cover of your study area you can define longitude and latitude (in the DTM distance unit) as a start point and an income flow to see how the water will flood the territory.
## Installation
With pip `pip install mfdfloods`
From source `python -m pip install -r /path/to/mfdfloods/directory`
## Dependencies
The script requires GDAL installed on your system and python-gdal as a python dependency.
To install GDAL execute `apt install gdal-bin libgdal-dev`.
## Module
Execute .py from inside the folder to test the algorithm.
The test.py is a script that call the class MFD and execute its modelization with
the datasource from the `data/` folder. There you have to place your GeoJSON files
with the modelized line geometry.
`python test.py <path:data> <lng:float> <lat:float>`
Arguments:
1. **data** is the pathname of the data directory. There you have to place a
`dtm.tif`, a `mannings.tif` and a `hydrogram.csv` files.
2. **lng** is the longitude in your reference dtm distance units.
3. **lat** is the latitude in your reference dtm distance units.
The output will be placed in your **data** floder as three files with the name _(draft|flood|speed)\_{lng}-{lat}.tif_.
## Use
Include mfdfloods as a module on your scripts with `from mfdfloods import MFD` then instantiate the class MFD to execute its drainpaths method.
Raw data
{
"_id": null,
"home_page": "",
"name": "mfdfloods",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "mfdfloods,mfd,flood,drainpaths,hidrology,downstreams,multiple flow direction",
"author": "",
"author_email": "Orzo Cogorzo <orzocogorzo@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8d/d4/35696541302cf3a6e7f903224c11212e0f0196d8415a79c758afc412e820/mfdfloods-0.1.28.tar.gz",
"platform": null,
"description": "# MFD Floods\n\nA python script to model hidrologic behavior of downstream drainpaths. With a DTM cover of your study area you can define longitude and latitude (in the DTM distance unit) as a start point and an income flow to see how the water will flood the territory.\n\n## Installation\n\nWith pip `pip install mfdfloods`\n\nFrom source `python -m pip install -r /path/to/mfdfloods/directory`\n\n## Dependencies\n\nThe script requires GDAL installed on your system and python-gdal as a python dependency.\n\nTo install GDAL execute `apt install gdal-bin libgdal-dev`.\n\n## Module\n\nExecute .py from inside the folder to test the algorithm.\n\nThe test.py is a script that call the class MFD and execute its modelization with\nthe datasource from the `data/` folder. There you have to place your GeoJSON files\nwith the modelized line geometry.\n\n`python test.py <path:data> <lng:float> <lat:float>`\n\nArguments:\n\n1. **data** is the pathname of the data directory. There you have to place a\n `dtm.tif`, a `mannings.tif` and a `hydrogram.csv` files.\n2. **lng** is the longitude in your reference dtm distance units.\n3. **lat** is the latitude in your reference dtm distance units.\n\nThe output will be placed in your **data** floder as three files with the name _(draft|flood|speed)\\_{lng}-{lat}.tif_.\n\n## Use\n\nInclude mfdfloods as a module on your scripts with `from mfdfloods import MFD` then instantiate the class MFD to execute its drainpaths method.\n",
"bugtrack_url": null,
"license": "",
"summary": "Multiple flow direction floods hydrodynamic modelation",
"version": "0.1.28",
"split_keywords": [
"mfdfloods",
"mfd",
"flood",
"drainpaths",
"hidrology",
"downstreams",
"multiple flow direction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95c3f4f48c7026f672630b8d3789563d43e0c7a06d603026c37edffcaf963286",
"md5": "8395f41907cb5c76aebb11a691ae3206",
"sha256": "f1441b236347314c1f4c0ecdaa4b2d10d2dbba0e1a9d684ca807d9861c3f2cb8"
},
"downloads": -1,
"filename": "mfdfloods-0.1.28-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8395f41907cb5c76aebb11a691ae3206",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10956,
"upload_time": "2023-02-08T19:08:43",
"upload_time_iso_8601": "2023-02-08T19:08:43.615577Z",
"url": "https://files.pythonhosted.org/packages/95/c3/f4f48c7026f672630b8d3789563d43e0c7a06d603026c37edffcaf963286/mfdfloods-0.1.28-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8dd435696541302cf3a6e7f903224c11212e0f0196d8415a79c758afc412e820",
"md5": "5c8e0bcda7e462e362534512d02b38c8",
"sha256": "1f5e4dd191aaec60199909b31c3feb3a0697039e7937b6fd88357159be18b9d1"
},
"downloads": -1,
"filename": "mfdfloods-0.1.28.tar.gz",
"has_sig": false,
"md5_digest": "5c8e0bcda7e462e362534512d02b38c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10274,
"upload_time": "2023-02-08T19:08:45",
"upload_time_iso_8601": "2023-02-08T19:08:45.677418Z",
"url": "https://files.pythonhosted.org/packages/8d/d4/35696541302cf3a6e7f903224c11212e0f0196d8415a79c758afc412e820/mfdfloods-0.1.28.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 19:08:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "mfdfloods"
}
JSON