README.md

An open-source Python library for optimizing large-scale infrastructure investment decisions.

• Documentation: http://opensource.rte-france.com/relife/
• Contributing: http://opensource.rte-france.com/relife/developper/index.html
• Bug reports: https://github.com/rte-france/relife/issues

Warning

Releases started from 1.0.0 version but the package API is still changing a lot.

Installation

From PyPi

$ python -m pip install relife

From source

$ git clone https://github.com/rte-france/relife.git
$ cd relife
$ python -m pip install .

For developpers

If you wish to work on the codebase, install ReLife with the packages included in the dev group. Using the editable mode (-e) is recommanded.

$ git clone https://github.com/rte-france/relife.git
$ cd relife
$ python -m pip install -e . --group dev

Development tools

We use ruff as linter and formatter. We currently use basedpyright as Python type checker and LSP server. In a near future, we may move to ty.

Citing

@misc{relife,
    author = {T. Guillon},
    title = {ReLife: a Python package for asset management based on reliability theory and lifetime data analysis.},
    year = {2022},
    journal = {GitHub},
    howpublished = {\url{https://github.com/rte-france/relife}},
}

Credits

• The documentation uses pydata-sphinx-theme project. Original license is here
• Some parts of the documentation are highly inspired by Scikit-learn, Scipy and NumPy