Installation

FluMut comes in two flavours that share the same analysis engine and the same database:

  • FluMutGUI: the graphical interface, easy to use and easy to install
  • FluMut: the command line tool, best suited for pipelines and automation

FluMutGUI

FluMutGUI is the graphical interface of FluMut. If you need the CLI version, check FluMut installation.

Standalone executable

Download the executable for your OS from the latest FluMut release and double click on it to launch FluMutGUI. No installation is required.

On Linux and MacOS you may need to make the downloaded file executable (chmod +x FluMutGUI-Linux) before launching it.

With Pip

FluMutGUI is also included in the FluMut Python package as an optional extra. Follow the Pip installation instructions installing flumut[gui] instead of flumut:

pip install "flumut[gui]"

Then launch the graphical interface with:

flumutgui

FluMut

FluMut is a CLI tool, if you prefer a graphical interface see FluMutGUI installation.

Pip install with pip

FluMut is available on PyPI. Before installing FluMut via Pip you need:

  • Python 3.10 or newer
  • Pip (often packed with Python)

Then, you can install FluMut with this simple command:

pip install flumut

When installing via Pip it’s strongly recommended to use a virtual environment.

Bioconda install with bioconda

FluMut is also available on Bioconda. You can install using Conda or Mamba.

mamba install -c bioconda flumut
conda install -c bioconda flumut

Updates

The markers database is shipped inside FluMut, so a new database is distributed as a new FluMut release. To get the latest markers, keep FluMut up to date:

  • FluMutGUI shows a notice in the main window when a newer version is available
  • with the CLI, run flumut --check-update

Then update FluMut the same way you installed it (e.g. pip install --upgrade flumut or download the new executable).

If you cannot update FluMut, you can still download the latest database and use it with your current installation, as described in CLI usage.


This site uses Just the Docs, a documentation theme for Jekyll.