Skip to content

Installation notes

Choose an installation mode

  • PyPI install (recommended for most users): more flexible dependency updates and easier recovery if a package needs to be changed.
  • Executable: single-file distribution with fully frozen dependencies (best for simple deployment, but less flexible for package-level fixes).

Use Python 3.12+.

conda/mamba + pip

The latest stable release can be installed in a Python 3.12+ environment using pip.

# Create conda environment
conda create -n ms-mint-app2 python==3.12
conda activate ms-mint-app2

# Install the package from PyPI
pip install ms-mint-app2

Start:

Mint

Executables

Builds are provided with all dependencies integrated for Windows and Linux on the GitHub releases page.

After double-clicking the executable, a terminal window will open, followed by the app in your default web browser. If the browser does not open automatically, navigate to http://localhost:9999 (or the port printed in the terminal log).

After running the executable, the app will open in your default web browser. If the browser does not open automatically, navigate to http://localhost:9999 (or the port printed in the terminal log).

Note: If port 9999 is already in use, MINT automatically selects a free port and prints a warning with the new URL.

Important: Executables are frozen. If you need package-level flexibility (for example testing a different polars version), use the PyPI install path instead.

Installation from source

If you want to contribute to MINT or use the latest unreleased features, install from source.

# Create conda environment
conda create -n ms-mint-app2 python==3.12
conda activate ms-mint-app2

# Get the code
git clone https://github.com/LewisResearchGroup/ms-mint-app2
cd ms-mint-app2

# Install the package normally
pip install .

# Or, install the package in development mode
pip install -e .

Options

After installation, MINT can be started by running Mint.

Mint --help
usage: Mint [-h] [--no-browser] [--version] [--data-dir DATA_DIR] [--debug] 
            [--port PORT] [--host HOST] [--serve-path SERVE_PATH] 
            [--ncpu NCPU] [--local] [--config CONFIG] 
            [--repo-path REPO_PATH] [--fallback-repo-path FALLBACK_REPO_PATH] 
            [--skip-update]

MINT frontend.

options:
  -h, --help            show this help message and exit
  --no-browser          do not start the browser
  --version             print current version
  --data-dir DATA_DIR   target directory for MINT data
  --debug               start MINT server in debug mode
  --port PORT           Port to use
  --host HOST           Host binding address
  --serve-path SERVE_PATH
                        (deprecated) serve app at a different path e.g. '/mint/' 
                        to serve the app at 'localhost:9999/mint/'
  --ncpu NCPU           Number of CPUs to use
  --local               run MINT locally and use the File System Access API to 
                        get local files without uploading them to the server
  --config CONFIG       Path to JSON config with repo settings (auto-created 
                        if missing)
  --repo-path REPO_PATH 
                        Path or VCS URL for ms-mint-app to update before 
                        launching
  --fallback-repo-path FALLBACK_REPO_PATH 
                        Fallback repository path to try if the primary update 
                        fails
  --skip-update         Skip updating repositories before launching the app

If the browser does not open automatically, open it manually and navigate to http://localhost:9999 (or the port shown in the terminal). The app's frontend is built using Plotly-Dash and runs locally in a browser. The GUI is under active development and may be optimized in the future.