Metadata-Version: 2.1
Name: fastscape
Version: 0.1.0
Summary: A fast, versatile and user-friendly landscape evolution model
Author-email: Benoît Bovy <benbovy@gmail.com>
Maintainer: Fastscape contributors
License: BSD-3-Clause
Project-URL: Documentation, https://fastscape.readthedocs.io
Project-URL: Repository, https://github.com/fastscape-lem/fastscape
Keywords: simulation,toolkit,modeling,landscape,geomorphology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: xarray-simlab>=0.5.0
Requires-Dist: numba
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"

Fastscape
=========

|Build Status| |Doc Status| |Zenodo|

A fast, versatile and user-friendly landscape evolution model.

Fastscape is a Python package that provides a lot a small model
components (i.e., processes) to use with the xarray-simlab_ modeling
framework. Those components can readily be combined together in order
to create custom Landscape Evolution Models (LEMs).

Routines from the fastscapelib_ library are used for fast model
execution.

.. |Build Status| image:: https://github.com/fastscape-lem/fastscape/actions/workflows/tests.yml/badge.svg?branch=master
   :target: https://github.com/fastscape-lem/fastscape/actions/workflows/tests.yml
   :alt: Build Status
.. |Doc Status| image:: https://readthedocs.org/projects/fastscape/badge/?version=latest
   :target: https://fastscape.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. |Zenodo| image:: https://zenodo.org/badge/133702738.svg
   :target: https://zenodo.org/badge/latestdoi/133702738
   :alt: Citation

.. _xarray-simlab: https://github.com/benbovy/xarray-simlab
.. _fastscapelib: https://github.com/fastscape-lem/fastscapelib-fortran

Documentation
-------------

Documentation is hosted on ReadTheDocs:
https://fastscape.readthedocs.io

License
-------

3-clause ("Modified" or "New") BSD license. See the LICENSE file for details.

Acknowledgment
--------------

Fastscape is developed at the `Earth Surface Process Modelling`__ group of
the GFZ Helmholtz Centre Potsdam.

__ http://www.gfz-potsdam.de/en/section/earth-surface-process-modelling/

Citing fastscape
----------------

If you use xarray-simlab in a scientific publication, we would
appreciate a `citation`_.

.. _`citation`: http://fastscape.readthedocs.io/en/latest/cite.html
