Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
peterdesmet authored Aug 21, 2023
1 parent 108fc15 commit 2cf980b
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,25 @@ If you need the tools/services to transfer data (SFTP, S3) install these additio
pip install vptstools\[transfer\]
```

## Usage

_TODO: Quick reproducible example showing how a selection of h5 files can be converted to a vpts file._

## CLI endpoints

In addition to using functions in Python scripts, two vptstools functions can be called from the command line:

### transfer_baltrad
### [transfer_baltrad](https://enram.github.io/vptstools/api/vptstools.bin.html#module-vptstools.bin.transfer_baltrad)

CLI tool to move files from the Baltrad FTP server to an S3 bucket.

```shell
transfer_baltrad
```

Configuration is loaded from environmental variables:
Configuration is loaded from environmental variables.

- FTP_HOST: Baltrad FTP host ip address
- FTP_PORT: Baltrad FTP host port
- FTP_USERNAME: Baltrad FTP user name
- FTP_PWD: Baltrad FTP password
- FTP_DATADIR: Baltrad FTP directory to load data files from
- DESTINATION_BUCKET: AWS S3 bucket to write data to
- SNS_TOPIC: AWS SNS topic to report when routine fails
- AWS_PROFILE: AWS profile (mainly for local development)

### vph5_to_vpts
### [vph5_to_vpts](https://enram.github.io/vptstools/api/vptstools.bin.html#module-vptstools.bin.vph5_to_vpts)

CLI tool to aggregate/convert the [ODIM hdf5 bird profile](https://github.com/adokter/vol2bird/wiki/ODIM-bird-profile-format-specification)
files available on the aloft S3 bucket (as generated by [vol2bird](https://github.com/adokter/vol2bird)) to
Expand All @@ -57,6 +52,8 @@ The CLI checks the modified date of the uploaded ODIM hdf5 files and applies the
vph5_to_vpts --modified-days-ago=1
```

Configuration is loaded from environmental variables.

## Development instructions

See [contributing](docs/contributing.md) for a detailed overview and set of guidelines. If familiar with `tox`,
Expand Down

0 comments on commit 2cf980b

Please sign in to comment.