Skip to content

Commit ea17e9b

Browse files
committed
point to information on expedition.yaml in rest of docs
1 parent 784fa57 commit ea17e9b

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

docs/user-guide/assignments/Sail_the_ship.ipynb

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,11 @@
156156
"\n",
157157
"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",
158158
"\n",
159+
"<div class=\"alert alert-block alert-info\"> \n",
160+
"**NOTE**: This section describes the process of finalising the expedition schedule and instrument selection using the `virtualship plan` application. This is the recommended way for most users but when expeditions become larger with many waypoints, it can become cumbersome to use the planning tool (note, using VirtualShip in a remote terminal / cloud-based environment can also introduce lag in the user-interface). **In this case, you may prefer to edit the** `expedition.yaml` **file directly (see [here](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/working_with_expedition_yaml.html) for more details on how to do so)**.\n",
161+
"</div>\n",
162+
"\n",
163+
"\n",
159164
"The easiest way to do so is to use the bespoke VirtualShip planning tool. Enter the following command in Terminal: `virtualship plan EXPEDITION_NAME`.\n",
160165
"\n",
161166
"\n",
@@ -294,7 +299,7 @@
294299
"name": "python",
295300
"nbconvert_exporter": "python",
296301
"pygments_lexer": "ipython3",
297-
"version": "3.12.9"
302+
"version": "3.12.12"
298303
}
299304
},
300305
"nbformat": 4,

docs/user-guide/quickstart.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ For advanced users: it is also possible to run the expedition initialisation ste
5858

5959
## 3) Expedition scheduling & ship configuration
6060

61+
```{important}
62+
This section describes the process of finalising the expedition schedule and instrument selection using the `virtualship plan` application. This is the recommended way for most users but when expeditions become larger with many waypoints, it can become cumbersome to use the planning tool (note, using VirtualShip in a remote terminal / cloud-based environment can also introduce lag in the user-interface). **In this case, you may prefer to edit the `expedition.yaml` file directly (see [here](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/working_with_expedition_yaml.html) for more details on how to do so)**.
63+
```
64+
6165
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 (such as its speed and underway measurement instruments). The easiest way to do so is to use the bespoke VirtualShip planning tool via the following command:
6266

6367
```

0 commit comments

Comments
 (0)