Light

deltares-research / pydrever Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 2.0 7.14 MB

Python toolbox to interact with DiKErnel

License: GNU Lesser General Public License v3.0

Python 100.00%

pydrever's Introduction

pydrever

A toolbox for analysis of dike revetments and erosion.

Features

Pydrever exposes tools that can help assessing the safety of dikes. The toolbox contains a toolset for those interested in failure of the dike revetment and erosion of the core of the dike or levee thereafter. As such, pydrever amongst others offers a python interface to the C# based DiKErnel with which the amount of damage to the revetment of a dike during a storm can be calculated.

The main structure of the toolbox contains 4 packages:

pydrever.data, providing data classes that can be used to handle die schematizations, calculation input and output or to schematize storm surges.
pydrever.io, providinga reader for *.prfl files.
pydrever.calculation, primarily exposing DiKErnel.
pydrever.visualization, containing various functions that draw standard figures based on calculation input or results.

How to install the toolbox?

The package is available at pip. To install the package, run:

'pip install pydrever'

Where to find information about pydrever?

Full documentation of the toolbox still needs to be created. However, the repository already contains several tests and examples (in the form of Jupyter notebooks) that show how to use the toolbox in different ways:

Credits

Pieter van Geer [email protected]

pydrever's People

Contributors

Stargazers

Watchers

Forkers

peter-van-tol yida-tao

pydrever's Issues

Add possibility to specify settings per location/zone (and override general settings or Dikernel defaults)

Include validation messages when building C# input

Read *.prfl file

Add automated testing on github

Uniform naming of settings and toplayer specification classes

Use uniform naming everywhere. For example, why do we use "GrassWaveOvertoppingCalculationSettings" and "GrasCoverCumulativeOverloadTopLayerSettings"?

Write notebook on prfl reader

Write notebook for grass runup calculation

Decide on name and rename if necessary

Rename to: dike-revetment-erosion and import to either: drever or dre

Adjust folder name in repos and fix all dependencies
Adjust imports / descriptions in notebooks and tests

Rename "Hydraulic" to "Hydrodynamic"

Add damage contour plot (damage level = y, time = x)

Use Pydantic for data classes

Add damage contour plot (damage level = y, time = x)

write notebook for natural stone calculation

Specify revetment zones

Write notebook for grass impact calculation

Move dike orientation to DikeSchematization

Refactor output parser

Such that it does not define a class with only static methods. Preferrably place utils functions in the module file itself.

Combine output time steps

Expose calculation of stance time lines

Use
DiKErnel.FunctionLibrary.GrassWaveImpact.GrassWaveImpactFunctions functions

Rename github page to "pydrever"

Rename github page to "pydrever" instead of "dike-revetment-erosion-pytools". This will increase findability.

Write notebook for asphalt calculation

Test pydrever on linux and add to toml if possible

Add runup calculations to the output specifications

call validate first before terminating run

Change settings into schematization variables

Two parameters that are listed under settings (AsphaltCalculationSettings) are actually schematization parameters and should be part of AsphaltLayerSpecification:

fatigue_asphalt_alpha
fatigue_asphalt_beta

Move these parameters

Create notebook on visualization

Create pydrever 0.9 branch and release tag for support purposes (if necessary)

Create a 0.9 release branch
Create a release tag of the current release
Add release to github page
Change version in master to 1.0.0

Add BGD DeltaFlume experiment calculation to the test folder

Create python package

Check all documentation
Create release branch
Create package
Create release tag
Upload package
Update version number on master

move repos to correct location

Create notebook on specification of settings.

Combine calculations and results for grass cover revetments (wave impact and runup)

Change tests to notebooks

Rename outputlocation namespace to outputspecification

Move all packages under 1 namespace if possible

Refactor ouput location specification

write notebook for GEKB calculation

Write unit tests

Remove dubplicated input arguments for asphalt

Asphalt output specifications contains duplicated input parameters alpha, beta and nu. These should be removed.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.