Installing and loading the Matchete package

There are three ways for installing Matchete.


Regular installation

The simplest way to download and install Matchete is to run the following command in a Mathematica session:

Import["https://gitlab.com/matchete/matchete/-/raw/master/install.m"]

This will download and install the latest public release of Matchete in the Applications folder of Mathematica’s base directory, which can be found evaluating $UserBaseDirectory. To load Matchete use the command:

<< Matchete`

If you want to updated an already existing Matchete version, which was installed as described above, use the following function after having loaded the package:

CheckForUpdate[]

Manual installation

The latest release of Matchete can also be installed manually from the GitLab repository by downloading the zip file at: https://gitlab.com/matchete/matchete/-/archive/master/matchete-master.zip. If not done automatically on your system, unpack the downloaded file using unzip matchete-master, then rename the directory from matchete-master to matchete. To load Matchete use the command (path/to/ should be replaced by the path to the directory where the downloaded file is stored):

<< "path/to/Matchete`"

Advanced installation

If git is installed, Matchete can also be installed cloning the GitLab repository by running the following command in a terminal:

git clone git@gitlab.com:matchete/matchete.git

This way of installing also allows to use the development version of Matchete. To load Matchete use the command (path/to/ should be replaced by the path to the directory where the downloaded file is stored):

<< "path/to/Matchete`"

Note: If you installed Matchete manually and want to use the built-in documentation tools, we recommend creating a symbolic link in the base directory (FileNameJoin[{$UserBaseDirectory,"Applications"}]) pointing to the directory of your Matchete installation, which also simplifies loading the package. Afterwards, you can run once Matchete`PackageScope`LinkDocumentation[] to set up the documentation. This is not required when using the default installer.