Installation

Stable release

To install CLS, run this command in your terminal:

$ pip install cls_luigi

This is the preferred method to install CLS-Luigi, 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.

From sources

The sources for CLS-Luigi can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone https://github.com/cls-python/cls-luigi.git

Or download the tarball:

$ curl -OJL https://github.com/cls-python/cls-luigi/tarball/master

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

$ python setup.py install

CLS-Luigi on Windows

In its current state, CLS-Luigi has not yet been tested to run fully on Windows, as it has been developed mainly on Linux.

There will undoubtedly be restrictions since Luigi itself already defines restrictions for use under Windows. To learn more, please read the luigi documentation [Luigi on Windows] on the subject.

There are also general limitations due to the usage of the multiprocessing package under Windows, which is used by both Luigi and CLS-Python. For more information refere to the multiprocessing documentation [docs-multiprocessing, contexts-and-start-methods] on the subject.

CLS-Luigi in a Jupyter Notebook

At the time of writing, this hasn’t been truly tested yet.