Model:Pybeach

Pybeach

This code has been community reviewed and published in the open access Journal of Open Source Software (JOSS)

Also known as
Model type	Single
Model part of larger framework
Note on status model
Date note status model

Incorporated models or components:

Spatial dimensions
Spatial extent
Model domain	Coastal
One-line model description	A Python package for extracting the location of dune toes on beach profile transects
Extended model description	pyBeach is an open-source Python package for automatically detecting dune toe locations on 2D cross-shore beach profile transects, motivated by the explosion of coastal topographic data from LiDAR and remote sensing that makes manual expert analysis infeasible. It consolidates three existing geometric algorithms (maximum curvature, relative relief, and perpendicular distance) into a single package and adds a novel machine learning method based on Random Forest classification, which outperformed all other methods when tested on 200 unseen profiles. The ML approach is notable for outputting a probability distribution along the profile rather than a single point, giving users additional insight into beach morphology and uncertainty in the dune toe location.

Keywords:

Name	Thomas Beuzen
Type of contact	Model developer
Institute / Organization	University of British Columbia
Postal address 1
Postal address 2
Town / City	Vancouver
Postal code	V6T 1Z4
State
Country	Canada
Email address	tomas.beuzen@stat.ubc.ca
Phone
Fax

Supported platforms	Unix, Linux, Mac OS, Windows
Other platform
Programming language	Python
Other program language
Code optimized	Single Processor
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development	2018
Does model development still take place?	No
If above answer is no, provide end year model development	2021
Code development status	As is, no updates are provided
When did you indicate the 'code development status'?	2026
Model availability	As code
Source code availability (Or provide future intension)	Through web repository
Source web address	https://github.com/TomasBeuzen/pybeach/tree/master
Source csdms web address
Program license type	BSD or MIT X11
Program license type other
Memory requirements	--
Typical run time	--

Describe input parameters	Two NumPy arrays passed directly in Python code: an array of cross-shore coordinates x of shape (m,) and a corresponding array of elevations z of shape (m,) for a single profile, or shape (m, n) for n profiles sharing the same cross-shore coordinates.
Input format	ASCII
Other input format
Describe output parameters	The outputs are NumPy arrays: indices or cross-shore positions indicating the predicted dune toe location, and optionally the dune crest and shoreline locations. The ML method additionally outputs a probability distribution (array of probabilities) across the profile.
Output format	ASCII
Other output format
Pre-processing software needed?	No
Describe pre-processing software
Post-processing software needed?	No
Describe post-processing software
Visualization software needed?	No
If above answer is yes
Other visualization software

Describe processes represented by the model	See Beuzen 2019 JOSS publication
Describe key physical parameters and equations	See Beuzen 2019 JOSS publication
Describe length scale and resolution constraints	--
Describe time scale and resolution constraints	--
Describe any numerical limitations and issues	--

Describe available calibration data sets
Upload calibration data sets if available:
Describe available test data sets
Upload test data sets if available:
Describe ideal data for testing

Do you have current or future plans for collaborating with other researchers?

Is there a manual available?	Yes
Upload manual if available:	Media:https://pybeach.readthedocs.io/en/latest/
Model website if any	https://pybeach.readthedocs.io/en/latest/
Model forum / discussion board

Comments

This part will be filled out by CSDMS staff

Can be coupled with:

Model info

Authors

Thomas Beuzen

Source code

Model citations

QR-code

Link to this page

Other models by author

No results