To obtain and set up MMT, perform the following steps:
MMT targets Java 8
(both OpenJDK
and OracleJDK
are supported), and preliminary support for Java 9
exists. Java 11
works as well. Java 7
is no longer officially supported.
This step is optional but highly recommended if you want to write or view MMT files. If you just want to sample MMT, you should definitely do it with an IDE.
jEdit is a Java-based text editor. MMT includes a jEdit plugin, which turns jEdit into an IDE for MMT.
Concretely:
IntelliJ IDEA is a Java-based multi-purpose IDE. The official IntelliJ Plugin repository (accessible from within the IDE under File -> Settings -> Plugins -> Marketplace) includes an MMT Plugin, which can be installed directly from within the Marketplace. The IntelliJ MMT-Plugin is documented here.
MMT uses git internally, so make sure it is installed.
There are two options for this step:
The file mmt.jar
provides a self-contained executable file.
mmt.jar
is released roughly every 2 months.
A list of releases can be found on the GitHub Releases page.
The latest one can be downloaded by clicking the top most item on the list.
Clone the MMT repository from GitHub:
git clone git@github.com:UniFormal/MMT.git
Alternatively, if you do not have ssh keys set up, use
git clone https://github.com/UniFormal/MMT.git`
A detailed explanation of the contents of the repository is available here.
MMT is currently built for Scala 2.12.3
(incuded in the repository) and building is done with sbt (the Scala build tool).
If you do not have sbt, you can get it here.
To build, execute
cd MMT/src
sbt mmt/deploy
(Detailed instructions for building can be found here).
This creates many files, in particular the file mmt.jar
in the folder ../deploy/
.
Change to that directory:
cd ../deploy/
Besides mmt.jar
, this directory contains executable scripts (for Windows and Unix) to for running MMT.
If you only want to use MMT from within IntelliJ, you can skip this step.
In the previous, you obtained the file mmt.jar
(by downloading or building).
To start setup open a shell and run java -jar mmt.jar
.
On Windows, this assumes that git
can be called from within sh
, which means sh
has to be in your PATH; depending on how you installed git
, this may already be the case. If it is not in your PATH, you can also directly issue the java -jar mmt.jar
command from within Git Bash from an existing Git for Windows installation.
This triggers the setup dialog which does the following:
Further instructions for setting up jEdit are available here.
If you want to use MMT via an IDE, you do not have to run MMT itself.
It will act as a plugin within jEdit or IntelliJ: just start jEdit and open .mmt
files, or start a new MathHub-project within IntelliJ.
Developers or advanced users may want to run MMT directly for various other applications.
The canonical way for this is to run java -jar mmt.jar
.
(This responds with a simple setup dialog if MMT not installed, and drops to a shell otherwise.)
But depending on your OS and configuration, double-clicking or executing mmt.jar
may also work.
Additional instructions for running MMT are available here.
This step is not part of the initial setup. It is only needed later when updating your MMT installation to the latest release.
To update MMT, replace the file mmt.jar
, i.e.,
deploy/mmt.jar
To rerun setup, execute
java -jar mmt.jar :setup
However, rerunning the full setup is usually not necessary. To update your jEdit instance, execute
java -jar mmt.jar :jeditsetup install