Skip to content

Commit

Permalink
Kieni brief readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kaburia committed Sep 7, 2024
2 parents c21d682 + d32b758 commit 51d17b6
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@

## Documentation
You can find the documentation for the project by following this link<br>
https://filter-stations.netlify.app/


Getting Started
---------------
All methods require an API key and secret, which can be obtained by contacting TAHMO. <br>
Expand All @@ -14,4 +12,18 @@ All methods require an API key and secret, which can be obtained by contacting T
- The ```Interactive_maps``` class is used to plot weather stations on an interactive map.<br>
- The ```Water_level``` class is used to retrieve water level data and coordinates of gauging stations.<br>

For instructions on shedding weather stations based on your water level data and gauging station coordinates, please refer to the [water_level_pipeline.md](https://github.com/kaburia/filter-stations/blob/main/water_level_pipeline.md) file.
For instructions on shedding weather stations based on your water level data and gauging station coordinates, please refer to the [water_level_pipeline.md](https://github.com/kaburia/filter-stations/blob/main/water_level_pipeline.md) file.

## Citations

If you use this package in your research, please cite it using the following BibTeX entry:

```bibtex
@misc{filter-stations,
author = {Austin Kaburia},
title = {filter-stations},
year = {2024},
publisher = {Python Package Index},
journal = {PyPI},
howpublished = {\url{https://pypi.org/project/filter-stations/}},
}

0 comments on commit 51d17b6

Please sign in to comment.