landlab / landlab_teaching_tools

Codes for use in undergraduate and graduate courses

The release of Landlab 2.0 renders the teaching tutorials in this repository no longer functional. They are no longer being maintained here. The content in this repository has been updated and brought into the main landlab repository which allows the development team to better ensure that the tutorials will always run with Landlab. You are still able to clone this repository, but these tutorials will not function with Landlab 2.0. THIS REPOSITORY IS NOW ARCHIVED.

Landlab teaching tools 🙋

This repository includes Jupyter Notebooks that implement Landlab for use in teaching undergraduate and graduate courses. Jupyter Notebooks combine formatted text with code that can be run. Students can run small parts of code bit by bit as they follow along with the text.

The notebooks illustrate examples of physical processes implemented numerically. These notebooks are designed to teach about processes. The notebooks are not designed to teach students to code, or to teach students to use Landlab. No coding experience is needed to successfully carry out these activities - just the ability to read and a classroom introduction of the specific processes being illustrated.

The notebooks are primarily designed for use as homework assignments or laboratory assignments. However, they can be used to illustrate concepts on-the-fly in the classroom.

The easiest way to see what is in the notebooks is through this website: https://nbviewer.jupyter.org/github/landlab/landlab_teaching_tools/tree/master/.

For an introduction to using Jupyter Notebooks, see this webpage - http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/execute.html. [Quick Summary: The way to launch a Jupyter notebook is to enter 'jupyter notebook' from a command line prompt. Jupyter notebooks can also be launched from within Anaconda.]

The notebooks can be run locally by installing Landlab on your computer or they can be run remotely using Hydroshare.

To install Landlab and run locally: 💻

If following this method, every student will need to install Landlab on their personal computer, or it will need to be installed on classroom computers. All software needed to run Landlab locally is opensource (so free!). This link (https://landlab.github.io/#/) will take you to directions on how to install Landlab and information on preferred Python distributions.

The next step would be for the class instructor to hit the Clone or download button (on this webpage (https://github.com/landlab/landlab_teaching_tools), green, upper right) and download this repository locally. Choose which Jupyter Notebooks you would like the students to run, and then distribute the notebook to the students. You can edit them to your class' needs if you use this method. Note that some notebooks require supporting files to run, so make sure those are copied to the students.

To use the notebooks on Hydroshare: ☔💻

These notebooks can all be run remotely using HydroShare, an online collaboration environment for sharing data, models, and code (there are no costs, fees or subscriptions). To have your students run the Notebooks without any software installation required, all of your students will need to join HydroShare. For the first time set up, follow these steps:

Initiation steps:

1. Go to https://www.hydroshare.org/
2. Hit blue button Sign up now and follow steps. (remember your user name and password!)
3. Once signed up, on the top bar hit Collaborate and hite on the Groups button.
4. Search for the Landlab Group and Ask to join
5. Once you have permission, enter the Landlab Group page.
6. Search for classroom_notebooks in the search bar.
7. Enter the collection Landlab_classroom_notebooks.
8. Scroll down to Collection Contents and hit on whatever notebook you want to run.
9. Hit the blue Open with... button on the top right, and choose CUAHSI JupyterHub.
10. You will come to a screen with the notebook name (ending in .ipynb). Click that and you are now running the notebook remotely!

Streamlined access: After you and your students have successfully run through the steps above, in the next work sessions you can also access your personal user space on the supercomputer that makes this magic happen, simply by typing in this URL into your browser: https://jupyter.cuahsi.org You will be prompted for your HydroShare login, and you can navigate the folders to find the resources you have downloaded and created in previous work sessions.

More information: ❓😮

If you have suggestions on improving these notebooks and developing new ones, or are having trouble running them, please leave us a question in our GitHub Issues page - https://github.com/landlab/landlab/issues. Please make sure you include that you are working with a Landlab Teaching Notebook and include the name of the notebook and as much information as possible. If you are getting an error, please taking a screenshot and upload it.

The development of these Notebooks has been made possible by the Landlab project funded by the National Science Foundation (OAC 1450338 to N. Gasparini, OAC 1450409 to G. Tucker, OAC 1450412 to E. Istanbulluoglu). Launching these Notebooks from HydroShare is made possible by a collaboration between HydroShare researchers, the Consortium of Universities Allied for Hydrologic Science, Inc. (CUAHSI), and National SuperComputer A (NCSA) and funding by the National Science Foundation. For more details on the software architecuture behind how to run Jupyter Notebooks from HydroShare, please contact [support@hydroshare(dot)org].