Getting started

Operating system support

MCL has been developed in the GNU/Linux operating system. In particular, Debian based systems have been used. As a result, support for Windows and Mac OS X and other Unix systems have not been tested. Due to Python’s flexibility, MCL is likely to work on these platforms with a little more (undocumented) effort.

Obtaining the code

MCL can be checked out from the git repository using

git clone https://github.com/acfr/mcl <target>

where <target> is your local target directory.

Installation

This code supports installation using pip (via setuptools). To install from the cloned repository:

cd <target>
sudo pip install .

To uninstall the package:

pip uninstall mcl

Documentation

The MCL documentation can be read online. To build a local copy run:

cd <target>
make docs

The entry point of the documentation can then be found at:

<target>/doc/build/html/index.html

During compilation, Sphinx’ will attempt to apply the `Read the Docs theme. If this theme is not available, the default Sphinx theme will be used. To enable the Read the Docs theme, install the package via pip:

sudo pip install sphinx_rtd_theme