<commit_before>
Installation {#sec:installation}
============


We explain below how to install Tamarin on different operating systems:
[Linux](#sec:linux),  [Mac
OS X](#sec:macosx), and [Microsoft Windows](#sec:windows).

Linux {#sec:linux}
-----

### Compiling from source {#sec:LinuxSrcInstall}

To run Tamarin on Linux\index{Linux}, a number of dependencies
must be installed, namely GraphViz and Maude 2.7. You can install
GraphViz using your standard package manager or directly from
<http://www.graphviz.org/>. You can also
install Maude using your
package manager.  However, if your package manager installs Maude 2.6,
then you must install version 2.7.1, [Core Maude
2.7.1](http://maude.cs.illinois.edu/w/index.php?title=Maude_download_and_installation#Core_Maude_2.7.1),
directly from <http://maude.cs.illinois.edu/>.
In this case, you should ensure
that your `PATH` includes the install path, so that
calling `maude` starts version 2.7.1. Note that even though the Maude
executable is movable, the `prelude.maude` file must be in the same
folder that you start Maude from.

Once these dependencies have been installed, you can then compile
Tamarin from source, using either the stable master or current development version.

To help compile Tamarin from source, we manage Haskell dependencies
automatically using the tool `stack`. You must first install
`stack`, following the instructions given at
[Stack's install page](https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md). In case you are installing `stack` with your package manager (particularly on Ubuntu), you must run `stack upgrade` afterwards, as that version of stack is usually out-of-date.

After running `git clone` on the Tamarin
repository, you have the current development version ready for
compilation. If you would prefer to use the master version, just run
`git checkout master`. In either case, you can then run `make
default`, which will install an appropriate GHC (the Glasgow Haskell Compiler)
for your system,
including all dependencies, and the `tamarin-prover` executable
will be copied to `~/.local/bin/tamarin-prover`.
Note that this process will take between 30 and 60 minutes, as all
dependencies (roughly 120) are compiled from scratch. If you later pull a newer
version of Tamarin (or switch to/from the `master` branch), then only
the tool itself needs to be recompiled, which takes a few minutes, at most.

Continue as described in Section [Running Tamarin](#sec:running-tamarin) to run Tamarin for the first time.


### Automatic Installation of Tamarin {#sec:LinuxBinInstall}

The fastest way to install Tamarin on Linux is to use [Linuxbrew](http://linuxbrew.sh/). Linuxbrew is a fork of Homebrew, the Mac OS package manager,
for Linux.

To install Linuxbrew follow the [Installation Instructions](https://github.com/Linuxbrew/brew#install-linuxbrew-tldr).

If you already have this installed, it is as simple as running the following two commands in your terminal:

  * `brew install tamarin-prover/tap/tamarin-prover`

You can now run Tamarin from the command line by typing `tamarin-prover`.
Continue as described in Section [Running Tamarin](#sec:running-tamarin) to
run Tamarin for the first time.


### Automatic Installation for Arch Linux {#sec:ArchLinuxBinInstall}

There is a package in the official repositories. To install it, simply type:

  * `pacman -S tamarin-prover`

### Automatic Installation for Nix/NixOS {#sec:NixBinInstall}

There is a package in the official Nixpkgs repository. To install it, simply type:

  * `nix-env -i tamarin-prover`

This installs a per-user copy of Tamarin. If you're on NixOS, just add `tamarin-prover` to your
`environment.systemPackages` for system-wide installation.

Mac OS X {#sec:macosx}
--------

### Automatic Installation of Tamarin {#sec:MacOSBinInstall}

The fastest way to install Tamarin on Mac OS X is to use [Homebrew](http://brew.sh/):

  * `brew install tamarin-prover/tap/tamarin-prover`

You can now run Tamarin from the command line by typing `tamarin-prover`.
Continue as described in Section [Running Tamarin](#sec:running-tamarin) to
run Tamarin for the first time.

If you want to install Tamarin from source through Homebrew, simply use: <commit_msg>Add untap comment to linuxbrew instructions too<commit_after>
Installation {#sec:installation}
============


We explain below how to install Tamarin on different operating systems:
[Linux](#sec:linux),  [Mac
OS X](#sec:macosx), and [Microsoft Windows](#sec:windows).

Linux {#sec:linux}
-----

### Compiling from source {#sec:LinuxSrcInstall}

To run Tamarin on Linux\index{Linux}, a number of dependencies
must be installed, namely GraphViz and Maude 2.7. You can install
GraphViz using your standard package manager or directly from
<http://www.graphviz.org/>. You can also
install Maude using your
package manager.  However, if your package manager installs Maude 2.6,
then you must install version 2.7.1, [Core Maude
2.7.1](http://maude.cs.illinois.edu/w/index.php?title=Maude_download_and_installation#Core_Maude_2.7.1),
directly from <http://maude.cs.illinois.edu/>.
In this case, you should ensure
that your `PATH` includes the install path, so that
calling `maude` starts version 2.7.1. Note that even though the Maude
executable is movable, the `prelude.maude` file must be in the same
folder that you start Maude from.

Once these dependencies have been installed, you can then compile
Tamarin from source, using either the stable master or current development version.

To help compile Tamarin from source, we manage Haskell dependencies
automatically using the tool `stack`. You must first install
`stack`, following the instructions given at
[Stack's install page](https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md). In case you are installing `stack` with your package manager (particularly on Ubuntu), you must run `stack upgrade` afterwards, as that version of stack is usually out-of-date.

After running `git clone` on the Tamarin
repository, you have the current development version ready for
compilation. If you would prefer to use the master version, just run
`git checkout master`. In either case, you can then run `make
default`, which will install an appropriate GHC (the Glasgow Haskell Compiler)
for your system,
including all dependencies, and the `tamarin-prover` executable
will be copied to `~/.local/bin/tamarin-prover`.
Note that this process will take between 30 and 60 minutes, as all
dependencies (roughly 120) are compiled from scratch. If you later pull a newer
version of Tamarin (or switch to/from the `master` branch), then only
the tool itself needs to be recompiled, which takes a few minutes, at most.

Continue as described in Section [Running Tamarin](#sec:running-tamarin) to run Tamarin for the first time.


### Automatic Installation of Tamarin {#sec:LinuxBinInstall}

The fastest way to install Tamarin on Linux is to use [Linuxbrew](http://linuxbrew.sh/). Linuxbrew is a fork of Homebrew, the Mac OS package manager,
for Linux.

To install Linuxbrew follow the [Installation Instructions](https://github.com/Linuxbrew/brew#install-linuxbrew-tldr).

If you already have this installed, it is as simple as running the following two commands in your terminal:

  * `brew install tamarin-prover/tap/tamarin-prover`

You can now run Tamarin from the command line by typing `tamarin-prover`.
Continue as described in Section [Running Tamarin](#sec:running-tamarin) to
run Tamarin for the first time.

Note that Tamarin was previously distributed in the now-closed `homebrew-science`
tap. If you have already installed it through Linuxbrew, you will have to uninstall
and untap that version first:

  * `brew uninstall tamarin-prover`
  * `brew untap homebrew/science`

### Automatic Installation for Arch Linux {#sec:ArchLinuxBinInstall}

There is a package in the official repositories. To install it, simply type:

  * `pacman -S tamarin-prover`

### Automatic Installation for Nix/NixOS {#sec:NixBinInstall}

There is a package in the official Nixpkgs repository. To install it, simply type:

  * `nix-env -i tamarin-prover`

This installs a per-user copy of Tamarin. If you're on NixOS, just add `tamarin-prover` to your
`environment.systemPackages` for system-wide installation.

Mac OS X {#sec:macosx}
--------

### Automatic Installation of Tamarin {#sec:MacOSBinInstall}

The fastest way to install Tamarin on Mac OS X is to use [Homebrew](http://brew.sh/):

  * `brew install tamarin-prover/tap/tamarin-prover`

You can now run Tamarin from the command line by typing `tamarin-prover`.
Continue as described in Section [Running Tamarin](#sec:running-tamarin) to
run Tamarin for the first time.

If you want to install Tamarin from source through Homebrew, simply use: 
{'fraction_non_alphanumeric': 0.08366443410148712, 'fraction_numerical': 0.005221932114882507, 'mean_word_length': 4.819022457067371, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '320990', 'n_tokens_mistral': 2558, 'n_tokens_neox': 2427, 'n_words': 1139}