Metadata-Version: 2.4
Name: relife
Version: 2.8.0
Summary: Package for optimizing infrastructure investment decisions in Python
Author-email: Thomas Guillon <thomas.guillon@rte-france.com>
Maintainer-email: William Grison <william.grison@rte-france.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/rte-france/relife
Project-URL: Documentation, http://opensource.rte-france.com/relife/
Project-URL: Issues, https://github.com/rte-france/relife/issues
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.4.3
Requires-Dist: numpydoc>=1.10.0
Requires-Dist: optype[numpy]>=0.17.0
Requires-Dist: scipy>=1.17.1
Requires-Dist: typing-extensions>=4.15.0
Dynamic: license-file

<h1 align="center">
  <img src="docs/source/_static/small_relife.gif" />
</h1></br>

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

```bash
$ python -m pip install relife
```

**From source**

```bash
$ 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.

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

## Development tools

We use [ruff](https://docs.astral.sh/ruff/) as linter and formatter.
We currently use [basedpyright](https://docs.basedpyright.com/latest/) as Python type checker and LSP server. In a near future, we may move to [ty](https://docs.astral.sh/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](https://github.com/pydata/pydata-sphinx-theme) project. Original license
  is [here](doc/LICENSE.txt)
- Some parts of the documentation are highly inspired by [Scikit-learn](https://scikit-learn.org/stable/), [Scipy](https://scipy.org/) and [NumPy](https://numpy.org/)
