Metadata-Version: 2.4
Name: SEOLAB
Version: 0.1.0
Summary: Seashore Erosion modelling framework built in xarray-simLAB
Author-email: Duhwan Keum <duhwan.keum@gfz.de>
License: MIT
Project-URL: Homepage, https://github.com/GoldDH/SEOLAB
Project-URL: Repository, https://github.com/GoldDH/SEOLAB
Keywords: geomorphology,coastal erosion,xarray,modelling
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: xarray-simlab
Requires-Dist: xarray<2024
Requires-Dist: numpy<2
Requires-Dist: pandas<2
Requires-Dist: zarr<3
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: cmcrameri

# SEOLAB

**S**eashore **Er**osion modelling framework built in xarray-sim**LAB**

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

```bash
pip install SEOLAB
```

## Features

- Modular process-based architecture built on [xarray-simlab](https://xarray-simlab.readthedocs.io/)
- 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

```python
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
