diff --git a/README.md b/README.md index b94da2a..8fb692a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ - ## Documentation You can find the documentation for the project by following this link
https://filter-stations.netlify.app/ - Getting Started --------------- All methods require an API key and secret, which can be obtained by contacting TAHMO.
@@ -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.
- The ```Water_level``` class is used to retrieve water level data and coordinates of gauging stations.
-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. \ No newline at end of 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/}}, +}