rivers2stratigraphy 0.1.2

educational activity for teaching how rivers become stratigraphy

Rivers to stratigraphy

Explore how a river becomes stratigraphy.

This readme file provides an overview of the installation and setup process, as well as a brief description of the module worksheets available.

This repository is also linked into the SedEdu suite of education modules, and can be accessed there as well.

Installation and running the module

Visit the section of the text below for more information on installing and executing the rivers2stratigraphy program on your computer.

Requirements

This module depends on Python3, and the libraries numpy, matplotlib, and shapely.

Anaconda installation

It is recommended that you install Anaconda, which is an open source distribution of Python. It comes with many basic scientific libraries, some of which are used in the module. Anaconda can be downloaded at https://www.anaconda.com/download/ for Windows, macOS, and Linux. Please follow the instruction provided in the website as to how to install and setup Python on your computer.

Custom Python installation

If you want a more flexible and lightweight Python distribution, you can use whatever your favorite package manager is distributing (e.g., homebrew or apt), check the Windows downloads here, or compile from source.

Whatever method you choose, you will need to install the dependencies. installation by pip is easiest, and probably supported if you used anything but compiling from source.

Download the source code

grab the zip

You can download this entire repository as a .zip by clicking the "Clone or download button on this page", or by clicking here to get a .zip folder. Unzip the folder in your preferred location.

git

If you have installed git and are comfortable working with it, you can simply clone the repository to your preferred location.

git clone https://github.com/amoodie/rivers2stratigraphy.git

Run the module

Run the module by command line, with

python3 <path-to-the-repo-folder>/src/rivers2stratigraphy.py