Methods¶
Eco-morphological Connectivity¶
Lateral and vertical connectivity (University of Stuttgart)
More coming soon
Code Documentation¶
This section will be filled with codes products.
Data¶
Small Datasets (<100MB)¶
Smaller and test datasets for application examples will be provided on GitHub repositories with instructions on how to use the data with algorithms from this project.
Large Datasets (>100MB)¶
Large datasets will be hosted on the independent educational, and state-funded bwSync&Share platform. To get read and write access to the large file repository, email Sebastian.
Instructions¶
Create new Code¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | """This is the example_solver.py script for solving 1D hydraulics."""
import math as m
def calc_discharge(b, h, m_bank, S, k_st=None, n_m=None, D_90=None):
"""
Calulate discharge in SI units. Provide one of the optional parameters k_st, n_m, or D_90.
Arguments:
b (float): width (m)
h (float): depth (m)
m_bank (float): bank slope (-)
S (float): slope (-)
k_st (float): Strickler roughness (optional)
n_m (float): Manning roughness (optional)
D_90 (float): D90 for roughness (optional)
Returns:
``float`` of discharge in CMS
"""
|
How to add new package or library imports:
Add it to the global import management file (ROOT/import_mgmt.py) within an try-except-ImportError statement (read more).
If you need to import a library or package that is not yet listed in the ROOT/environments.yml and ROOT/requirements.txt files, please make sure to add the new library or package in both files.
Add the new library or package to the
autodoc_mock_importslist in ROOT/docs/conf.py.Update the version number according to the CONTRIBUTING standards.
Please use PEP 8 for any code (read more on hydro-informatics.github.io/hypy_pystyle) and try to keep the number of lines per script below 150 (it’s hard or even apparently impossible sometimes - just try please).
To learn more about Python coding in general, visit the teaching website from the hydro-morphodynamics research group of the IWS: hydro-informatics.github.io.
Download and Upload Project Code¶
Start with downloading (i.e., pull or clone) the project repository to your local computer.
Windows Users
Download and install Git Bash. Linux users will most likely not need to install git because it is inherently part of the system tools.
Then open Git Bash (on Windows) or Terminal (on Linux or MacOS) and tap (replace capital letters with your target directory):
cd TARGET/DIRECTORY/
git clone https://github.com/sschwindt/econnect.git
cd econnect
Now, the source code for this website and the above shown example-solver.py script are copied to your local computer. To make changes in the code or to modify any existing file, you will need to become a contributor of this repository and you will need to email Sebastian to get the required read & write rights. Once you are a contributor, edit, add, or remove scripts and files in your local TARGET/DIRECTORY/econnect/ (corresponds to ROOT) folder. Consider to create a new subfolder in ROOT/codes/ and save your code there locally (basically in any programming language). Then, upload, or push new code:
git add .
git commit -m "ADD AN ACTIVE-VOICED MESSAGE IN SIMPLE PAST"
git pull --rebase
git push
If you encounter an error or warning after running git pull --rebase, that means someone else has been editing the file at the same time. No worry about that, git will guide you through troubleshooting: Just open the concerned file and manually fix the indicated code blocks (indicator: <<< and >>> signs). Then follow the commands that GitBash or Terminal suggest you to use. To read more about git, visit https://hydro-informatics.github.io/hy_git.html.
Important
Only push debugged code - Thank you!
What is the goal of this approach?
Using git enables version control and collaborative development of algorithms. Following coding standards (e.g., PEP8 styles), and with the help of git, the project results will be transparent, re-usable, safely stored, and accessible for anyone interested. Eventually, we want to provide the project results as a pip-hosted Python package to leverage universal use of the project achievements along with coherent and understandable documentation.
How the Code Docs work¶
The automated code documentation of Sphinx ReadTheDocs automatically parses functions and classes for docstrings and implements them in the documentation. Python code docs are implemented via google style of docstrings in scripts. Please familiarize with the style format and strictly apply in all commits.
To implement code documentations:
Save the file in
ROOT/codes/(example:ROOT/codes/example_solver.py).Add a new section (create a new
~~~header for single scripts/modules and a===header for new packages).In the new header add the following:
.. automodule:: script-name (without.py at the end)
:members:
Example¶
This is the example_solver.py script for solving 1D hydraulics.
-
example_solver.calc_discharge(b, h, m_bank, S, k_st=None, n_m=None, D_90=None)[source]¶ Calulate discharge in SI units. Provide one of the optional parameters k_st, n_m, or D_90.
-
example_solver.interpolate_h(Q, b, S0, m_bank=1.0, n_m=0.04, prec=0.001, **kwargs)[source]¶ Inverse calculation of normal water depth for a given discharge and channel geometry uses Raphson-Newton Algorithm
- Parameters
Q (float) – of target discharge in (m3/s)
b (float) – of channel base width in (m)
S0 (float) – of channel (energy) slope is (m/m)
m_bank (float) – of channel bank inclination (dimensionless), default=1.0
n_m (float) – of Manning’s n, default=0.04
prec (float) – of result precision (don’t be too picky)
kst (float) – of Strickler value supersedes n_m
d90 (float) – of surface grain size supersedes n_m
- Returns
floatof flow depth in M
More about Sphinx & ReadTheDocs¶
This page uses Sphinx readthedocs and the documentation regenerates automatically after pushing changes to the repositories main branch.
To set styles, configure or add extensions to the documentation use ROOT/.readthedocs.yml and ROOT/docs/conf.py.
To modify this documentation file, edit ROOT/docs/index.rst (uses reStructuredText format).
For local builds of the documentation, the following packages are required:
sudo apt install build-essential
sudo apt install python-dev python-pip python-setuptools
sudo apt install libxml2-dev libxslt1-dev zlib1g-dev
apt-cache search libffi
sudo apt install -y libffi-dev
sudo apt install python3-dev default-libmysqlclient-dev
sudo apt install python3-dev
sudo apt install redis-server
To generate a local html version of the documentation, cd into the docs directory and type:
make html
Learn more about Sphinx documentation and the automatic generation of Python code docs through docstrings in the tutorial provided at github.com/sschwindt/docs-with-sphinx.