SEOLAB

Seashore Erosion modelling framework built in xarray-simLAB

SEOLAB is a Python-based modelling framework for simulating the long-term evolution of rocky coastlines. It is designed to benchmark different coastal erosion models under consistent settings, making it easy to compare model behaviours and test new erosion laws within the same workflow.

Installation

pip install SEOLAB

Features

• Modular process-based architecture built on xarray-simlab
• Pre-built erosion models (Simple, Anderson, Scape) with optional salt weathering
• xarray-based interface for simulation setup, execution, and output
• Extensible — plug in your own erosion model with minimal code

Documentation

Full tutorials are available at: https://GoldDH.github.io/SEOLAB

Quick Start

import xsimlab as xs
import numpy as np
from SEOLAB.models import model_simple_salt

ds_in = xs.create_setup(
    model=model_simple_salt,
    clocks={'time': np.arange(0, 1_000_000, 100)},
    master_clock='time',
    input_vars={
        'grid__dx': 10,
        'grid__length': 10000,
        ...
    },
    output_vars={
        'topo__elevation': 'time',
    }
)

ds_out = ds_in.xsimlab.run(model=model_simple_salt)

Citation

If you use SEOLAB in your research, please cite:

Keum, D. (in prep). SEOLAB: A modular framework for rocky coastline evolution modelling.

License

MIT