# Python Library for Hydrological Data Retrieval and Analysis in Brazil
The `acquabr` library offers a comprehensive set of tools and functionalities tailored for hydrological analysis of data within Brazil. It comprises classes such as `HidroWeb`, `DataToolkit`, and `GeoToolKit`, designed to facilitate data manipulation, analysis, and visualization of crucial meteorological parameters including rainfall, flow, and river levels.
## Features
- Seamless integration with the HIDROWEB platform, allowing efficient retrieval of hydrological data. [Access HIDROWEB](https://www.snirh.gov.brhidroweb/apresentacao)
- Robust tools for data preprocessing, advanced statistical analysis, and intuitive visualization of time series datasets.
- Calculation of precise distances between monitoring stations and elevation extraction utilizing high-resolution SRTM data.
## Installation
You can easily install the library using pip:
```bash
pip install acquabr
```
## Usage
The library's classes empower hydrologists, data scientists, and researchers to streamline their analyses and gain valuable insights from hydrological and geospatial datasets. Below are brief descriptions of the three main classes provided by `acquabr`:
### HidroWeb
The `HidroWeb` class serves as a pivotal component for automated data retrieval and processing from the HIDROWEB portal. This facilitates obtaining details about monitoring stations and daily time series data for rainfall, flow, and river levels.
### DataToolkit
The `DataToolkit` class offers a versatile and comprehensive approach for manipulation and analysis of hydrological time series datasets. This includes crucial information related to rainfall, flow, and river levels. The class provides an array of functionalities, such as preprocessing, statistical analysis, resampling, and identifying optimal time windows.
### GeoToolKit
The `GeoToolKit` class provides a powerful toolkit for geospatial data operations, tailored specifically for hydrological analyses. It enables users to manipulate and analyze hydrological station data, calculate distances between geographic coordinates, and retrieve elevation data using the SRTM model.
## Exemplos de Uso
Aqui estão alguns exemplos de como você pode usar as classes da biblioteca:
### HidroWeb
```python
import acquabr
hidro = acquabr.HidroWeb()
stations = hidro.getStation(code='12345678')
print(stations)
```
### DataToolkit
```python
import acquabr
data_toolkit = acquabr.DataToolkit()
```
### GeoToolkit
```python
import acquabr
data_toolkit = acquabr.DataToolkit()
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "acquabr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "hydrology,hydrological analysis,rainfall data Brazil,flow data Brazil,HIDROWEB,rainfall analysis,flow analysis,Brazil rainfall,Brazil flow",
"author": "Leonardo Maciel de Sousa",
"author_email": "leonardo.maciel3@academico.ufpb.br",
"download_url": "https://files.pythonhosted.org/packages/54/03/995f303e191df28e451d46365bd46f2733dffed473c64d5401fa76e7f3ff/acquabr-0.1.1.tar.gz",
"platform": null,
"description": "# Python Library for Hydrological Data Retrieval and Analysis in Brazil\r\n\r\nThe `acquabr` library offers a comprehensive set of tools and functionalities tailored for hydrological analysis of data within Brazil. It comprises classes such as `HidroWeb`, `DataToolkit`, and `GeoToolKit`, designed to facilitate data manipulation, analysis, and visualization of crucial meteorological parameters including rainfall, flow, and river levels.\r\n\r\n## Features\r\n\r\n- Seamless integration with the HIDROWEB platform, allowing efficient retrieval of hydrological data. [Access HIDROWEB](https://www.snirh.gov.brhidroweb/apresentacao)\r\n- Robust tools for data preprocessing, advanced statistical analysis, and intuitive visualization of time series datasets.\r\n- Calculation of precise distances between monitoring stations and elevation extraction utilizing high-resolution SRTM data.\r\n\r\n## Installation\r\n\r\nYou can easily install the library using pip:\r\n\r\n```bash\r\npip install acquabr\r\n\r\n```\r\n\r\n## Usage\r\n\r\nThe library's classes empower hydrologists, data scientists, and researchers to streamline their analyses and gain valuable insights from hydrological and geospatial datasets. Below are brief descriptions of the three main classes provided by `acquabr`:\r\n\r\n### HidroWeb\r\n\r\nThe `HidroWeb` class serves as a pivotal component for automated data retrieval and processing from the HIDROWEB portal. This facilitates obtaining details about monitoring stations and daily time series data for rainfall, flow, and river levels.\r\n\r\n### DataToolkit\r\n\r\nThe `DataToolkit` class offers a versatile and comprehensive approach for manipulation and analysis of hydrological time series datasets. This includes crucial information related to rainfall, flow, and river levels. The class provides an array of functionalities, such as preprocessing, statistical analysis, resampling, and identifying optimal time windows.\r\n\r\n### GeoToolKit\r\n\r\nThe `GeoToolKit` class provides a powerful toolkit for geospatial data operations, tailored specifically for hydrological analyses. It enables users to manipulate and analyze hydrological station data, calculate distances between geographic coordinates, and retrieve elevation data using the SRTM model.\r\n\r\n\r\n## Exemplos de Uso\r\n\r\nAqui est\u00e3o alguns exemplos de como voc\u00ea pode usar as classes da biblioteca:\r\n\r\n\r\n### HidroWeb\r\n\r\n```python\r\nimport acquabr\r\n\r\nhidro = acquabr.HidroWeb()\r\nstations = hidro.getStation(code='12345678')\r\nprint(stations)\r\n\r\n```\r\n\r\n### DataToolkit\r\n\r\n```python\r\nimport acquabr\r\n\r\n\r\ndata_toolkit = acquabr.DataToolkit()\r\n\r\n```\r\n\r\n### GeoToolkit\r\n\r\n\r\n```python\r\nimport acquabr\r\n\r\n\r\ndata_toolkit = acquabr.DataToolkit()\r\n\r\n```\r\n\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Python Library for Hydrological Analysis in Brazil",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"hydrology",
"hydrological analysis",
"rainfall data brazil",
"flow data brazil",
"hidroweb",
"rainfall analysis",
"flow analysis",
"brazil rainfall",
"brazil flow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5403995f303e191df28e451d46365bd46f2733dffed473c64d5401fa76e7f3ff",
"md5": "0532d199401e81c5f97639db79cdaf35",
"sha256": "63de5c1cc09e8e3b332465f0406656e1fe0f6287b5f629f251729f3d8e6a7311"
},
"downloads": -1,
"filename": "acquabr-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0532d199401e81c5f97639db79cdaf35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16267,
"upload_time": "2023-08-13T19:39:47",
"upload_time_iso_8601": "2023-08-13T19:39:47.321494Z",
"url": "https://files.pythonhosted.org/packages/54/03/995f303e191df28e451d46365bd46f2733dffed473c64d5401fa76e7f3ff/acquabr-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-13 19:39:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "acquabr"
}
JSON