Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 1.47 KB

README.md

File metadata and controls

29 lines (24 loc) · 1.47 KB
Raw

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.

  • The retreive_data class is used to retrieve data from the TAHMO API endpoints.
  • The Kieni class is used to get weather data for stations 100km around Kieni from the central point.
  • The Filter class is used to filter weather stations data based on things like distance and region.
  • The pipeline class is used to create a pipeline of filters to apply to weather stations based on how they correlate with water level data.
  • 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 file.

Citations

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

@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/}},
}