Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor edits to the README.md #125

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Minor edits to the README.md #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf6a5d7
Minor edits
santisoler Sep 1, 2022
77c7144
More small edits
santisoler Sep 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -18,13 +18,16 @@ 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 in different ways:
- online in the [UBC Open JupyterHub](#UBC-Open-JupyterHub),
- online through [Binder](#Binder), or
- [download 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

Expand Down Expand Up @@ -70,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
Expand All @@ -91,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
```
Expand All @@ -103,9 +106,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)

Expand Down