Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
trey-stafford committed Oct 18, 2023
1 parent 645833d commit bbaae58
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,22 @@ $ conda activate pm_tb_data

## Usage

TODO
`seaice_ecdr` is primarily interacted with through it's CLI. To utilize the CLI,
use the provided `scripts/cli.sh`:

```
$ ./scripts/cli.sh --help
Usage: python -m seaice_ecdr.cli.entrypoint [OPTIONS] COMMAND [ARGS]...
Run the Sea Ice EDCDR.
Options:
--help Show this message and exit.
Commands:
idecdr Run the initial daily ECDR algorithm with AMSR2 data.
nrt Run NRT Sea Ice ECDR.
```

## Development/contributing

Expand Down

0 comments on commit bbaae58

Please sign in to comment.