search

CDAT / jupyter-vcdat

A Jupyter Lab extension based on vCDAT.
BSD 3-Clause "New" or "Revised" License
6 stars 5 forks source link

Getting started notebook #87

Closed davis278 closed 5 years ago

davis278 commented 5 years ago

Adding two new folders: docs and docs/notebooks so there is a place to put the getting_started.ipynb file.

davis278 commented 5 years ago

@doutriaux1 when you are available, we need to talk about what else you'd like to add to this getting started Jupyter notebook. It would be great if the notebook could exist in the directory from which JupyterLab is launched.

One test that has not been completed yet is to see how a few of the commands work within the JupyterLab environment. Jason and I tested in a Jupyter Notebook environment, and are hoping that it will work more seemlessly in the JupyterLab environment (i.e. the kernels will be managed better).

doutriaux1 commented 5 years ago

@davis278

Storage section depends on system deployed, we can't know, might be better to update the dedicated wiki pages for aims1/crunchy

Software section

Currently jupyter-vcdat brings in: nodejs "python>3" vcs jupyterlab pip nb_conda nb_conda_kernels plumbum jupyterhub . by default

Again our installations bring in more:

crunchy as the whole cdat installation (that means pkg suck as vcsaddons thermo wk, etc....

Conda Section

You have access to conda as a software management tool.

**NOTE: Anything installed in the [base] conda environment will not persist between sessions.**

The above is only true for kubernetes-deployed version Maybe [snip] the conda list output sections it's long and not very relevant here.

We should link back to wiki both at top and bottom.

We should add this page into this notebook along with this download sample_data section

doutriaux1 commented 5 years ago

@davis278 could we finish this one today? The storage option I think we could copy/paste your link that explain how to get sample data and most importantly (probably should be first) the bit explaining symlinking to your home directory. Probably should mention CDAST can open any opendap file. And point back ESGF page to search/download/get dap url for datasets.

Not sure what you had in mind for "software options" but we could mention that by default it comes with:

davis278 commented 5 years ago

@doutriaux1 I've added some text and made some other edits to this notebook. If you are OK with those changes, this branch can be merged into master.

davis278 commented 5 years ago

@doutriaux1 per our conversations this morning, I've moved the adding environments in JupyterHub part of the notebook to a new add_envs_in_hub.ipynb notebook. That new notebook works fine on a single computer but is not yet working on acme1 or crunchy so I have not included that notebook in this pull request yet. I have pushed the changes to the getting_started.ipynb notebook however and if you are OK with the changes, I can merge with master.