HIBOU's documentation
======================

::

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


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 .

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>`_


Content
-------
.. toctree::
	:maxdepth: 2

	Home <self>
	User Guide <user_guide>
	Reference Guide <reference_guide>