2. Installation

2.1. Stable release

To install melusine, run this command in your terminal:

$ pip install melusine

This is the preferred method to install melusine, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

2.2. Optional dependencies

When running Melusine in production, users may want to limit the number of packages installed. For this purpose, Melusine makes use of optional dependencies. The command pip install melusine installs only the mandatory dependencies. Optional dependencies can be install as follows:

  • pip install melusine[viz] : Installs plotly and streamlit for visualization purposes

  • pip install melusine[exchange] : Installs exchangelib to connect Melusine with an Outlook Exchange mailbox

  • pip install melusine[transformers] : Installs transformers to train BERT-like models

  • pip install melusine[all] : Installs all the dependencies

2.3. From sources

The sources for melusine can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone https://github.com/MAIF/melusine

Or download the tarball:

$ curl  -OL https://github.com/MAIF/melusine

Once you have a copy of the source, you can install it with:

$ python setup.py install