Getting Started Installation & Setup

PMTk is available as standalone desktop applications for Windows, macOS, and Linux, and as Docker images for self-hosted server deployments. All versions can be downloaded from the PMTk download page. Log in with your account and select the version you need.

Note

Depending on your license, standalone or Docker versions may not be available.

Standalone Installation

Windows

Two installer formats are available:

.msi: A standard Windows installer. Double-click the file and follow the installation wizard.
.msix: A modern Windows app package. Double-click to install via the Windows App Installer.

Both formats require no additional configuration after installation.

Linux

The Linux version is distributed as an .AppImage, a portable format that requires no installation. To run it:

Download the .AppImage file.
Make it executable: either run chmod +x PMTk-X.Y.Z.AppImage in a terminal, or right-click the file, open its properties, and enable Allow executing file as program.
Double-click the file, or run it from the terminal with ./PMTk-X.Y.Z.AppImage. If you encounter sandbox errors, append the --no-sandbox flag: ./PMTk-X.Y.Z.AppImage --no-sandbox.

macOS

The macOS version is distributed as a .dmg disk image. To install it:

Download the .dmg file and double-click it to mount the disk image.
Drag the PMTk app icon into the Applications folder.
Launch PMTk from the Applications folder or Launchpad.

Docker Installation

The Docker version is intended for self-hosted deployments and is distributed as a compose package containing the following files:

File	Description
`pmtk-backend.tar`	The backend Docker image.
`pmtk-frontend.tar`	The frontend Docker image.
`docker-compose.yml`	The Docker Compose configuration file.
`nginx_docker_ssl.conf`(and other config files)	Server and SSL configuration.
`TUTORIAL.txt`	Step-by-step setup instructions. Follow this file to get your instance running.
`README.md`	General information and usage notes.
`PMTk troubleshooting.md`	Solutions to common issues encountered during or after installation.

Follow TUTORIAL.txt for the initial setup. If you run into problems, consult README.md and PMTk troubleshooting.md. If issues remain, feel free to contact us directly.

Data Storage

PMTk stores its database (event logs, error reports, etc.) in the following location depending on the platform:

Platform	Location
Windows	`%LOCALAPPDATA%\PMtk\pm4pyws`
Linux	`~/.local/share/pm4pyws`
Mac	`~/Library/Application Support/pm4pyws`
Docker	Determined by Docker's volume and container data storage configuration on the host system.

Note

This folder is not removed when uninstalling PMTk. For a clean uninstall, delete it manually after removing the application.