INSTALL.rst

Installation

To install mlconjug3, you have multiple options:

Using pip:

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

To install mlconjug3, run this command in your terminal:

$ pip install mlconjug3

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

Using pipx:

Recommended for users who want to avoid conflicts with other Python packages.

$ pipx install mlconjug3

Using conda:

You can also install mlconjug3 by using Anaconda or Miniconda instead of pip. To install Anaconda or Miniconda, please follow the installation instructions on their respective websites. After having installed Anaconda or Miniconda, run these commands in your terminal:

$ conda config --add channels conda-forge
$ conda config --set channel_priority strict
$ conda install mlconjug3

If you already have Anaconda or Miniconda available on your system, just type this in your terminal:

$ conda install -c conda-forge mlconjug3

You can find detailed instructions for installing mlconjug3 on the Anaconda eco-system here: https://github.com/conda-forge/mlconjug3-feedstock#installing-mlconjug3

Warning

If you intend to install mlconjug3 on a Apple Macbook with an Apple M1 or M2 processor or newer, it is advised that you install mlconjug3 by using the conda installation method as all dependencies will be pre-compiled.

From sources

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

You can either clone the public repository:

$ git clone git://github.com/Ars-Linguistica/mlconjug3

Or download the tarball:

$ curl  -OL https://github.com/Ars-Linguistica/mlconjug3/tarball/master

Once you have a copy of the source, get in the source directory and you can install it with:

$ python setup.py install

Alternatively, you can use poetry to install the software:

$ pip install poetry

$ poetry install