You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/quickstart.md
+31-21Lines changed: 31 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,9 @@ This guide is intended to give a basic overview of how to plan, initialise and e
6
6
7
7
## Expedition route planning
8
8
9
-
> [!NOTE]
10
-
> This section describes the _custom_ expedition route planning procedure. There is also an option to proceed without your own route and you can instead use an example route, schedule and selection of measurements (see [Initialise the expedition](#initialise-the-expedition) for more details).
9
+
```{note}
10
+
This section describes the _custom_ expedition route planning procedure. There is also an option to proceed without your own route and you can instead use an example route, schedule and selection of measurements (see [Initialise the expedition](#initialise-the-expedition) for more details).
11
+
```
11
12
12
13
### NIOZ MFP tool
13
14
@@ -25,23 +26,26 @@ Once you have finalised your MFP expedition route, select "Export" on the right
25
26
26
27
## Expedition initialisation
27
28
28
-
> [!NOTE]
29
-
> VirtualShip is a command line interface (CLI) based tool. From this point on in the Quickstart we will be working predominantly via the command line.
30
-
> If you are unfamiliar with what a CLI is, see [here](https://www.w3schools.com/whatis/whatis_cli.asp) for more information.
29
+
```{note}
30
+
VirtualShip is a command line interface (CLI) based tool. From this point on in the Quickstart we will be working predominantly via the command line.
31
+
If you are unfamiliar with what a CLI is, see [here](https://www.w3schools.com/whatis/whatis_cli.asp) for more information.
32
+
```
31
33
32
34
You should now navigate to where you would like your expedition to be run on your (virtual) machine (i.e. `cd path/to/expedition/dir/`). Then run the following command in your CLI:
> The `CoordinatesExport.xslx` in the `virtualship init` command refers to the .xslx file exported from MFP. Replace the filename with the name of your exported .xslx file (and make sure to move it from the Downloads to the folder/directory in which you are running the expedition).
40
+
```{tip}
41
+
The `CoordinatesExport.xslx` in the `virtualship init` command refers to the .xslx file exported from MFP. Replace the filename with the name of your exported .xslx file (and make sure to move it from the Downloads to the folder/directory in which you are running the expedition).
42
+
```
40
43
41
44
This will create a folder/directory called `EXPEDITION_NAME` with two files: `schedule.yaml` and `ship_config.yaml` based on the sampling site coordinates that you specified in your MFP export. The `--from-mfp` flag indictates that the exported coordinates will be used.
42
45
43
-
> [!NOTE]
44
-
> It is also possible to run the expedition initialisation step without an MFP .xslx export file. In this case you should simply run `virtualship init EXPEDITION_NAME` in the CLI. This will write example `schedule.yaml` and `ship_config.yaml` files in the `EXPEDITION_NAME` folder/directory. These files contain example waypoints, timings and instrument selections, but can be edited or propagated through the rest of the workflow unedited to run a sample expedition.
46
+
```{note}
47
+
It is also possible to run the expedition initialisation step without an MFP .xslx export file. In this case you should simply run `virtualship init EXPEDITION_NAME` in the CLI. This will write example `schedule.yaml` and `ship_config.yaml` files in the `EXPEDITION_NAME` folder/directory. These files contain example waypoints, timings and instrument selections, but can be edited or propagated through the rest of the workflow unedited to run a sample expedition.
48
+
```
45
49
46
50
## Expedition scheduling & ship configuration
47
51
@@ -51,8 +55,9 @@ The next step is to finalise the expedition schedule plan, including setting tim
51
55
virtualship plan EXPEDITION_NAME
52
56
```
53
57
54
-
> [!TIP]
55
-
> Using the `virtualship plan` tool is optional. Advanced users can also edit the `schedule.yaml` and `ship_config.yaml` files directly if preferred.
58
+
```{tip}
59
+
Using the `virtualship plan` tool is optional. Advanced users can also edit the `schedule.yaml` and `ship_config.yaml` files directly if preferred.
60
+
```
56
61
57
62
The planning tool should look something like this and offers an intuitive way to make your selections:
58
63
@@ -74,30 +79,35 @@ You will need to enter dates and times for each of the sampling stations/waypoin
74
79
75
80
Each waypoint has its own sub-panel for parameter inputs (click on it to expand the selection options). Here, the time for each waypoint can be inputted. There is also an option to adjust the latitude/longitude coordinates and you can add or remove waypoints.
76
81
77
-
> [!NOTE]
78
-
> It is important to ensure that the timings for each station are realistic. There must be enough time for the ship to travel to each site at a realistic speed (~ 10 knots). The expedition schedule (and the ship's configuration) will be automatically verified when you press _Save Changes_ in the planning tool.
82
+
```{note}
83
+
It is important to ensure that the timings for each station are realistic. There must be enough time for the ship to travel to each site at a realistic speed (~ 10 knots). The expedition schedule (and the ship's configuration) will be automatically verified when you press _Save Changes_ in the planning tool.
84
+
```
79
85
80
-
> [!TIP]
81
-
> The MFP planning tool will give estimated durations of sailing between sites, usually at an assumed 10 knots sailing speed. This can be useful to refer back to when planning the expedition timings and entering these into planning tool.
86
+
```{tip}
87
+
The MFP planning tool will give estimated durations of sailing between sites, usually at an assumed 10 knots sailing speed. This can be useful to refer back to when planning the expedition timings and entering these into planning tool.
88
+
```
82
89
83
90
### Instrument selection
84
91
85
92
You should now consider which measurements are to be taken at each sampling site, and therefore which instruments selections will be required.
86
93
87
-
> [!TIP]
88
-
> Click [here](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#Measurement-Options) for more information on what measurement options are available, and a brief introduction to each instrument.
94
+
```{tip}
95
+
Click [here](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#Measurement-Options) for more information on what measurement options are available, and a brief introduction to each instrument.
96
+
```
89
97
90
98
Instrument selections can be made for each waypoint in the same sub-panels as the [waypoint time](#waypoint-datetimes) selection by simply switching each on or off. Multiple instruments are allowed at each waypoint.
91
99
92
-
> [!NOTE]
93
-
> For advanced users only: you can also make further customisations to behaviours of all instruments under _Ship Config Editor_ > _Instrument Configurations_.
100
+
```{note}
101
+
For advanced users only: you can also make further customisations to behaviours of all instruments under _Ship Config Editor_ > _Instrument Configurations_.
102
+
```
94
103
95
104
### Save changes
96
105
97
106
When you are happy with your ship configuration and schedule plan, press _Save Changes_.
98
107
99
-
> [!NOTE]
100
-
> On pressing _Save Changes_ the tool will check the selections are valid (for example the ship will be able to reach each waypoint in time). If they are, the changes will be saves to the `ship_config.yaml` and `schedule.yaml` files, ready for the next steps. If your selections are invalid you should be provided with information on how to fix them.
108
+
```{note}
109
+
On pressing _Save Changes_ the tool will check the selections are valid (for example the ship will be able to reach each waypoint in time). If they are, the changes will be saves to the `ship_config.yaml` and `schedule.yaml` files, ready for the next steps. If your selections are invalid you should be provided with information on how to fix them.
0 commit comments