Package: rivers2stratigraphy
rivers2stratigraphyExplore how a river becomes stratigraphyThis 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 theSedEdu suite of education modules, and can be accessed there as well.About the modelStratigraphic model based on LAB models, i.e., geometric channel body is deposited in "matrix" of floodplain mud.
The channel is always fixed to the basin surface and subsidence is only control on vertical stratigraphy.
Horizontal stratigraphy is set by 1) lateral migration (drawn from a pdf) and dampened for realism, and 2) avulsion that is set to a fixed value.Installing and running the moduleThis module depends on Python 3,tkinter, and the Python packagesnumpy,scipy,matplotlib, andshapely.Installing Python 3If you are new to Python, it is recommended that you install Anaconda, which is an open source distribution of Python which includes many basic scientific libraries, some of which are used in the module.
Anaconda can be downloaded athttps://www.anaconda.com/download/for Windows, macOS, and Linux.
If you do not have storage space on your machine for Anaconda or wish to install a smaller version of Python for another reason, see below on options for Miniconda or vanilla Python.Visit the website for Anacondahttps://www.anaconda.com/download/and select the installer for your operating system.Be sure to select the Python 3.x installation.Start the installer.If prompted, select to "install just for me", unless you know what you are doing.When prompted to add Anaconda to the path during installation, selectyesif youknowyou do not have any other Python installed on your computer; otherwise selectno.See below for detailed instructions on installingrivers2stratigraphyfor your operating system.Installing the moduleIf you installed Anaconda Python or Miniconda, you can follow the instructions below for your operating system.
Otherwise see the instructions for PyPi installation below.Pleaseopen an issueif you encounter any troubles installing or any error messages along the way!
Please include 1) operating system, 2) installation method, and 3) copy-paste the error.Windows usersOpen your "start menu" and search for the "Anaconda prompt"; start this application.Install with the module type the following command and hit "enter":conda install -c sededu rivers2stratigraphyIf asked to proceed, typeYand press "enter" to continue installation.
3. This process may take a few minutes as the necessary source code is downloaded.
If the installation succeeds, proceed below to the "Run the module" section.Note on permissions:you may need to run as administrator on Windows.Mac OSX and Linux usersLinux users:you will need to also installtkinterbefore trying to install the module below package throughcondaorpip3.
On Ubuntu this is done withsudo apt install python3-tk.Install the module by opening a terminal and typing the following command.conda install -c sededu rivers2stratigraphyIf asked to proceed, typeYand press enter to continue installation.This process may take a few minutes as the necessary source code is downloaded.
If the installation succeeds, proceed below to the "Run the module" section.Note on permissions:you may need to usesudoon OSX and Linux.Advanced user installationsTo install withpipfrom Pypi use (not recommended for entry-level users):pip3 install pyqt rivers2stratigraphySee below instructions for downloading the source code if you wish to be able to modify the source code for development or for exploration.Run the moduleOpen a Python shell by typingpython(orpython3) at the terminal (OSX and Linux users) or at the Conda or Command Prompt (Windows users).Run the module from the Python shell with:import rivers2stratigraphyInstructions will indicate to use the following command to then run the module:rivers2stratigraphy.run()Alternatively, you can do this in one line from the standard terminal with:python -c "import rivers2stratigraphy; rivers2stratigraphy.run()"Alternatively, run the module with provided script (this is the hook used for launching from SedEdu):python3 <path-to-installation>run_rivers2stratigraphy.pyPleaseopen an issueif you encounter any additional error messages!
Please include 1) operating system, 2) installation method, and 3) copy-paste the error.Smaller Python installation optionsNote that if you do not want to install the complete Anaconda Python distribution you can installMiniconda(a smaller version of Anaconda), or you can install Python alone and use a package manager called pip to do the installation.
You can getPython and pip together here.DevelopmentThe module requires occasional maintenance due to dependency updates.
If you are interested in contributing to the code-base please see below for instructions.If you are interested in contributing to the accompanying worksheets/activities (which would be greatly appreciated!) please seeWriting Activities for SedEduDownload the source codeYou can download this entire repository as a.zipby clicking the "Clone or download button on this page", or byclicking hereto get a.zipfolder.
Unzip the folder in your preferred location.If you have installedgitand are comfortable working with it, you can simply clone the repository to your preferred location.git clone https://github.com/sededu/rivers2stratigraphy.gitOpen a pull request when you want a review or some comments!