Installation¶

Binary Install¶

Windows¶

For Windows systems an installer is provided in the TorXakis github project’s releases page.

MacOS¶

For macOS systems we provide a homebrew package. To install TorXakis run:

brew tap torxakis/torxakis
brew install torxakis

For more detailed instructions see the Homebrew tap for TorXakis.

Linux¶

For debian based systems¶

We provide a deb package for Debian based systems (Debian, Ubuntu, etc). Below we give instructions on how to install TorXakis on Ubuntu 20.04.

Download the latest deb package for TorXakis from the TorXakis github project’s releases page and then run the following commands:

apt-get update
apt-get install ./torxakis_0.9.0-ubuntu_20.04-amd64.deb -y

Now you can launch TorXakis from the commandline with the command torxakis.

The deb package also installs the specific versions of cvc4 and z3 tools which TorXakis requires when running.

For all distributions and (recent) releases¶

We provide TorXakis packaged as an AppImage which is a portable package format which works on all linux distributions and (recent) releases. The TorXakis Appimage is a software bundle which contains everything to run TorXakis. It therefore also contains the specific versions of cvc4 and z3 tools which TorXakis requires when running.

To run the AppImage, simply download it from the github’s release page, make it executable and we then can just run it:

$ wget https://github.com/TorXakis/TorXakis/releases/download/v0.9.0/torxakis-0.9.0.x86_64.AppImage
$ chmod a+x torxakis-0.9.0.x86_64.AppImage
$ ./torxakis-0.9.0.x86_64.AppImage

Install the AppImage in a directory in your shell’s PATH with the convenient torxakis alias:

$ BINDIR=/usr/local/bin    # an alternative is ~/bin in your home directory
$ mv torxakis-0.9.0.x86_64.AppImage $BINDIR/
$ ln -s torxakis-0.9.0.x86_64.AppImage $BINDIR/torxakis

By using a softlink for torxakis we can easily switch to a different version of the AppImage.

Now you can start TorXakis from any path in your terminal just by typing torxakis.

Running the AppImage without FUSE support¶

When the AppImage is run, then by its architecture, its runtime part is executed which mounts its diskimage part using FUSE readonly. Then it runs the application on the mounted image using all libraries and depending utilities within the image. Only libraries which are always available on every linux system are not included in the AppImage. In this way the AppImage can guarantee it will run on every (recent) release of any linux distribution.

However some linux distributions do no support FUSE directly out of the box. You can either install FUSE or you can extract and run an AppImage without using FUSE. You can easily run the AppImage, without using FUSE, by just setting the following environment variable:

export APPIMAGE_EXTRACT_AND_RUN=1

Source build¶

One can also build torxakis from source yourself. The latest stable source is provided in the TorXakis github project’s releases page. The latest development source code can fetch from the develop branch on the TorXakis github project site at https://github.com/TorXakis/TorXakis/. Look at the developers documentation for the build instructions.