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: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ For a development installation, please follow the instructions detailed in the [
64
64
See the [Quickstart guide](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html) in our documentation for a step-by-step introduction to using VirtualShip.
65
65
```
66
66
67
-
VirtualShip is run via the command line interface (CLI) using the `virtualship` command. It has three subcommands: `init`, `plan`, and `run`.
67
+
You can run the VirtualShip via the command line interface (CLI) using the `virtualship` command. It has three subcommands: `init`, `plan`, and `run`.
Copy file name to clipboardExpand all lines: docs/user-guide/quickstart.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ On pressing _Save Changes_ the tool will check the selections are valid (for exa
125
125
```
126
126
127
127
```{caution}
128
-
The `virtualship plan` tool will check that the ship can reach each waypoint according to the prescribed ship speed. 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, it is recommended to account for this time at this stage of the planning by estimating how long each measurement will take and adding this time on.
128
+
The `virtualship plan` tool will check that the ship can reach each waypoint according to the prescribed ship speed. 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.
129
129
```
130
130
131
131
## 4) Run the expedition
@@ -146,13 +146,13 @@ Your command line output should look something like this...
146
146
147
147

148
148
149
-
Low complexity simulations (e.g. small space-time domains and fewer instrument deployments) will be relatively fast. For large, complex expeditions, it _could_ take up to an hour to simulate the measurements depending on your choices. Waiting for simulation is a great time to practice your level of patience. A skill much needed in oceanographic fieldwork ;-)
149
+
Small simulations (e.g. small space-time domains and fewer instrument deployments) will be relatively fast. For large, complex expeditions, it _could_ take up to an hour to simulate the measurements depending on your choices. Waiting for simulation is a great time to practice your level of patience. A skill much needed in oceanographic fieldwork ;-)
150
150
151
151
Why not browse through previous real-life [blogs and expedition reports](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Sail_the_ship.html#Reporting) in the meantime?!
152
152
153
153
#### Using pre-downloaded data (optional)
154
154
155
-
By default, VirtualShip will stream data 'on-the-fly' from the Copernicus Marine Data Store, meaning no prior data download is necessary. However, should you wish to use pre-downloaded data instead (e.g. due to limited internet connection or wanting to use different input data) you can do so by adding the `--from-data` flag to the `virtualship run` command and specifying a `<PATH_TO_DATA_DIR>`.
155
+
By default, VirtualShip will stream data 'on-the-fly' from the Copernicus Marine Data Store, meaning no prior data download is necessary. However, if you prefer to use pre-downloaded data instead (e.g. due to limited internet connection or wanting to use different input data) you can do so by running `virtualship run EXPEDITION_NAME --from-data<PATH_TO_DATA_DIR>`.
156
156
157
157
Enter `virtualship run --help` to see the full description of the `--from-data` flag and its usage.
0 commit comments