Skip to content

Commit

Permalink
Update pull.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tjzegmott committed Aug 10, 2023
1 parent e821c82 commit e850bce
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,22 @@
Downloading datasets requires a valid CADC certificate and the relevant
permissions on CANFAR.

![pull-help](images/pull-help.png)
<!-- termynal -->
```bash
$ datatrail pull --help
Usage: datatrail pull [OPTIONS] SCOPE DATASET

Download a dataset.

Options:
-d, --directory DIRECTORY Directory to pull data to.
-c, --cores INTEGER RANGE Number of parallel fetch processes to use.
[1<=x<=8]
-v, --verbose Verbosity: v=INFO, vv=DEBUG.
-q, --quiet Set log level to ERROR.
-f, --force Do not prompt for confirmation.
--help Show this message and exit.
```

To download a dataset from MINOC, we use `datatrail pull`. Without any flags,
this starts a single process to download the dataset. However, if you have
Expand Down

0 comments on commit e850bce

Please sign in to comment.