Skip to content

Commit 20f26d7

Browse files
committed
adding r-jupyter tutorial
1 parent fbf41b7 commit 20f26d7

File tree

4 files changed

+348
-9
lines changed

4 files changed

+348
-9
lines changed

_posts/hpc/2018-07-10-sherlock-jupyter.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ tags:
1212
- resources
1313
---
1414

15-
Today we are going to walk through using a [tool](https://github.com/drorlab/forward) provided by one of our users to set up port forwarding on Sherlock. What does this mean? It means you...
15+
Today we are going to walk through using a [tool](https://github.com/vsoch/forward) provided by one of our users to set up port forwarding on Sherlock. What does this mean? It means you...
1616

1717
- will run a password protected jupyter notebook on a cluster node
1818
- can access the notebook in a browsr on your local machine
@@ -26,7 +26,7 @@ Likely some of you are doing this on your own with basic bash commands, and this
2626

2727
### Collaborative Scripts
2828

29-
The repository has a folder of general sbatch scripts that expose ports that can be forwarded. If you add a new script that you find useful and want to share with others, we encourage you to <a href="https://github.com/drorlab/forward" target="_blank">tell us about it</a>! If it's not perfect or finished, don't be afraid to share! We will provide any additional help needed to finish up your script.
29+
The repository has a folder of general sbatch scripts that expose ports that can be forwarded. If you add a new script that you find useful and want to share with others, we encourage you to <a href="https://github.com/vsoch/forward" target="_blank">tell us about it</a>! If it's not perfect or finished, don't be afraid to share! We will provide any additional help needed to finish up your script.
3030

3131
### Community Support
3232

@@ -41,7 +41,7 @@ There are a set of commands you will need to run just once to configure the tool
4141
Make sure you put the folder somewhere meaningful. A subfolder of `$HOME` is a suggestion. This will be your working location for future use of the tool, as it holds scripts and a parameter file, `params.sh`
4242

4343
```bash
44-
git clone https://github.com/drorlab/forward
44+
git clone https://github.com/vsoch/forward
4545
cd forward
4646
```
4747

@@ -58,7 +58,7 @@ Let's take a look at what we have here!
5858
```
5959
6060
### Step 2: Generate your Parameters
61-
This is a one time generation script that will create a parameter text file with a port, username, and cluster resource. You can generate it by running the script [setup.sh](https://github.com/drorlab/forward/blob/master/setup.sh):
61+
This is a one time generation script that will create a parameter text file with a port, username, and cluster resource. You can generate it by running the script [setup.sh](https://github.com/vsoch/forward/blob/master/setup.sh):
6262
6363
```bash
6464
$ bash setup.sh
@@ -199,14 +199,14 @@ We have just set up a password on Sherlock, and are now back on our _local machi
199199
200200
201201
### 3.1. Start a Session
202-
From the directory where we cloned, we can start a session using the [start.sh](https://github.com/drorlab/forward/blob/master/start.sh) script. This is a general script to start any kind of session, and here we will show how to start a jupyter notebook in a specific directory:
202+
From the directory where we cloned, we can start a session using the [start.sh](https://github.com/vsoch/forward/blob/master/start.sh) script. This is a general script to start any kind of session, and here we will show how to start a jupyter notebook in a specific directory:
203203
204204
```bash
205205
bash start.sh <software> <path>
206206
bash start.sh jupyter /path/to/dir
207207
```
208208
209-
What's going on? It will look in the folder of [sbatch scripts](https://github.com/drorlab/forward/blob/master/sbatches) and find one named correpondingly to the command we issued. This means that there is a file called [jupyter.sbatch](https://github.com/drorlab/forward/blob/master/sbatches/jupyter.sbatch) in that folder. Note that, to
209+
What's going on? It will look in the folder of [sbatch scripts](https://github.com/vsoch/forward/blob/master/sbatches) and find one named correpondingly to the command we issued. This means that there is a file called [jupyter.sbatch](https://github.com/vsoch/forward/blob/master/sbatches/jupyter.sbatch) in that folder. Note that, to
210210
make this simple, we also have sbatch scripts for using jupyter with different Python kernels:
211211
212212
@@ -279,7 +279,7 @@ Killing py3-jupyter slurm job on sherlock
279279
Killing listeners on sherlock
280280
```
281281
282-
There are additional details and debugging tips in the <a href="https://github.com/drorlab/forward" target="_blank">main repository</a>! Happy Jupyter-ing!
282+
There are additional details and debugging tips in the <a href="https://github.com/vsoch/forward" target="_blank">main repository</a>! Happy Jupyter-ing!
283283
284284
## Contribute!
285285
The cool thing about small efforts like these is that they provide very useful tools for you
@@ -303,8 +303,8 @@ module load py-jupyter/1.0.0_py27
303303
jupyter notebook --no-browser --port=$PORT
304304
```
305305
306-
Contributing can also be as simple as suggesting a feature or reporting a bug on the <a href="https://github.com/drorlab/forward/issues" target="_blank">issues board</a>.
307-
See the <a href="https://github.com/drorlab/forward" target="_blank">main repository</a> for how to contribute.
306+
Contributing can also be as simple as suggesting a feature or reporting a bug on the <a href="https://github.com/vsoch/forward/issues" target="_blank">issues board</a>.
307+
See the <a href="https://github.com/vsoch/forward" target="_blank">main repository</a> for how to contribute.
308308
309309
### Add Functionality
310310

0 commit comments

Comments
 (0)