From bf6a5d7a0c911fb40addaeb00105929aafae7b40 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Thu, 1 Sep 2022 16:06:15 -0700 Subject: [PATCH 1/2] Minor edits --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c4e140a..b0b09ce 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**[overview](#overview) | [launching the notebooks](#launching-the-notebooks) | [running the notebooks](#running-the-notebooks) | [issues](#issues) | [contributing](#for-contributors)** +**[overview](#overview) | [launching the notebooks](#launching-the-notebooks) | [how to run the cells](#how-to-run-the-cells) | [issues](#issues) | [contributing](#for-contributors)** # gpgLabs @@ -18,13 +18,18 @@ The notebooks are available on ## Launching the notebooks -The notebooks can be run online through [Binder](#Binder), or [downloaded and run locally](#Locally). +The notebooks can be run online in the [UBC Open JupyterHub](#ubc-open-jupyterhub), through [Binder](#Binder), or [downloaded and run locally](#Locally). + +The notebooks can be run in different ways: +- online in the [UBC Open JupyterHub](#UBC-Open-JupyterHub), +- online through [Binder](#Binder), or +- [downloaded and run them locally](#Locally). ### UBC Open JupyterHub These instructions are for running the notebooks on the UBC open JupyterHub: https://open.jupyter.ubc.ca -1. Login to the JupyterHub using your cwl +1. Login to the JupyterHub using your CWL 2. Under "Other" open a terminal @@ -103,9 +108,9 @@ jupyter notebook Jupyter will then launch in your web-browser. -## Running the notebooks +## How to run the cells -Each cell of code can be run with `shift + enter` or you can run the entire notebook by selecting `cell`, `Run All` in the toolbar. +Each cell of code can be run with `shift + enter` or you can run the entire notebook by selecting `Cell` and `Run All` in the toolbar. ![cell-run-all](https://em.geosci.xyz/_images/run_all_cells.png) From 77c71447b8684274ca003e049e0b1691ba5fbb30 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Thu, 1 Sep 2022 16:09:54 -0700 Subject: [PATCH 2/2] More small edits --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b0b09ce..f01f45c 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,10 @@ The notebooks are available on ## Launching the notebooks -The notebooks can be run online in the [UBC Open JupyterHub](#ubc-open-jupyterhub), through [Binder](#Binder), or [downloaded and run locally](#Locally). - The notebooks can be run in different ways: - online in the [UBC Open JupyterHub](#UBC-Open-JupyterHub), - online through [Binder](#Binder), or -- [downloaded and run them locally](#Locally). +- [download and run them locally](#Locally). ### UBC Open JupyterHub @@ -75,15 +73,15 @@ sh setup.sh ### Locally -To run them locally, you will need to have python installed, preferably through [anaconda](https://www.anaconda.com/download/). +To run them locally, you will need to have Python installed, preferably through [Anaconda](https://www.anaconda.com/download/). -You can then clone this reposiroty. From a command line, run +You can then clone this repository. From a command line, run: ``` git clone https://github.com/geoscixyz/gpgLabs.git ``` -Then `cd` into `gpgLabs` +Then `cd` into `gpgLabs`: ``` cd gpgLabs @@ -96,7 +94,7 @@ conda env create -f environment.yml conda activate geosci-labs ``` -alternatively, you can install dependencies through pypi +Alternatively, you can install dependencies through PyPI ``` pip install -r requirements.txt ``` @@ -110,7 +108,7 @@ Jupyter will then launch in your web-browser. ## How to run the cells -Each cell of code can be run with `shift + enter` or you can run the entire notebook by selecting `Cell` and `Run All` in the toolbar. +Each cell of code can be run with `Shift+Enter` or you can run the entire notebook by selecting `Cell` and `Run All` in the toolbar. ![cell-run-all](https://em.geosci.xyz/_images/run_all_cells.png)