Skip to content

Commit

Permalink
Add more background info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Jun 19, 2024
1 parent ab94bf5 commit 6b7388e
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,20 @@

[![GitHub Discussion][github-discussions-badge]][github-discussions-link]

Reads ASOS station data from disk on the NSIDC archive to create a temporally and
geospatially indexed database to quickly search events.

> [!NOTE]
> TODO: Is this data available publicly and documented? How is it produced? Links!

## Install

For now, you can install from this repository. TODO: PyPI if we decide this package
should continue to exist and not be moved or renamed :)
For now, you can install from this repository.

> [!NOTE]
> TODO: Publish to PyPI if we decide this package should continue to exist and not be
> moved or renamed :)
```bash
pip install git+https://github.com/nsidc/aross-stations-db.git
Expand Down

0 comments on commit 6b7388e

Please sign in to comment.