Scabbard

Python package to design, use or visualise topographic analysis, landscape evolution models and hydro/morphodynamics simulations. Among other, home of GraphFlood (CPU and GPU) and CHONK. This framework is also building a GPU backend for general purpose landscape modeling.

Built on the shoulder of giants

scabbard started as a personal codebase and evolved toward a fully-fledge numerical Framework. It uses the robust and battle-tested scientific python stack (e.g. numpy, scipy, numba, ...) and geospatial python (e.g. rasterio, geopandas, libgdal, ...). It also relies on multiple domain-specific libraries to built a future-proof and community-compatible backend: libtopotoolbox and pytopotoolbox, fastscapelib, LSDTopoTool as well as my own collection of c++ and numba routines. All the GPU backends use taichi to ensure cross-platform/hardware compatibility and user-friendly code.

• Free software: MIT license

How to install

I am currently working on an easier installation process. In the meantime, using a conda environment:

mamba install numpy scipy matplotlib ipympl jupyterlab rasterio numba cmcrameri plotly nicegui daggerpy pip geopandas
pip install taichi pyscabbard

You also need to follow the installation procedure of pytopotoolbox.

Usage

TODO

Features

• TODO

Credits

This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage

======= History

0.0.5 - 0.0.7 (2024-10-15)

• Total refactoring. As Simple as that
• scabbard is the main tool now, it uses multiple backends DAGGER, pytopotoolbox, fastscapelib, numba and taichi

0.0.3 - 0.0.4 (2023-10-23)

• Fixing couple of bugs on the grid
• Experimental support for DAGGER's experimental stuff
• Adding environment object (WIP, future main structure)

0.0.2 (2023-07-31)

• Adding drainage divide quick extraction tools
• Fixing sea_level/Z0 stuff

0.0.1 (2023-07-25)

• First release on PyPI.
• Adding tools for quick river extraction
• Started a big behind-the-scene refactoring and standardisation (invisible at top level)
• Maintenance and bug fixes