Heat flux estimation by regression calculation (HIBOU)

╭─┤HIBOU v.0.1.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. 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

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. 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