Metadata-Version: 2.4
Name: hibou
Version: 0.2.0
Author: Lilan FAUTREZ, Mathilde JOMÉ, Fabienne LOHOU, Antoine ROYER
Project-URL: Homepage, https://git.icare.univ-lille.fr/aeris-public/hibou
Project-URL: Documentation, https://pages.icare.univ-lille.fr/aeris-public/hibou/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: keras-tuner
Requires-Dist: matplotlib
Requires-Dist: metpy
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: rich
Requires-Dist: scipy
Requires-Dist: tensorflow
Requires-Dist: tensorflow-decision-forests
Provides-Extra: doc
Requires-Dist: sphinx>=7.0.1; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Requires-Dist: sphinx-autodocgen; extra == "doc"

# Heat flux estimation by regression calculation (HIBOU)

```
╭─┤HIBOU v.0.2.0├───────────────────────────────────┐
│  ___  ___  ___  ________  ________  ___  ___      │
│ |\  \|\  \|\  \|\   __  \|\   __  \|\  \|\  \     │
│ \ \  \_\  \ \  \ \  \|\ /\ \  \|\  \ \  \ \  \    │
│  \ \   __  \ \  \ \   __  \ \  \ \  \ \  \ \  \   │
│   \ \  \ \  \ \  \ \  \|\ /\ \  \_\  \ \  \_\  \  │
│    \ \__\ \__\ \__\ \_______\ \_______\ \_______\ │
│     \|__|\|__|\|__|\|_______|\|_______|\|_______| │
│                                                   │
│                     "\_  _/"                      │
│                    / _ "" _ \                     │
│                   / / \\// \ \                    │
│                   \ \_O||O_/ /                    │
│                   /\.. \/ ../\                    │
│                                                   │
└──┤Heat flux estImation By regressiOn calcUlation├─╯
```

> ⚠️  **Warning**
> This package is still under developement. You can report any issue using the [bug tracker](https://git.icare.univ-lille.fr/aeris-public/hibou/-/issues).
> Furthermore the user guide is not finished either.


## Description

HIBOU (Heat flux estImation By regressiOn calcUlation) is a Python package that allows to train an artificial neural network with data from average weather station and eddy-covariance fluxes so that it can predict fluxes from average weather data.


## Installation

The package is available from [PyPi](https://pypi.org/project/hibou/):
```
$ pip install hibou
```

You can install the package from sources with `pip` by running the following commands in a terminal:
```
$ git clone https://git.icare.univ-lille.fr/aeris-public/hibou
$ cd hibou
$ pip install -e .
```

The documentation is [available online](https://pages.icare.univ-lille.fr/aeris-public/hibou/index.html). Alternatively, you can also compile the documentation locally:
```
$ cd hibou/docs
$ pip install -r requirements.txt
$ make html
```

Then, you should open the file `hibou/docs/build/html/index.html` to open the compiled documentation in a web browser.


# License

This project is licensed under the GNU Affero General Public Licence v3.0. For more information please see the [LICENSE file](https://git.icare.univ-lille.fr/aeris-public/hibou/-/blob/f08c071a103406a2efaccdf634238231c2733101/LICENSE)

