eSCAPE is a parallel TIN-based landscape evolution model, built to simulate topography dynamic at various space and time scales. The model accounts for hillslope processes (soil creep using linear diffusion), fluvial incision (stream power law), spatially and temporally varying tectonics (horizontal & vertical displacements) and climatic forces (temporal and spatial precipitation changes and/or sea-level fluctuations).
For installation information and documentation visit our github eSCAPE-model website or the wiki page which provides a quick guide on the installation dependencies and Docker settings.
API documentation is available from the eSCAPE-API website.
A set of examples are available in the eSCAPE-demo repository.
The easiest way to get started is with the Docker container https://hub.docker.com/u/geodels/ using Kitematic. Once Kitematic is installed on your computer, open it and look for Geodels escape-docker via the search menu.
If you want to install it yourself, you can follow the steps provided in the wiki page.
The model is based on the following approaches:
- an adaptation of the implicit, parallelizable method for calculating drainage area for both single (D8) and multiple flow direction (Dinf) from Richardson & Perron (2014),
- the methods developed in pyBadlands (Salles et al. (2018)) for marine sedimentation.
To join the eSCAPE User Group on Slack, send an email request to: Join eSCAPE User Group
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/lgpl-3.0.en.html.
1- Scientific computing libraries:
2- Reading/Writing/Parsing libraries:
To use/test eSCAPE quickly, it is recommended to use the Geodels escape-docker image that is shipped with all the required libraries.
https://hub.docker.com/u/geodels/
Once the libraries mentioned above have been installed, eSCAPE will need to be cloned and compiled using the following:
git clone https://github.com/Geodels/eSCAPE.git
python setup.py installAn example on how to install it on a HPC server is provided in the wiki page.
A test model is available in the eSCAPE-demo repository and can be used to test your eSCAPE installation. It provides two comparisons related to:
- the expected values that you should obtained if your installation is successful
- runtime for both serial and parallel simulations
This test should take less than 1 minute. An example on how to visualise eSCAPE outputs in Paraview is also provided.
The code parallelisation relies on petsc and scalability tests are still on-going. Our goal is to be able to run models with more than 10 millions nodes and over several hundreds of CPUs.
To get some additional info in regards to how to use eSCAPE a series of examples and tutorials is provided in the docker container (escape-docker) and is also available for download from the eSCAPE-demo repository.
We welcome all kinds of contributions! Please get in touch if you would like to help out. Everything from code to notebooks to examples and documentation are all equally valuable so please don't feel you can't contribute. To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.
If you found a bug, have questions, or are just having trouble with eSCAPE, you can:
- join the eSCAPE User Group on Slack by sending an email request to: Join eSCAPE User Group
- open an issue in our issue tracker and we'll try to help resolve the concern.