Metadata-Version: 2.4
Name: energnn
Version: 0.2.0
Summary: A Graph Neural Network library for real-life energy networks.
Author-email: Balthazar DONON <balthazar.donon@rte-france.com>, Geoffroy JAMGOTCHIAN <geoffroy.jamgotchian@rte-france.com>, Hugo KULESZA <hugo.kulesza@rte-france.com>, Steve NOUATIN <steve.nouatin_externe@rte-france.com>
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: chex>=0.1.0
Requires-Dist: cloudpickle<3
Requires-Dist: diffrax>=0.7.0
Requires-Dist: equinox>=0.13.0
Requires-Dist: fastdigest==0.8.3
Requires-Dist: flatdict==4.0.0
Requires-Dist: flax>=0.12.0
Requires-Dist: hydra-core==1.3.2
Requires-Dist: ipykernel>=7.2.0
Requires-Dist: jax>=0.9
Requires-Dist: mlflow
Requires-Dist: optax>=0.2.6
Requires-Dist: orbax>=0.1.9
Requires-Dist: pandas>=2.2.2
Requires-Dist: tqdm==4.67.0
Provides-Extra: gpu
Requires-Dist: jax[cuda12]; extra == 'gpu'
Description-Content-Type: text/markdown

# EnerGNN

A Graph Neural Network library for real-life energy networks.

## Build

To build this package locally, you can use one of the following commands at the root of the project:

```cmd
uv sync
```

```cmd
uv sync --extra gpu
```

The first one will install the `energnn` package with only CPU support.

Use the second one to also install the GPU extra dependencies (obtained from `jax[cuda12]`).

## Documentation

To build and access the documentation, run the following:

```shell
cd docs
make html
open _build/html/index.html
```

## Supporting Institutions

| RTE                                                                                                                                                | Université de Liège                                                                                                                                | INRIA                                                                                                                                                |
|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| <img src="docs/_static/rte_white.png#gh-dark-mode-only" height="100px"/> <img src="docs/_static/rte_black.png#gh-light-mode-only" height="100px"/> | <img src="docs/_static/ulg_white.png#gh-dark-mode-only" height="100px"/> <img src="docs/_static/ulg_black.png#gh-light-mode-only" height="100px"/> | <img src="docs/_static/inria_white.png#gh-dark-mode-only" width="160px"/> <img src="docs/_static/inria_black.png#gh-light-mode-only" width="160px"/> |

## Cite Us

```bibtex
@software{energnn,
    author = {{Committers of EnerGNN}},
    title = {{EnerGNN: A Graph Neural Network library for real-life Energy networks.}},
    url = {https://github.com/energnn},
}
```