gospl documentation

Date: Dec 20, 2021 Version: 0.3.2

Useful links: Binary Installers | Source Repository | Issues & Ideas | Q&A Support | Mailing List

gospl (short for Global Scalable Paleo Landscape Evolution and pronounced: /ˈɡospel/, [ˈɡo̞s̠pe̞l]) is an open source, GPL-licensed library providing a scalable parallelised Python-based numerical model to simulate landscapes and basins reconstruction at global scale. gospl is developed by the EarthCodeLab Group at the University of Sydney.

Statement of need

Since the ’90s, many software have been designed to estimate long-term catchment dynamic, drainage evolution as well as sedimentary basins formation in response to various mechanisms such as tectonic or climatic forcing. These models rely on a set of mathematical and physical expressions that simulate sediment erosion, transport and deposition and can reproduce the first order complexity of Earth’s surface geomorphological evolution.

Yet, we were still missing a tool to evaluate global scale evolution of Earth surface and its interaction with the atmosphere, the hydrosphere, the tectonic and mantle dynamics. gospl is the first model designed to address this gap. It can be used to better characterise many aspects of the Earth system ranging from the role of atmospheric circulation on physical denudation, from the influence of erosion and deposition of sediments on mantle convection, from the location and abundance of natural resources to the evolution of life.

Quick links to the Doc

Getting started

New to gospl? Check out the getting started guides. They contain an introduction to the code installation.

To the getting started guides

Technical guide

The technical guide provides in-depth information on the underlying physics of gospl.

To the technical guide

User guide

Learning how to use gospl by running some pre- and post processing examples available as Jupyter notebooks.

To the user guide

API reference

This guide contains a detailed description of gospl API. It describes how methods work and functions have been declared.

To the reference guide

Citing

To cite gospl please use following software paper published in the JOSS.

Salles et al. (2020) ’gospl: Global Scalable Paleo Landscape Evolution’, Journal of Open Source Software, 5(56), p. 2804. doi: 10.21105/joss.02804.

BibTeX:

@article{salles_2020,
    author={Salles, Tristan and Mallard, Claire and Zahirovic, Sabin},
    title={gospl: Global Scalable Paleo Landscape Evolution},
    journal={Journal of Open Source Software},
    year={2020},
    volume={5},
    number={56},
    pages={2804},
    DOI={10.21105/joss.02804}
}

Contributing to gospl

Contributions of any kind to gospl are more than welcome. That does not mean new code only, but also improvements of documentation and user guide, additional tests (ideally filling the gaps in existing suite) or bug report or idea what could be added or done better.

All contributions should go through our GitHub repository. Bug reports, ideas or even questions should be raised by opening an issue on the GitHub tracker. Suggestions for changes in code or documentation should be submitted as a pull request. However, if you are not sure what to do, feel free to open an issue. All discussion will then take place on GitHub to keep the development of gospl transparent.

If you decide to contribute to the codebase, ensure that you are using an up-to-date master branch. The latest development version will always be there, including the documentation (powered by sphinx).

Details are available in the contributing guide.

next

Getting started