Get Lab on CSDMS NB server: Difference between revisions

From CSDMS
Line 1: Line 1:
=How to get your lab on the CSDMS JupyterHub=
=How to get your lab on the CSDMS JupyterHub=


If you have Jupyter Notebooks for your EKT lab, you can follow the steps below to make them available on the CSDMS JupyterHub and help others test and run your notebooks. More information about how to use the CSDMS JupyterHub can be found [https://github.com/csdms/ekt_lab/blob/master/README.md here].
Please follow the steps below to create an EKT lab and add you Jupyter Notebook on the CSDMS JupyterHub. More information about how to use the CSDMS JupyterHub can be found [https://github.com/csdms/ekt_lab/blob/master/README.md here].


1. Create a [https://github.com/csdms/help-desk Github Issue] at the CSDMS help-desk to make a request.  
1. Create an EKT lab
* Make sure you first create a user account and login to the CSDMS website 
* Go to page https://csdms.colorado.edu/wiki/Labs_portal
* Click on "add a lab to the wiki" and enter the detailed information for your lab.
* When you click on the "save lab" button on the "Create Labs"  page, your lab will be open to the public. 


2. Provide the required information in the Github Issue. We will get back to you as soon as possible.
* URL of your EKT Lab wiki


* URL to download Jupyter Notebooks
2. Add Jupyter notebook :
* Make sure your notebooks are available in a Github repo.
* Copy the Github URL of your notebook and paste it in "URL to download notebook" on your EKT lab.
* Go to Github puller URL generator https://jupyterhub.github.io/nbgitpuller/link. This page will help you generate a URL which can pull your notebooks from Github and load them to the CSDMS JupyterHub.
* "JupyterHub URL": enter https://csdms.rc.colorado.edu/
* "Git Repository URL": enter your Github repo URL
* "File to open" : enter the info for your Jupyter notebook
* After all the required info are entered, a new URL is generated (shown above the "JupyterHub URL" field). Copy this link and paste it in "URL to start notebook " on your EKT lab. 
* Test the Jupyter notebook on the CSDMS JupyterHub. You can click on "start" which is below "Run online" on your EKT lab and it will direct you to the CSDMS JupyterHub login page. After login, it will load the notebooks to the CSDMS JupyterHub if the "URL to start notebook" info is correct.


* Python packages used for Jupyter Notebooks


* URL to download input datasets (optional)
If you have any issues with login or running the notebooks on the CSDMS JupyterHub or need any other support from us, please create a [https://github.com/csdms/help-desk Github Issue] at the CSDMS help-desk to make a request. We will try our best to help you.
 
* Other required software for Jupyter Notebooks (optional)
 
3. After we setup your Jupyter Notebooks on the server, we will notify you through Github and add instruction information in your EKT lab to guide others run the notebooks on the CSDMS JupyterHub.

Revision as of 17:41, 21 October 2021

How to get your lab on the CSDMS JupyterHub

Please follow the steps below to create an EKT lab and add you Jupyter Notebook on the CSDMS JupyterHub. More information about how to use the CSDMS JupyterHub can be found here.

1. Create an EKT lab

  • Make sure you first create a user account and login to the CSDMS website 
  • Go to page https://csdms.colorado.edu/wiki/Labs_portal
  • Click on "add a lab to the wiki" and enter the detailed information for your lab.
  • When you click on the "save lab" button on the "Create Labs"  page, your lab will be open to the public. 


2. Add Jupyter notebook :

  • Make sure your notebooks are available in a Github repo.
  • Copy the Github URL of your notebook and paste it in "URL to download notebook" on your EKT lab.
  • Go to Github puller URL generator https://jupyterhub.github.io/nbgitpuller/link. This page will help you generate a URL which can pull your notebooks from Github and load them to the CSDMS JupyterHub.
  • "JupyterHub URL": enter https://csdms.rc.colorado.edu/
  • "Git Repository URL": enter your Github repo URL
  • "File to open" : enter the info for your Jupyter notebook
  • After all the required info are entered, a new URL is generated (shown above the "JupyterHub URL" field). Copy this link and paste it in "URL to start notebook " on your EKT lab. 
  • Test the Jupyter notebook on the CSDMS JupyterHub. You can click on "start" which is below "Run online" on your EKT lab and it will direct you to the CSDMS JupyterHub login page. After login, it will load the notebooks to the CSDMS JupyterHub if the "URL to start notebook" info is correct.


If you have any issues with login or running the notebooks on the CSDMS JupyterHub or need any other support from us, please create a Github Issue at the CSDMS help-desk to make a request. We will try our best to help you.

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