Skip to content

Commit 0c7e24f

Browse files
committed
Update README help messages
1 parent ab177a0 commit 0c7e24f

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,20 @@ Usage: virtualship [OPTIONS] COMMAND [ARGS]...
6464

6565
Options:
6666
--version Show the version and exit.
67-
--help Show this message and exit.
67+
--help Show this message and exit.
6868

6969
Commands:
70-
fetch Download the relevant data specified in an expedition directory...
70+
fetch Download input data for an expedition.
7171
init Initialize a directory for a new expedition, with an example...
72-
run Do the expedition.
72+
run Run the expedition.
7373
```
7474

7575
```console
7676
$ virtualship init --help
7777
Usage: virtualship init [OPTIONS] PATH
7878

79-
Initialize a directory for a new expedition, with an example configuration.
79+
Initialize a directory for a new expedition, with an example schedule and
80+
ship config files.
8081

8182
Options:
8283
--help Show this message and exit.
@@ -87,22 +88,29 @@ Options:
8788
$ virtualship fetch --help
8889
Usage: virtualship fetch [OPTIONS] PATH
8990

90-
Download the relevant data specified in an expedition directory (i.e., by
91-
the expedition config).
91+
Download input data for an expedition.
92+
93+
Entrypoint for the tool to download data based on space-time region provided
94+
in the schedule file. Data is downloaded from Copernicus Marine, credentials
95+
for which can be obtained via registration:
96+
https://data.marine.copernicus.eu/register . Credentials can be provided on
97+
prompt, via command line arguments, or via a YAML config file. Run
98+
`virtualship fetch` on a expedition for more info.
9299

93100
Options:
94-
--help Show this message and exit.
101+
--username TEXT Copernicus Marine username.
102+
--password TEXT Copernicus Marine password.
103+
--help Show this message and exit.
95104
```
96105

97106
```console
98107
$ virtualship run --help
99108
Usage: virtualship run [OPTIONS] PATH
100109

101-
Do the expedition.
110+
Run the expedition.
102111

103112
Options:
104113
--help Show this message and exit.
105-
106114
```
107115

108116
For examples, see [the tutorials section of our documentation](https://virtualship.oceanparcels.org/en/latest/tutorials/index.html).

0 commit comments

Comments
 (0)