No project description provided
Project description
FM2PROF
Python package to create 1D river models from 2D river models.
Introduction
FM2PROF is a Python package to help create 1D models from 2D models. It's primarily built for river systems, but has been applied to lakes as well.
The main purpose of FM2PROF is to generate 1D cross-sections and roughness tables using information from a 2D model. Users should provide
Supported software
FM2PROF currently works with the following model software systems and versions
Type | Supported |
---|---|
1D models | SOBEK 3.6+ |
2D model | Delft3D Flexible Mesh 2019+ |
Getting started & Documentation.
You can find the documentation here: https://deltares.github.io/fm2prof/.
Development
- We enforce black formatting on push. So after pushing, pull to get the reformatted code, or do a black reformat locally.
- Direct commits to master are not allowed (except for admins). To work on an issue, make a branch, do all your commits there, then create a pull request for review.
- We use commitizen tools to bump version. Version bump is done manually after a pull request. E.g. after a minor improvement:
# first do a dry run to test
poetry run cz bump --increment MINOR --dry run
# then for real
poetry run cz bump --increment MINOR
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fm2prof-2.2.8.tar.gz
(87.5 kB
view hashes)
Built Distribution
fm2prof-2.2.8-py3-none-any.whl
(95.0 kB
view hashes)