MacOS system requirements, conventions, and installation

System requirements

This toolkit is known to run on MacOS Catalina 10.15.x (latest update). We no longer test on previous versions of MacOS, although previous versions of MAT have been known to run straightforwardly on these platforms.

This toolkit depends on a number of external tools which must be installed before you install MAT. For the Mac version, they are:

Conventions

The conventions are identical to the Unix conventions.

Installation of full application

To prepare MacOS for installation of this toolkit, first ensure that you've installed the proper version of Java (if you want to use jCarafe). Then you should unzip the distribution (you must have already done that to read this). Assume <toolkit_dir> is the root directory of the distribution. For Python 2:

% cd <toolkit_dir>
% ./install.sh

or, if you don't want to use the executable named python in your path:

% cd <toolkit_dir>
% /<path>/<to>/python ./install.py

For Python 3:

% cd <toolkit_dir>
% ./install3.sh

or, if you don't want to use the executable named python3 in your path:

% cd <toolkit_dir>
% /<path>/<to>/python3 ./install.py

During the installation, you might be prompted for various paths and locations which the toolkit requires.

When the installation is complete, your runtime environment will be configured for you. If you want to do something fancy during your installation (e.g., use your own settings file, or store the task plugin record outside your installation), see install.py.

Installation of core Python library via pip

As of MAT 3.3, the core of MAT can also be distributed as a pip-compatible Python library. This library contains the core MAT APIs, but lacks the Web server, the jCarafe engine, the documentation, and the command-line tools. Its sole dependency, a library implementing the Kuhn-Munkres bipartite set alignment algorithm, is installed as a dependency when the pip module is installed (and is only needed for the pairer/scorer).

Upgrading dependencies, changing the configuration, or moving the installation

While it is possible to override MAT's runtime environment using environment variables, it's not recommended. So you may have to do something special if you want to change your installation in any way.