boreflow
Python package to simulate the flow of overtopping and bores.
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.0%) to scientific vocabulary
Repository
Python package to simulate the flow of overtopping and bores.
Basic Info
- Host: GitHub
- Owner: nielsvandervegt
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://nielsvandervegt.github.io/boreflow
- Size: 2.57 MB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 8
Metadata Files
README.md
BoreFlow
The Python package BoreFlow provides a simple numerical model using Steep-Slope Shallow Water Equations to describe the flow of overtopping waves and bores.
This Python package is developed as part of the Ph.D. research of Niels van der Vegt and is published under the GNU GPL-3 license.
Getting started
To download the package run pip install boreflow
```py import numpy as np
from boreflow import BCArray, Geometry, Simulation
1) Create geometry
geometry = Geometry([0, 2, 11], [3, 3, 0], [0.0175, 0.0175])
2) Create boundary conditions
t = np.array([0, 1, 5]) h = np.array([0.5, 0.8, 0]) u = np.array([1.0, 2.0, 0]) bc = BCArray(t, h, u)
3) Initialize simulation settings
sim = Simulation(tend=10.0, cfl=0.2, maxdt=0.01, nx=110)
4) Run the simulation
results = sim.run(geometry, bc)
5) Analyse the flow, e.g. at s=10m
rest, resh, resu = results.getst(s=10.0) ```
Getting started
Using install
run pip install boreflow
Developing with pixi
To manage the environment we use Pixi.
Windows
powershell
iwr -useb https://pixi.sh/install.ps1 | iex
Linux/Mac
bash
curl -fsSL https://pixi.sh/install.sh | bash
Installing
With the Pixi command in powershell install the python environment:
bash
cd ../boreflow
pixi install
The pixi.lock file loads the correct packages and downloads to the .pixi file, you can use this environment in developing and resting.
For questions about how to use this package contact n.vandervegt@utwente.nl / n.vandervegt@hkv.nl.
Acknowledgements
The authors would like to thank the researchers who have conducted studies on overtopping flow. All studies are referenced in the code of the respective boundary condition implementations. Furthermore, we acknowledge the publication by Maranzoni and Tomirotti (2022) for their publication regarding the Steep-Slope Shallow Water Equations.
This work is part of the Perspectief research programme Future Flood Risk Management Technologies for Rivers and Coasts with project number P21-23. This programme is financed by Domain Applied and Engineering Sciences of the Dutch Research Council (NWO).
HKV Lijn in Water is acknowledged for their Python package template, which is used to publish this package.
Owner
- Name: Niels van der Vegt
- Login: nielsvandervegt
- Kind: user
- Repositories: 1
- Profile: https://github.com/nielsvandervegt
Citation (CITATION.cff)
# YAML 1.2
---
cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: BoreFlow
abstract: Python package to simulate the flow of overtopping and bores.
authors:
-
affiliation: University of Twente, HKV lijn in water
family-names: Van der Vegt
given-names: Niels
orcid: https://orcid.org/0009-0004-9542-0979
version: 0.1.2
date-released: 2025-04-18
keywords:
- Numerical modelling
- Wave overtopping
license: "GPL-3.0-or-later"
repository-code: "https://github.com/nielsvandervegt/boreflow"
GitHub Events
Total
- Release event: 4
- Delete event: 1
- Public event: 1
- Push event: 46
- Create event: 7
Last Year
- Release event: 4
- Delete event: 1
- Public event: 1
- Push event: 46
- Create event: 7
Packages
- Total packages: 1
-
Total downloads:
- pypi 194 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 7
- Total maintainers: 1
pypi.org: boreflow
Python package to simulate the flow of overtopping and bores.
- Documentation: https://nielsvandervegt.github.io/boreflow
- License: GNU-GPL V3
-
Latest release: 0.1.2
published 7 months ago