Skip to content

Scabbard is a python toolbox for topographic analysis, hydrodynamics and landscape evolution modelling using DAGGER as backend

License

Notifications You must be signed in to change notification settings

bgailleton/scabbard

Repository files navigation

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

If you are comfortable with conda environments: within your environment of choice, conda/mamba install daggerpy -c conda-forge then pip install topotoolbox pyscabbard.

Else:

First you need a conda environment to install the daggerpy backend. See here for instructions. Once installed, open a prompt (terminal, conda prompt, miniforge prompt, ... you know it is the right one if (base) is written at the left.).

Then run ONCE these instructions sequentially:

conda create -n scabbard conda activate scabbard conda install install daggerpy -c conda-forge pip install pyscabbard pytopotoolbox

Each time you restart a new terminal, you will just need to reactivate the environment: conda activate scabbard .

Done!

Features

  • General geomorphic routines

  • Graphflood: Efficient hydrodynamic modelling, tailored for large scale. CPU and GPU version.

  • CHONK/trackscape/popscape: Long term Landscape Evolution Models.

Usage

Documentation is WIP and will be online soon

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

About

Scabbard is a python toolbox for topographic analysis, hydrodynamics and landscape evolution modelling using DAGGER as backend

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •