educational activity for teaching how rivers become stratigraphy
Project description
rivers2stratigraphy
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 Python 3, tkinter
, and the Python packages numpy
, scipy
, matplotlib
.
Installing Python 3
If you are new to Python, 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. Be sure to select the Python 3.x installation.
Linux users: you will need to also install tkinter
before trying to install the module below package through conda
or pip3
.
On Ubuntu this is done with sudo apt install python3-tk
.
Windows and Mac distributions should come with python3-tk
installed.
Note that if you do not want to install the complete Anaconda Python distribution you can install Miniconda (a smaller version of Anaconda), or you can install Python alone and use a package manager called pip to do the installation. You can get Python and pip together here.
Installing the module
If you installed Anaconda Python or Miniconda, you can install the module by opening a terminal on Linux or OSX (command prompt in Windows) and typing the following command.
To install with conda
use:
conda install -c amoodie rivers2stratigraphy
If asked to proceed, type Y
and 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.
To install with pip
from Pypi use (not recommended for entry-level users):
pip3 install rivers2stratigraphy
Note that you may need to use sudo
on OSX and Linux or run as administrator on Windows.
See below instructions for downloading the source code if you wish to be able to modify the source code for development.
Please open an issue if you encounter any additional error messages! Please include 1) operating system, 2) installation method, and 3) copy-paste the error.
Run the module
Now, open a Python shell by typing python3
at the terminal (or command prompt) prompt.
Finally, run the module from the Python shell with:
import rivers2stratigraphy
You will be asked if you wish to launch the module now, type Y
and hit enter.
Alternatively, run the module with provided script:
python3 <path-to-installation>/run_rivers2stratigraphy.py
Note that this may throw an error on closing the window, but this is not a problem to functionality.
Please open an issue if you encounter any additional error messages! Please include 1) operating system, 2) installation method, and 3) copy-paste the error.
Development
This module is under ongoing development to improve stability and features and optimize performance. If you are interested in contributing to code please see below for instructions.
If you are interested in contributing to the the accompanying activites (which would be greatly appreciated!) please see Writing Activites for SedEdu
Download the source code
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.
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
Open a pull request when you want a review or some comments!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for rivers2stratigraphy-0.2.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26a99bab464834efa6820cbec8a9bcd4a51320ca42c3a59b55c8d02b63221b5f |
|
MD5 | 741ef7a547fd736b42e240412451869d |
|
BLAKE2b-256 | b65b1778f8d59791d05be1e890cea293a86b817fdb77442e3f6166161dcc8117 |
Hashes for rivers2stratigraphy-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 630859252713ca4c0887e610924b14fa064007b29e0d8987d073575045ba3233 |
|
MD5 | 02cadc90ec1b85c49392297d884b9026 |
|
BLAKE2b-256 | fdf6be2cc5518e1bdb60f2d7a6a7a5fda95c07b042a89b1aebca0f946fc5ce41 |