https://github.com/rom-py/rompy-xbeach

Rompy XBeach Config package
https://github.com/rom-py/rompy-xbeach

coastal-modelling currents modelling morphology nearshore pydantic python sediment-transport waves xbeach

Last synced: 5 months ago
JSON representation

Rompy XBeach Config package

• Host: GitHub
• URL: https://github.com/rom-py/rompy-xbeach
• Owner: rom-py
• License: bsd-3-clause
• Created: 2024-09-11T06:24:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-01-10T08:33:52.000Z (5 months ago)
• Last Synced: 2026-01-10T21:34:38.258Z (5 months ago)
• Topics: coastal-modelling, currents, modelling, morphology, nearshore, pydantic, python, sediment-transport, waves, xbeach
• Language: Python
• Homepage: https://rom-py.github.io/rompy-xbeach/
• Size: 1.71 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.rst
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
============

rompy-xbeach

============

.. image:: https://img.shields.io/pypi/v/rompy_xbeach.svg

    :target: https://pypi.python.org/pypi/rompy_xbeach

.. image:: https://img.shields.io/travis/rom-py/rompy_xbeach.svg

    :target: https://travis-ci.com/rom-py/rompy_xbeach

.. image:: https://readthedocs.org/projects/rompy-xbeach/badge/?version=latest

    :target: https://rompy-xbeach.readthedocs.io/en/latest/?version=latest

    :alt: Documentation Status

Rompy Xbeach Config package.

Features

--------

Grid

~~~~

* CRS aware grid object

* Ability to specify origin in different coordinate systems from the grid (e.g., lat/lon)

* Plotting supporting projections and high resolution coastlines

* Option to display the grid mesh

* Option to display the offshore boundary and origin

* Method to expand the grid boundaries

* Property methods to hold the cartopy stereographic projection and the transform

* shape property method

* Method to return Multipolygon geometry of all grid cells

* Method to save the grid to file

* Method to load the grid from file

Data

~~~~

* CRS aware

* Interpolator interface

* Modified source objects to support crs (rioxarray based)

* New custom Geotiff specific source

* New custom XYZ source supporting interpolation

* Seaward extension framework

* Lateral extension capability

Xarray Accessor

~~~~~~~~~~~~~~~

* Class method to create a xbeach dataset from model files

* Method to plot the bathymetry grid, profiles and slopes together

Questions

---------

* Support interpolate_na in the data objects? before or after interpolating the data?