openearth / xbeach-toolbox

Collection of Python modules for pre- and postprocessing XBeach models and output files

About the xbeach-toolbox

Welcome to the xbeach-toolbox!

This package contains a set of general tools to setup and postprocess 1D and 2D XBeach models.

The tools have been written in Python, please see the sections below for further instructions.

Information about this package and its contents can also be viewed on:

https://xbeach-toolbox.readthedocs.io/en/latest/

Information about the use of the XBeach model itself can be found on:

https://xbeach.readthedocs.io/en/latest/.

Getting started / installation

Pip packages are hosted on the pypi server and can be installed using:

pip install xbTools.

Release notes

Release	notes
0.0.1	first testing of package on test.pypi
0.0.n	additional testing on test.pypi until release
1.0.0	first official release on pypi 🎉

Usage / examples

Basic examples have been added to the examples folder in the project.

For both a 1D and 2D simulation these python notebooks show how the tools can be used to setup a model.

Contributing

fork, issue, branch, commit, review, approve, merge

Contact

Menno de Ridder - [email protected]

Cas van Bemmelen - [email protected]

Marlies van der Lugt - [email protected]

xbeach-toolbox's Issues

problem plotting with posdwn = -1

error found in setup 1D and 2D example, if posdwn = -1 is used the domain plot that is generated is incorrect
suggest to change *self.posdwn to *-self.posdwn in the xbeachtools.py (both 1D and 2D)

domain plot is incorrect:

output is correct:

keep xbtools in local coordinate system

@MarliesA and @menno94 shall we keep the xbeach tools in a local coordinate system with the origin at x,y = 0,0 and let the end user rotate coordinates accordingly?

They could do that manually inside the XBeachModelSetup class without any problems (I have used this for quite a lot of models already).

The current implementation of world coordinates also does not make sense, as the coordinates shall also be transposed depending on the definition 'local' (for me this means origin at 0,0 😀)
e.g. L 594 xnew,ynew = rotate_grid(xr,yr,-alpha) should then also be transposed

floating point bugfix

@MarliesA I removed the floating point bugfix, this does not allow me to make 1D and 2D models using the examples ipynb

could you look into this?

# prevent very small grid sizes when floating point zero goes wrong for computing var distance!

cleanup xbeachtools

rearranging functions that do not necessarily belong in xbeachtools.py

collect dependencies of toolbox

@menno94 shall we use poetry (a .toml file) for the package management + publishing to the pypi server?
(using poetry in builds works quite nicely from gitlab and an internal pypi server)

make toolbox work again

syntax and docstring of XBeachModelAnalysis

@MarliesA could you have a look at the docstring of the functions in the XBeachModelAnalysis class?

I have added some dummy docstrings to the functions already, but it would be nice to have an explanation of the parameters and settings for each of the functions (docstring). If you could add this to #11 that would be nice

2D example not working

@menno94 somehow the 2D example does not provide wave height results in my test simulations.
Could you have a look at this?

checks and raises

• seaward extend: raise user error when required extension depth is > array where attachment is requested

merge /examples and /notebooks

/examples and /notebooks are in essence the same folders within this project. One uses .ipynb's whereas the other uses .py files. I propose to stick to the notebook examples as they also show the output

grid properties check

m/n-smoothness
aspect ratio
orthogonality

module grid not found

issue probably related to init.py

wave_function

Dispersion relation in wave_function.py are not modelled correctly

enhance _plotdomain function in xbeach class

include thetamin thetamax in domain plot

fix analysis

add general folder to store general functions / scripts

generate ygrid function not finished

function does not end with return ygr

XBeachModelAnalysis not working on 1D simulation example

Hi @MarliesA, currently I'm trying to do post processing on the 1D model using the simulation from https://github.com/openearth/xbeach-toolbox/blob/main/examples/xbeach-setup-1D.ipynb, but it seems like it's not working when I tried to get the model output, can you please check it out? thanks!

the error are as following, I've also ran xbeach.exe