|
5 | 5 | "id": "98770716", |
6 | 6 | "metadata": {}, |
7 | 7 | "source": [ |
8 | | - "# SURF Resarch Cloud: VirtualShip environment setup\n", |
| 8 | + "# SURF Resarch Cloud: Collaborative Workspace Setup Guide\n", |
9 | 9 | "\n", |
10 | 10 | "```\n", |
11 | 11 | "Note: This guide is specific to students who are enrolled at Utrecht University.\n", |
|
34 | 34 | "\n", |
35 | 35 | "## 4. Launch VirtualShip environment\n", |
36 | 36 | "\n", |
37 | | - "❗️ Before proceeding any further, you should type the following command in the Terminal: `bash` and then hit Enter. This will ensure that you are in a bash shell for the rest of the setup.\n", |
| 37 | + "❗️ Before proceeding any further, you should type the following command in the Terminal and then hit Enter: `bash` ❗️\n", |
38 | 38 | "\n", |
39 | | - "You will see that the Terminal prompt has changed to something like\n", |
| 39 | + "\n", |
| 40 | + "This will ensure that you are in a bash shell for the rest of the setup.\n", |
| 41 | + "\n", |
| 42 | + "You will see that the Terminal prompt has changed to something like:\n", |
40 | 43 | "\n", |
41 | 44 | "```bash\n", |
42 | 45 | "(base) metheuser@mywsp:\n", |
|
55 | 58 | "virtualship /etc/miniconda3/envs/virtualship\n", |
56 | 59 | "```\n", |
57 | 60 | "\n", |
58 | | - "Next, to launch the VirtualShip environment, type the following command in the Terminal and hit Enter:\n", |
| 61 | + "Next, to launch the VirtualShip environment, type the following command in the Terminal and hit Enter: `conda activate virtualship`\n", |
| 62 | + "\n", |
| 63 | + "This will activate the VirtualShip conda environment, which has all the necessary dependencies installed. You can confirm that you are in the correct environment by checking that your Terminal prompt now looks something like:\n", |
59 | 64 | "\n", |
60 | 65 | "```bash\n", |
61 | | - "conda activate virtualship\n", |
| 66 | + "(virtualship) metheuser@mywsp:\n", |
62 | 67 | "```\n", |
63 | 68 | "\n", |
64 | | - "This will activate the VirtualShip conda environment, which has all the necessary dependencies installed. You can confirm that you are in the correct environment by checking that your Terminal prompt now starts with `(virtualship)`.\n", |
| 69 | + "With the `virtualship` environment, you now have access to the `virtualship` command in your Terminal.\n", |
65 | 70 | "\n", |
66 | | - "With the `virtualship` environment, you now have access to the `virtualship` command in your Terminal, which can be confirmed by running `virtualship --help`.\n", |
| 71 | + "This can be confirmed by typing the following command in the Terminal and hitting Enter: `virtualship --help`.\n", |
67 | 72 | "\n", |
68 | | - "## 5. Navigate to the shared storage folder\n", |
69 | | - "\n", |
70 | | - "We will be working from a shared storage folder in the workspace. To navigate to this folder, type the following command in the Terminal and hit Enter:\n", |
| 73 | + "You should see something like:\n", |
71 | 74 | "\n", |
72 | | - "```bash\n", |
73 | | - "cd data/virtualship-storage/\n", |
74 | 75 | "```\n", |
| 76 | + "virtualship --help\n", |
| 77 | + "\n", |
| 78 | + "Usage: virtualship [OPTIONS] COMMAND [ARGS]...\n", |
| 79 | + "\n", |
| 80 | + "Options:\n", |
| 81 | + " --version Show the version and exit.\n", |
| 82 | + " --help Show this message and exit.\n", |
| 83 | + "\n", |
| 84 | + "Commands:\n", |
| 85 | + " fetch Download input data for an expedition.\n", |
| 86 | + " init Initialize a directory for a new expedition, with an example...\n", |
| 87 | + " plan Launch UI to help build schedule and ship config files.\n", |
| 88 | + " run Run the expedition.\n", |
| 89 | + " ```\n", |
| 90 | + "\n", |
| 91 | + "## 5. Navigate to the shared storage folder\n", |
| 92 | + "\n", |
| 93 | + "We will be working from a shared storage folder in the workspace. To navigate to this folder, type the following command in the Terminal and hit Enter: `cd data/virtualship-storage/`\n", |
75 | 94 | "\n", |
76 | | - "Depending on the specific set-up for the course you are taking, if you now enter `ls` to list the contents of the directory, you should see various group folders, for example: `group_1`, `group_2`, ... and so on.\n", |
| 95 | + "Depending on the specific set-up for the course you are taking, if you now enter `ls` to list the contents of the directory, you may see various group folders, for example: `group_1`, `group_2`, ... and so on.\n", |
77 | 96 | "\n", |
78 | | - "This is where will be working from for the rest of the course, with the group name for each folder corresponding to your assigned group.\n", |
| 97 | + "If you have been pre-assigned into groups, this is where will be working from for the rest of the course, with the group name for each folder corresponding to your assigned group.\n", |
79 | 98 | "\n", |
80 | 99 | "You are ready to continue with the VirtualShip analysis workflow as described in the course materials and/or VirtualShip [quickstart guide](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html)." |
81 | 100 | ] |
|
0 commit comments