Skip to content

Commit

Permalink
move callouts
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian-Katerndahl committed Oct 7, 2024
1 parent 428311c commit e9038d1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,15 @@ The account credentials need to be passed to the command line tools via CLI argu

#### Download

> [!NOTE]
> When supplying coordinates on the command line as is shown below, you need to end the coordinate string with two dashes (`--`).
> This stops the program from trying to parse any further arguments. In turn, this also means the AOI must be given as the last argument!
The snippet below queries the EarthExplorer catalogue for Landsat 8/9 Collection 2 Level 2 scenes between June 1st, 2020 and
July 25th, 2024 for a small part of the southwest of Berlin, Germany. Additionally, only scenes for August and September are
returned and they must have a cloudcover of no more than 15%. Results are stored in a directory called `download`. The user
set the logging level to `INFO` with the `-v` flag.

> [!NOTE]
> When supplying coordinates on the command line as is shown below, you need to end the coordinate string with two dashes (`--`).
> This stops the program from trying to parse any further arguments. In turn, this also means the AOI must be given as the last argument!
```bash
callusgs -v download --product landsat_etm_c2_l2 \
--date 2020-06-01 2024-07-25 --month aug sep \
Expand All @@ -91,10 +91,6 @@ No further restrictions regarding the obervation months or cloudcouver are posed
but as a dry run is requested, only the number of available scenes and their download size is reported. The user requested extended debug output with
the `-vv` flag.

> [!NOTE]
> When supplying coordinates on the command line as is shown below, you need to end the coordinate string with two dashes (`--`).
> This stops the program from trying to parse any further arguments. In turn, this also means the AOI must be given as the last argument!
```bash
callusgs -vv --dry-run download --product landsat_etm_c2_l1 \
--date 2005-01-01 2020-01-01 --aoi-type Mbr \
Expand Down
2 changes: 1 addition & 1 deletion docs/chapters/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ CLI Tools

``callusgs`` provides four command-line interface tools detailed below.

.. important::
.. note::
When supplying coordinates on the command line as is shown below, you need to end the coordinate string with two dashes (`--`).
This stops the program from trying to parse any further arguments. In turn, this also means the AOI must be given as the last argument!

Expand Down

0 comments on commit e9038d1

Please sign in to comment.