Skip to content

Commit d957979

Browse files
committed
post review edits
1 parent 086852d commit d957979

2 files changed

Lines changed: 9 additions & 16 deletions

File tree

docs/user-guide/assignments/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Research_proposal_intro.ipynb
99
Research_Proposal_only.ipynb
1010
Virtualship_research_proposal.ipynb
1111
sciencecommunication_assignment.ipynb
12-
Sail_the_ship.ipynb
12+
<!-- Sail_the_ship.ipynb -->
1313
```

docs/user-guide/quickstart.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,28 @@ Feel free to design your expedition as you wish! There is no need to copy these
2222

2323
### Export the coordinates
2424

25-
Once you have finalised your MFP expedition route, select "Export" on the right hand side of the window --> "Export Coordinates" --> "DD". This will download your coordinates as an .xslx (Excel) file, which we will later feed into the VirtualShip protocol to initialise the expedition.
25+
Once you have finalised your MFP expedition route, select "Export" on the right hand side of the window --> "Export Coordinates" --> "DD". This will download your coordinates as an .xlsx (Excel) file, which we will later feed into the VirtualShip protocol to initialise the expedition.
2626

2727
## Expedition initialisation
2828

2929
```{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.
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 in the Terminal. If you are unfamiliar with what a CLI is, see [here](https://www.w3schools.com/whatis/whatis_cli.asp) for more information.
3231
```
3332

3433
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:
3534

3635
```
37-
virtualship init EXPEDITION_NAME --from-mfp CoordinatesExport.xslx
36+
virtualship init EXPEDITION_NAME --from-mfp CoordinatesExport.xlsx
3837
```
3938

4039
```{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).
40+
The `CoordinatesExport.xlsx` in the `virtualship init` command refers to the .xlsx file exported from MFP. Replace the filename with the name of your exported .xlsx file (and make sure to move it from the Downloads to the folder/directory in which you are running the expedition).
4241
```
4342

4443
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.
4544

4645
```{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.
46+
For advanced users: it is also possible to run the expedition initialisation step without an MFP .xlsx 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.
4847
```
4948

5049
## Expedition scheduling & ship configuration
@@ -71,7 +70,7 @@ In the planning tool, under _Ship Config Editor_ > _Ship Speed & Onboard Measure
7170

7271
VirtualShip is capable of taking underway temperature and salinity measurements, as well as onboard ADCP measurements, as the ship sails across the length of the expedition (see [here](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#Underway-Data) for more detail). These underway measurements can be switched on/off under _Ship Config Editor_ > _Ship Speed & Onboard Measurements_ as well.
7372

74-
For the underway ADCP, there is a choice of using the OceanObserver or SeaSeven version (see [here](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#ADCP) for more detail on the two ADCP types).
73+
For the underway ADCP, there is a choice of using the 38 kHz OceanObserver or the 300 kHz SeaSeven version (see [here](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#ADCP) for more detail on the two ADCP types).
7574

7675
### Waypoint datetimes
7776

@@ -98,7 +97,7 @@ Click [here](https://virtualship.readthedocs.io/en/latest/user-guide/assignments
9897
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.
9998

10099
```{note}
101-
For advanced users only: you can also make further customisations to behaviours of all instruments under _Ship Config Editor_ > _Instrument Configurations_.
100+
For advanced users: you can also make further customisations to behaviours of all instruments under _Ship Config Editor_ > _Instrument Configurations_.
102101
```
103102

104103
### Save changes
@@ -141,12 +140,6 @@ It might take up to an hour to simulate the measurements depending on your choic
141140

142141
Upon successfully completing the simulation, results from the expedition will be stored in the `EXPEDITION_NAME/results` directory, written as [Zarr](https://zarr.dev/) files.
143142

144-
If you are a working on a remote machine, download your results by navigating to `EXPEDITION_NAME/results` and running:
145-
146-
```
147-
zip -r results.zip results/
148-
```
149-
150-
From here you can carry on your analysis offline. We encourage you to explore and analyse these data using [Xarray](https://docs.xarray.dev/en/stable/). We also provide various further [VirtualShip tutorials](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/index.html) which provide examples of how to visualise data recorded by the VirtualShip instruments.
143+
From here you can carry on your analysis (offline). We encourage you to explore and analyse these data using [Xarray](https://docs.xarray.dev/en/stable/). We also provide various further [VirtualShip tutorials](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/index.html) which provide examples of how to visualise data recorded by the VirtualShip instruments.
151144

152145
<!-- TODO: Add a link to visualisation tool as an alternate option to own visualisation when/if this feature is implemented?! -->

0 commit comments

Comments
 (0)