Installation#

ReLife is a python package and it is uploaded on the Python Package Index (PyPi). To install ReLife locally make sure :

Python 3.11 (or newer) is installed on your machine. For Linux users with a Debian based distribution, an appropriate version of Python is already installed if your OS is up-to-date. For Windows users, please go to python.org, read the documentation and install the appropriate Python version.
You created a new python virtual environment (e.g, relife). For Linux users, you may need to install python3.**-venv (where ** corresponds to your python version). If you don’t know what a Python virtual environment is, please go to docs.python.org, read and learn. You’re about to use a Python package so you must know the very basics of Python, including virtual environments.

Linux users (Debian based)#

Create and activate the virtual environment :

/usr/bin/python3.** -m venv <venv_location>/relife
source <venv_location>/relife/bin/activate

Then, install ReLife with pip :

pip install relife

Create and activate the virtual environment :

py -3.** -m venv <venv_location>\relife
.\<venv_location>\relife\Scripts\activate

Install ReLife with pip:

pip install relife

To install ReLife from source, go to relife repository. Clone the codebase and install ReLife with pip.

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

As a contributor, you may want to install optional dependencies (type checking, documentation builder, etc.). You can use this command instead :

pip install -e ".[dev]"