Skip to content

Generalise dir names in SURF instructions #287

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

Open
j-atkins wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Generalise dir names in SURF instructions #287

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/user-guide/tutorials/surf_research_cloud_setup.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,19 @@
"├── KERNEL-README.ipynb\n",
"├── data\n",
"│ └── datasets\n",
"| └── storage-osl <--- The shared persistent storage\n",
"| └── virtualship-storage <--- The shared persistent storage\n",
"└── scratch\n",
"```\n",
"\n",
"__Note__: the persistent storage folder may be called something slightly different in your instance, for example it may have a name specific to the course you are enrolled on, such as `data/storage-dyoc` or `data/storage-1-sept`.\n",
"__Note__: the persistent storage folder may be called something slightly different in your instance, for example it may have a name specific to the course you are enrolled on, such as `data/storage-osl`, `data/storage-dyoc` or `data/storage-1-sept`.\n",
"\n",
"In the Jupyter launcher, you can open a Terminal session by clicking on \"Terminal\" button under the \"Other\" section, or by going to the \"File\" menu --> \"New\" --> \"Terminal\". From here you can navigate the workspace directory structure and run commands.\n",
"\n",
"<div class=\"alert alert-block alert-info\"> \n",
"<b>**INFO**:</b> VirtualShip is a command line interface (CLI) based tool. We will be working predominantly via the command line in Terminal (typing out commands instead of pointing and clicking). If you are unfamiliar with what a CLI is, see [here](https://www.w3schools.com/whatis/whatis_cli.asp) for more information. In our case, the Terminal is just a way to access the CLI on the SURF RC virtual machine.\n",
"</div>\n",
"\n",
"The `data/storage-osl` folder is your persistent storage. Here you can make a folder (e.g., by running `mkdir data/storage-osl/{your-group-name}` as a command in the Terminal, replacing `{your-group-name}` with your group name) to house your work for the unit. This folder will be visible to anyone using the workspace, but only you will be able to make edits to it. This is the primary place you should store your `virtualship` configs and content relevant to this unit.\n",
"The `data/virtualship-storage` folder is your persistent storage. Here you can make a folder (e.g., by running `mkdir data/virtualship-storage/{your-group-name}` as a command in the Terminal, replacing `{your-group-name}` with your group name) to house your work for the unit. This folder will be visible to anyone using the workspace, but only you will be able to make edits to it. This is the primary place you should store your `virtualship` configs and content relevant to this unit.\n",
"\n",
"---\n",
"\n",
Expand Down Expand Up @@ -90,7 +90,7 @@
"\n",
"With the `virtualship` environment, you now have access to the `virtualship` command in your Terminal, which can be confirmed by running `virtualship --help`. \n",
"\n",
"From here you can `cd` ('change directory') into `data/storage-osl/{your-name}` and run `virtualship` commands as you would on your local machine (see the VirtualShip [quickstart guide](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html)). \n",
"From here you can `cd` ('change directory') into `data/virtualship-storage/{your-group-name}` and run `virtualship` commands as you would on your local machine (see the VirtualShip [quickstart guide](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html)). \n",
"\n",
"<div class=\"alert alert-block alert-success\"> \n",
"<b>**TIP**:</b> Return to your course-specific instructions/assignment notebook now if you were following along with this setup in class!\n",
Expand Down