Skip to content

Commit 553a70c

Browse files
committed
post review edits/enhancements
1 parent 0bf438c commit 553a70c

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

docs/user-guide/assignments/Sail_the_ship.ipynb

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"source": [
6060
"## Your virtual expedition...\n",
6161
"\n",
62-
"This guide will help you get started with running your VirtualShip expedition. Follow the steps below to set up your programming environment, configure your expedition, and launch your simulation. \n",
62+
"Now let's get started on running your VirtualShip expedition. Follow the steps below to set up your coding environment, plan your expedition, and launch your simulation. \n",
6363
"\n",
6464
"<div class=\"alert alert-block alert-warning\"> \n",
6565
"Before that though, make sure you have had your research question approved by your instructor!\n",
@@ -101,7 +101,7 @@
101101
"\n",
102102
"### NIOZ MFP tool\n",
103103
"\n",
104-
"The first step is to plan the expedition route for your chosen research question, bearing in mind where you will need to go to collect data for your research, what kind of sampling strategy you will use, and how long you want your expedition to last (remember, though, you have a three week ship time limit).\n",
104+
"The first step is to plan the expedition route for your chosen research question, bearing in mind the time needed for your sampling strategy, and traveling to and from a port suitable for research vessels (remember though, you have a three week ship time limit).\n",
105105
"\n",
106106
"Your route can be created with the online [NIOZ MFP tool](https://nioz.marinefacilitiesplanning.com/cruiselocationplanning#). Documentation on how to use the website can be found [here](https://surfdrive.surf.nl/files/index.php/s/84TFmsAAzcSD56F). Alternatively, you can watch this [video](https://www.youtube.com/watch?v=yIpYX2xCvsM&list=PLE-LzO7kk1gLM74U4PLDh8RywYXmZcloz&ab_channel=VirtualShipClassroom), which runs through how to use the MFP tool.\n",
107107
"\n",
@@ -112,11 +112,11 @@
112112
"\n",
113113
"### Upload the coordinates to your virtual machine\n",
114114
"\n",
115-
"<div class=\"alert alert-block alert-success\"> \n",
116-
"**TIP**: If you have not done so already, make sure you create a folder for your group's expedition data in your persistent storage on SURF RC (i.e. `mkdir data/storage-osl/{your-group-name}`).\n",
115+
"<div class=\"alert alert-block alert-warning\"> \n",
116+
"**IMPORTANT**: _If you have not done so already_, make sure you create a folder for your group's expedition data in the persistent storage on SURF RC (i.e. the `data/storage-osl/` folder). You can do so by running `mkdir /data/storage-osl/{your-group-name}` in Terminal, replacing `{your-group-name}` with your actual group name, or by using the \"New Folder\" button in the JupyterLab file explorer panel.\n",
117117
"</div>\n",
118118
"\n",
119-
"Back in the SURF RC JupyterLab interface, use the file explorer on the left hand side to navigate to the directory where your group will be running your expedition (i.e. `data/storage-osl/{your-group-name}`). \n",
119+
"Back in the SURF RC JupyterLab interface, use the **file explorer** on the left hand side to navigate to the directory where your group will be running your expedition (i.e. `data/storage-osl/{your-group-name}`). \n",
120120
"\n",
121121
"Then upload the exported .xlsx file (it will be called something like \"Coordinates-20251125T1403.xlsx\") by either dragging and dropping it from your laptop's Downloads into the file explorer, or by using the \"Upload Files\" button (the icon with an upward arrow) at the top of the file explorer panel."
122122
]
@@ -129,11 +129,13 @@
129129
"\n",
130130
"Open a Terminal window if you do not already have one open. Remember, this can be done from the Launcher tab by clicking on \"Terminal\" button under the \"Other\" section, or by going to the \"File\" menu --> \"New\" --> \"Terminal\".\n",
131131
"\n",
132-
"Once in Terminal, navigate to where you would like your expedition to be run on your (virtual) machine (i.e. `cd data/storage-osl/{your-group-name}`). Then enter the following command in the Terminal (changing `EXPEDITION_NAME` to something more meaningful for your group's expedition):\n",
132+
"<div class=\"alert alert-block alert-warning\"> \n",
133+
"**IMPORTANT**: Once in Terminal, navigate to where you would like your expedition to be run on your (virtual) machine. You can do so by `cd /data/storage-osl/{your-group-name}`, replacing `{your-group-name}` with your actual group name. This is where you will be working from for the rest of the session.\n",
134+
"</div>\n",
135+
"\n",
136+
"Now enter the following command in the Terminal (changing `EXPEDITION_NAME` to something more meaningful for your group's expedition):\n",
133137
"\n",
134-
"```\n",
135-
"virtualship init EXPEDITION_NAME --from-mfp {CoordinatesExport}.xlsx\n",
136-
"```\n",
138+
"`virtualship init EXPEDITION_NAME --from-mfp {CoordinatesExport}.xlsx`\n",
137139
"\n",
138140
"<div class=\"alert alert-block alert-success\"> \n",
139141
"**TIP**: The `{CoordinatesExport}.xlsx` in the command above refers to the .xlsx file exported from MFP and uploaded to your virtual machine earlier. Replace the filename with the name of your .xlsx file.\n",
@@ -149,7 +151,7 @@
149151
"## 5) Expedition scheduling & ship configuration\n",
150152
"\n",
151153
"<div class=\"alert alert-block alert-success\"> \n",
152-
"**TIP**: From here, you should replace any references to `EXPEDITION_NAME` with the actual name you used for your expedition when running the `virtualship init` command.\n",
154+
"**TIP**: From here, you should replace any references to `EXPEDITION_NAME` with the actual name you used for your expedition when running any `virtualship` commands.\n",
153155
"</div>\n",
154156
"\n",
155157
"The next step is to finalise the expedition schedule plan, including setting times and instrument selection choices for each waypoint, as well as configuring the ship (including any underway measurement instruments). \n",
@@ -205,7 +207,7 @@
205207
"</div>\n",
206208
"\n",
207209
"<div class=\"alert alert-block alert-warning\"> \n",
208-
"**CAUTION**: The `virtualship plan` tool will check that the ship can reach each waypoint according to the prescribed ship speed (10 knots). However, before the ultimate [simulation step](#run-the-expedition) there will be a final, automated check that the schedule also accounts for the time taken to conduct the measurements at each site (e.g. a CTD cast in deeper waters will take longer). Therefore, we recommend to take this extra time into account at this stage of the planning by estimating how long each measurement will take and adding this time on.\n",
210+
"**CAUTION**: The `virtualship plan` tool will check that the ship can reach each waypoint according to the prescribed ship speed (10 knots). However, before the ultimate simulation step (i.e. step 6 below) there will be a final, automated check that the schedule also accounts for the time taken to conduct the measurements at each site (e.g. a CTD cast in deeper waters will take longer). Therefore, we recommend to take this extra time into account at this stage of the planning by estimating how long each measurement will take and adding this time on.\n",
209211
"</div>"
210212
]
211213
},
@@ -218,10 +220,12 @@
218220
"You are now ready to run your virtual expedition! This stage will take all the measurements for each of instruments you selected at each waypoint in your expedition schedule, using input data sourced from the [Copernicus Marine Data Store](https://data.marine.copernicus.eu/products).\n",
219221
"\n",
220222
"<div class=\"alert alert-block alert-info\"> \n",
221-
"**NOTE**: You will need to register for Copernicus Marine Service account (see [here](https://data.marine.copernicus.eu/register)), if you have not done so already.\n",
223+
"**NOTE**: You will need to register for a Copernicus Marine Service account (you can do so [here](https://data.marine.copernicus.eu/register)), if you have not done so already.\n",
222224
"</div>\n",
223225
"\n",
224-
"You can run your expedition simulation using the command: `virtualship run EXPEDITION_NAME`\n",
226+
"You can run your expedition simulation using the command: \n",
227+
"\n",
228+
"`virtualship run EXPEDITION_NAME`\n",
225229
"\n",
226230
"If this is your first time running VirtualShip, you will be prompted to enter your own Copernicus Marine Data Store credentials (these will be saved automatically for future use).\n",
227231
"\n",

0 commit comments

Comments
 (0)