Get Lab on CSDMS NB server: Difference between revisions

From CSDMS
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=How to get your lab on the CSDMS JupyterHub=
=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 [https://github.com/csdms/ekt_lab/blob/master/README.md here].
Please follow the steps below to create an EKT lab and add your Jupyter notebooks on the CSDMS JupyterHub. More information about how to use the CSDMS JupyterHub can be found [[JupyterHub|here]].


1. Create an EKT lab
1. Create an EKT lab
* Make sure you first create a user account and login to the CSDMS website 
* If you haven't already done so, [[join_CSDMS|join CSDMS]] and [https://csdms.colorado.edu/csdms_wiki/index.php?title=Special:UserLogin&returnto=Main+Page login] to the CSDMS wiki  
* Go to page https://csdms.colorado.edu/wiki/Labs_portal
* Go to the [[Labs_portal|EKT Labs portal]]
* Click on "add a lab to the wiki" and enter the detailed information for your lab.
* 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. 
* 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 :
2. Add Jupyter notebooks
* Make sure your notebooks are available in a Github repo.  
* 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.
* Copy the Github URL of your notebooks 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.  
* Create a nbgitpuller link for your notebooks. This link can pull your notebooks from Github and load them to the CSDMS JupyterHub. To create this link, You can use either nbgitpuller-link utility (command line) or Github puller URL generator webpage (GUI).
* "JupyterHub URL": enter https://csdms.rc.colorado.edu/
* nbgitpuller-link utility: please see the instructions https://pypi.org/project/nbgitpuller-link/ for how to install and use this utility to generate a nbgitpuller link for your notebook.
* "Git Repository URL": enter your Github repo URL
* Github puller URL generator webpage:
* "File to open" : enter the info for your Jupyter notebook
** Go to https://jupyterhub.github.io/nbgitpuller/link
* 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. 
** "JupyterHub URL": enter https://csdms.rc.colorado.edu/
* 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.  
** "Git Repository URL": enter your Github repo URL
** "File to open" : launch path for your Jupyter notebook
** The nbgitpuller link is shown above the "JupyterHub URL" filed
* After the nbgitpuller link is generated, copy this link and paste it in "URL to start notebook " on your EKT lab. 
* Test the Jupyter notebooks 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 [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.
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.

Latest revision as of 14:21, 22 November 2021

How to get your lab on the CSDMS JupyterHub

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

1. Create an EKT lab

  • If you haven't already done so, join CSDMS and login to the CSDMS wiki
  • Go to the EKT 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 notebooks

  • Make sure your notebooks are available in a Github repo.
  • Copy the Github URL of your notebooks and paste it in "URL to download notebook" on your EKT lab.
  • Create a nbgitpuller link for your notebooks. This link can pull your notebooks from Github and load them to the CSDMS JupyterHub. To create this link, You can use either nbgitpuller-link utility (command line) or Github puller URL generator webpage (GUI).
  • nbgitpuller-link utility: please see the instructions https://pypi.org/project/nbgitpuller-link/ for how to install and use this utility to generate a nbgitpuller link for your notebook.
  • Github puller URL generator webpage:
  • After the nbgitpuller link is generated, copy this link and paste it in "URL to start notebook " on your EKT lab. 
  • Test the Jupyter notebooks 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=346444"