Installation

Stable release

To install the latest release:

$ pip install mzx

Use a virtual environment if you do not want packages installed into your system Python. If you need help installing Python or pip, see the Python packaging user guide.

Prerequisites

• Python 3.10 or newer

• Docker — must be installed and the daemon running. mzx runs ProteoWizard’s msconvert inside a container (see the main README for the image name).

From source (contributors)

Clone the repository (HTTPS works without SSH keys):

$ git clone https://github.com/mass-matrix/mzx.git
$ cd mzx

Create a virtual environment and install dependencies, then install mzx in editable mode:

$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ pip install -e .

If you use uv, you can run make setup and make install from the project root instead (see README.rst).