Installation

Note

Wheels are provided for Windows, Linux and OSX x86-64 platforms, as well as Linux and OSX Aarch64 platforms. Other machines will have to build the wheel from the source distribution. Building lightmotif involves compiling Rust code, which requires a Rust compiler to be available.

PyPi

lightmotif is hosted on GitHub, but the easiest way to install it is to download the latest release from its PyPi repository. It will install all dependencies then install lightmotif either from a wheel if one is available, or from source after compiling the Rust code :

$ pip install --user lightmotif

GitHub + pip

If, for any reason, you prefer to download the library from GitHub, you can clone the repository and install the repository by running (with the admin rights):

$ pip install -U git+https://github.com/althonos/lightmotif

Caution

Keep in mind this will install always try to install the latest commit, which may not even build, so consider using a versioned release instead.

GitHub + setuptools

If you do not want to use pip, you can still clone the repository and run the setup.py file manually, although you will need to install the build dependencies (mainly setuptools-rust):

$ git clone --recursive https://github.com/althonos/lightmotif
$ cd lightmotif
$ python setup.py build
# python setup.py install

Danger

Installing packages without pip is strongly discouraged, as they can only be uninstalled manually, and may damage your system.