### Navigation

- index
- modules |
- next |
- previous |
- Maja Machine Learning Framework v1.0 documentation »
- Tutorials »

# Installation

For installing of the most recent version of the MMLF, please download the tar.gz file from https://sourceforge.net/projects/mmlf/. Based on this file, the MMLF can either be installed locally or globally.

Note

The core MMLF requires that the python packages numpy, scipy, matplotlib, and pyyaml are installed. If you want to use the graphical user interface, the PyQt4 package is required additional. Specific configurations of agents may require additional packages; however, most of the MMLF should be usable when the core dependencies are fulfilled. The easiest way to install the dependencies depends on your operating system. Under Windows you may use the python(x,y) distribution. Under Mac OSX, you may use MacPorts, and under Linux, your packaging tool will most likely ship these packages out-of-the-box.

## Local Installation

This kind of installation is most useful for developers that don’t have access to the MMLF revision control system. Installing MMLF locally means to simply extract the tar.gz archive. The resulting directory consists of the mmlf package, this documentation, the configuration directory, and two python-scripts: run_mmlf (for running MMLF in a non-graphical way) and mmlf_gui (for starting a GUI which allows to configure and run the MMLF). The additional script setup.py is required for installing the MMLF globally. Running the MMLF via the scripts run_mmlf and mmlf_gui is possible without requiring any further adjustments (see Quick Start Tutorial). If the MMLF should be made available for other python code, please add the directory into which you extracted the MMLF to your pythonpath. Now it should be possible to “import mmlf” from interactive python interpreter session. Any changes made in the code in the mmlf directory are directly active (changes to config files should be made in the .mmlf directory however (see below)).

## Global Installation

This kind of installation is most useful for people that don’t want to modify or extend the MMLF but just to use it. It allows to install the MMLF in a way that all users of a system can use it. For this, extract the tar.gz archive and run “python setup.py install”. This command may require super user privileges. This command uses the Python Distribution Utilities (distutils) to install the MMLF into the site-packages/dist-packages of your python distribution. You can now “import mmlf” and run the mmlf via “run_mmlf” (for running MMLF in a non-graphical way) and “mmlf_gui” (for starting a GUI which allows to configure and run the MMLF). See Quick Start Tutorial for more informations.

Note

Global installation copies the MMLF’s config files into “/etc/mmlf” (unixoid operating system) and “$APPDATA/mmlf” (Windows) respectively. However, the data in these directories is not meant for modifcation but only corresponds to some default world setups. Instead, modify the configuration files in the .mmlf directory that is created after the first start of the MMLF. For more information on that, see Quick Start Tutorial

See also

Tutorial Quick start (command line interface)
  Learn how to use the MMLF with a non-grapical user interface
Tutorial Quick start (graphical user interface)
  Learn how to use the MMLF’s graphical user interface

### Navigation

- index
- modules |
- next |
- previous |
- Maja Machine Learning Framework v1.0 documentation »
- Tutorials »