Package: sededu
SedEdu is a suite of educational activities related to geomorphology and sedimentology.
The suite is targeted at educators who want to bring engaging, interactive, and scientifically relevant activities into their classroom.
SedEdu is builtentirely in Python and is free and open sourcesoftware.
Modules included in SedEdu are built by researchers at the cutting edge of their fields and are designed to showcase their research in a digestible manner.Getting StartedThese instructions will get you a copy of the project up and running on your local machine for use in the classroom.
SeeContributing to SedEdufor information on becoming a part of the SedEdu project.Installing dependenciesSedEdu runs in Python 3 and utilizes PyQt5 for rendering the graphical user interface.
Modules included in SedEdu rely onscipy,matplotlib,pillow, andshapely.You can check your Python version by running:python3 -Vin a terminal.
Note that you may need to specify the path to your Python executable on some systems.
If you do not have Python 3 installed, you will need to do so to use SedEdu.
This will not disrupt an existing Python 2.x installation, if you rely on that for other uses.If you are new to Python,it is strongly recommended that you install Anaconda Python, 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.If you received no errors, proceed to installing below.If you want a more flexible and lightweight Python distribution, you can use whatever your favorite package manager is distributing (e.g.,homebreworapt), check theWindows downloads here, or compilefrom source.
If you go this route, you will need to also installpip3, PyQt5 (python3-pyqt5), and the dependency python packages listed below.Note that on Linux, users may need to specify an installation ofpyqtand/ortkinterdirectly fromapt:
Install PyQt5:sudo apt install python3-pyqt5 python3-tkInstalling SedEduIf 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.Installpyqt5with the following command and hit "enter":conda install -c conda-forge pyqtInstall with the module type the following command and hit "enter":conda install -c sededu sededuIf asked to proceed at either step, typeYand press "enter" to continue installation.
4. 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 the Anaconda prompy "as administrator" on Windows.Mac OSX and Linux usersInstall the module by opening a terminal and typing the following command.conda install -c sededu sededuIf asked to proceed at either step, typeYand press enter to continue installation.
2. 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 installationsInstall with pipTo install withpipfrom Pypi use (not recommended for entry-level users):pip install pyqt5 sededuor in the event of a failed install, try:pip install pyqt sededuSee below instructions for downloading the source code if you wish to be able to modify the source code for development or for exploration.Install by cloning the repositoryDevelopers see below:You can clone the git repository to get the latest release version with:git clone --recurse-submodules -b develop https://git@github.com/sededu/sededu.gitand SedEdu is then run with:python sededu/run_sededu.pyNote that if you have no modules: rungit submodule update --init --recursive.Running SedEduOpen a Python shell by typingpython(orpython3) at the terminal (OSX and Linux users) or at the Anaconda / Command Prompt (Windows users).Windows users only: runactivate rootRun the module from the Python shell with:import sededuInstructions will indicate to use the following command to then run the module:sededu.run()Alternatively, you can do this in one line from the standard terminal with:python -c "import sededu; sededu.run()"Alternatively, run the module with provided script:python <path-to-installation>run_sededu.pyPleaseopen an issueif you encounter any additional error messages!
Please include 1) operating system, 2) installation method, and 3) copy-paste the error.TroubleshootingSedEdu won't launch:you're probably missing some Python or PyQt dependencies. If youpip installed, did you installpyqt? Linuz users: trysudo apt install python3-pyqt5.There are no modules in SedEdu:you probably didn't get the submodules when yougit cloned. Trygit submodule update --init --recursiveinside the cloned repository.Contributing to SedEduThe SedEdu project needs contributions from the community to be successful.
However, there aremany different ways you can contribute!You do not even need to write code to contribute to SedEdu.
Some opportunities for contributions are listed below (in no particular order):write (code) a standalone interactive modulewrite an activity for an existing modulewrite (code) features and bug fixes for existing moduleswrite (code) features and bug fixes for SedEduwrite documentation for SedEduPlease readCONTRIBUTING.mdfor details on our code of conduct, and the process for contributing to SedEdu (which includes any pull request).Developer installationDev channel stats:You should get the entire repository and work off of thedevelopbranch:git clone --recurse-submodules https://github.com/sededu/sededu.git
git checkout -b <name-of-working-branch> developIf you have alreadygit cloned and need to pull the submodules now try:git submodule update --init --recursiveSeeCONTRIBUTING.mdfor more information on the preferredgitworkflow for SedEdu, including a note on hot-fixes.AuthorsAndrew J. Moodie-3 modules-github.com/amoodieKensuke Naito-1 module-github.com/kensukename2Jeffrey Kwang-1 module-github.com/jeffskwangSee also the list ofcontributorswho have participated in this project in other ways.LicenseThis project is licensed under the GNU GPL License - see thefull licensefile for details.
It is provided without warranty or guaranteed support.
Each submodule may be licensed under a different license, please see the relevant module's license file, README, or project homepage for more information.AcknowledgmentsThe SedEdu framework was created by Andrew J. Moodie but has been built through the efforts of many authors (see Authors above).
The authors have been supported by:The US National Science Foundation under Grant Nos. 1427262 and 1450681.DisclaimerAny opinion, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of any funding agency.