Metadata-Version: 2.1
Name: hydrogapai
Version: 0.6.0
Summary: HydroGAP-AI: Hydro-Gap Artificial Intelligence
Home-page: https://github.com/kperi/HydroGAP-AI
Author: Konstantinos Perifanos, Yiannis Kontons, Konstantinos Plataridis
Author-email: kostas.perifanos@gmail.com, ykontos81@gmail.com, platarid@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# HydroGAP-AI

TODO: Write a high level overview of the library

## Installation

You can install the library using the following command:

```bash
pip install hydrogapai
```

or directly from this repo using: 

```bash
pip install git+https://github.com/kperi/HydroGAP-AI.git
```

## Predict gaps in stations

### Usage

```python


from hydrogapai.gap_prediction import (
    predict_station_gaps,
)
station_file = "./data/lib/station_11.0_cleaned.csv"
results_folder = './output/test_run'

 
                


reall_combined_dfs, val_full, metrics_gaps, real_predictionst = predict_station_gaps(
    station_file,
    results_folder=results_folder,
    model_type=model_type,
    hyper_opt=False,
)
```

For a more detailed example of the library including outputs see this [notebook](./lib_demo.ipynb)
