JupyterHub: Difference between revisions

From CSDMS
m (Update tooltip)
(Update to show information on the OpenEarthscape JupyterHub)
Line 1: Line 1:
{{PageTitle|The CSDMS JupyterHub}}
{{PageTitle|The OpenEarthscape JupyterHub}}


<div class=AutoScaleImage>[[ File:jupyterhub.png | What is JupyterHub? | 325 px | right | link=https://jupyter.org/hub ]]<div>
<div class=AutoScaleImage>[[ File:jupyterhub.png | What is JupyterHub? | 325 px | right | link=https://jupyter.org/hub ]]<div>


CSDMS has a JupyterHub: https://csdms.rc.colorado.edu.
Through the NSF-funded [[OpenEarthscape]] project,
CSDMS has not one, but two, JupyterHubs:


It's free and available for use by all CSDMS members, whether you're an undergraduate, grad student, postdoc, researcher, or faculty.
# [https://jupyter.openearthscape.org jupyter.openearthscape.org]
# [https://lab.openearthscape.org lab.openearthscape.org]


What can you do with the CSDMS JupyterHub? Here are a few ideas:
Both Hubs are hosted on the commerical cloud through the NSF [https://www.cloudbank.org/ CloudBank] program.
Both are free and available for use by all CSDMS members, whether you're an undergraduate, grad student, postdoc, researcher, or faculty.


What can you do with these JupyterHubs? Here are a few ideas:
* Prototype and test Python code for a model
* Run a model through [[Landlab]] or [[PyMT|pymt]]
* Create a notebook for a journal article
* Teach a class at a university
* Lead an interactive workshop at a conference
* Work on a course assignment
* Work on a course assignment
* Prototype and test Python code for a model
* Run a model through [[PyMT]] or [[Landlab]]
* Create a visualization for a journal article
* Share a Notebook with colleagues
* Deliver content for a multiuser workshop (like [https://github.com/csdms/rcem-2019 this], [https://github.com/csdms/agu-2019 this], and [https://github.com/csdms/csdms-2020 this])
* Run a lab from the [[Labs portal|CSDMS EKT repository]]
* Run a lab from the [[Labs portal|CSDMS EKT repository]]
* Highlight your research and share it with others in the community by [[Get_Lab_on_CSDMS_NB_server|developing your own EKT lab]]
* Highlight your research in a notebook and share it with others in the community
* Access a Linux OS and shell
* Access a Linux OS and shell in the cloud
 
The roles of these two JupyterHubs, ''jupyter'' and ''lab'', as well as sign up and sign in instructions for each, are given in the sections below.
 
= jupyter =
 
This is the primary JupyterHub for use by all CSDMS members.
It's a place to work, experiment, and learn.
It includes CSDMS software such as [[Landlab]] and [[PyMT|pymt]].
Labs from the [[Labs portal|CSDMS EKT repository]] can run on this Hub.
 
This Hub uses GitHub as a login service.
Please see [[JupyterHubGitHubSignUp|these instructions]] to sign up and sign in.
 
Note that the login for this Hub is separate from the login for the ''lab'' Hub.
There is no expiration date for a login on this Hub.
 
= lab =
 
This JupyterHub is used for teaching; e.g., university classes or interactive workshops at a conference.
Like ''jupyter'', it's a place to work, experiment, and learn.
It includes CSDMS software such as [[Landlab]] and [[PyMT|pymt]].
Labs from the [[Labs portal|CSDMS EKT repository]] can also run on this Hub.
 
A username and password are required to login to this Hub.
If you'd like to teach a class or lead a workshop using this Hub,
please contact us through the [https://github.com/csdms/help-desk CSDMS Help Desk],
or email us at [mailto:csdms@colorado.edu csdms@colorado.edu].
We can help install software and create logins for the participants in your class or workshop.
 
Note that the login for this Hub is separate from the login for the ''jupyter'' Hub.
Non-instructor logins that are inactive for more than a year will be removed.
 
= common features =
 
The ''jupyter'' and ''lab'' Hubs share some common features described below.
 
== user interface ==


Of course, these are just suggestions. How do you think you'll use the CSDMS JupyterHub?
The default user interface on both Hubs is [https://jupyter.org/ JupyterLab].
If you haven't used JupyterLab before, there's ample [https://jupyterlab.readthedocs.io documentation].
However, it's best to just get in and try it.
Don't worry, you won't break anything!


If you have questions, or if you'd like more information, please contact us through the [https://github.com/csdms/help-desk CSDMS Help Desk].
== default files ==


== Getting access to the CSDMS JupyterHub ==
In each Hub, a README and pair of directories are included by default in your home directory.
The directories are:


{{:JupyterHubSignUp}}
* ''data'': A read-only directory for storing and sharing data
* ''scratch'': A read-write directory for sharing code, notebooks, or other files with other users


If you've forgotten your username or password, just fill out a [https://github.com/csdms/help-desk CSDMS Help Desk] request and we can help.
Files that remain in ''scratch'' longer than 90 days may be deleted.
If you'd like to add files to the ''data'' directory,
please contact us through the [https://github.com/csdms/help-desk CSDMS Help Desk].


== Resources ==
== software ==


If you're new to using Jupyter Notebook, here are a few resources to help you start:
These Hubs use Jupyter [https://docs.jupyter.org/en/latest/projects/kernels.html kernels]
mapped to [https://docs.conda.io conda] environments to group software.
The default kernel is called ''Python 3''.
It contains a minimal set of software packages.
To explore with CSDMS models and tools,
including  [[Landlab]] and [[PyMT|pymt]],
select the ''CSDMS'' kernel.


* [https://jupyter-notebook.readthedocs.io/en/stable/notebook.html The Jupyter Notebook]
If you'd like new software installed on a Hub (e.g., for a class or a workshop),
* [https://jupyter-notebook.readthedocs.io/en/stable/ui_components.html The Notebook interface]
please contact us through the [https://github.com/csdms/help-desk CSDMS Help Desk].
* [https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/examples_index.html Notebook examples]
* [https://jupyter-notebook.readthedocs.io/en/stable/troubleshooting.html What to do when things go wrong]

Revision as of 17:23, 4 March 2022

The OpenEarthscape JupyterHub
What is JupyterHub?

Through the NSF-funded OpenEarthscape project, CSDMS has not one, but two, JupyterHubs:

  1. jupyter.openearthscape.org
  2. lab.openearthscape.org

Both Hubs are hosted on the commerical cloud through the NSF CloudBank program. Both are free and available for use by all CSDMS members, whether you're an undergraduate, grad student, postdoc, researcher, or faculty.

What can you do with these JupyterHubs? Here are a few ideas:

  • Prototype and test Python code for a model
  • Run a model through Landlab or pymt
  • Create a notebook for a journal article
  • Teach a class at a university
  • Lead an interactive workshop at a conference
  • Work on a course assignment
  • Run a lab from the CSDMS EKT repository
  • Highlight your research in a notebook and share it with others in the community
  • Access a Linux OS and shell in the cloud

The roles of these two JupyterHubs, jupyter and lab, as well as sign up and sign in instructions for each, are given in the sections below.

jupyter

This is the primary JupyterHub for use by all CSDMS members. It's a place to work, experiment, and learn. It includes CSDMS software such as Landlab and pymt. Labs from the CSDMS EKT repository can run on this Hub.

This Hub uses GitHub as a login service. Please see these instructions to sign up and sign in.

Note that the login for this Hub is separate from the login for the lab Hub. There is no expiration date for a login on this Hub.

lab

This JupyterHub is used for teaching; e.g., university classes or interactive workshops at a conference. Like jupyter, it's a place to work, experiment, and learn. It includes CSDMS software such as Landlab and pymt. Labs from the CSDMS EKT repository can also run on this Hub.

A username and password are required to login to this Hub. If you'd like to teach a class or lead a workshop using this Hub, please contact us through the CSDMS Help Desk, or email us at csdms@colorado.edu. We can help install software and create logins for the participants in your class or workshop.

Note that the login for this Hub is separate from the login for the jupyter Hub. Non-instructor logins that are inactive for more than a year will be removed.

common features

The jupyter and lab Hubs share some common features described below.

user interface

The default user interface on both Hubs is JupyterLab. If you haven't used JupyterLab before, there's ample documentation. However, it's best to just get in and try it. Don't worry, you won't break anything!

default files

In each Hub, a README and pair of directories are included by default in your home directory. The directories are:

  • data: A read-only directory for storing and sharing data
  • scratch: A read-write directory for sharing code, notebooks, or other files with other users

Files that remain in scratch longer than 90 days may be deleted. If you'd like to add files to the data directory, please contact us through the CSDMS Help Desk.

software

These Hubs use Jupyter kernels mapped to conda environments to group software. The default kernel is called Python 3. It contains a minimal set of software packages. To explore with CSDMS models and tools, including Landlab and pymt, select the CSDMS kernel.

If you'd like new software installed on a Hub (e.g., for a class or a workshop), please contact us through the CSDMS Help Desk.

Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=JupyterHub&oldid=415680"