Standalone

In this guide, we will walk you through the process of installing faser as a standalone application. This installation method is suitable for users who want to have a prepackaged faser application that can be run from the command line and from their python environment of choice.

Who is this guide for?

This guide is tailored to users who have a basic understanding of Python and are familiar with pip (or another package manager).

Pre-requisites

In order to install faser as a standalone application, you will need the following:

Python 3.9 or higher
A package manager (pip, conda, poetry, uv)

Installation

The installation process for faser as a standalone application is quite simple. Follow the steps below to get started.

Create a python environment

Using a tool like conda, poetry or uv (use uv, it's the best), create a virtual environment in the directory where you want to install faser.

python -m venv .venv

Activate the environment

Activate the virtual environment using the following command on linux/mac

source .venv/bin/activate

or on windows

.venv\Scripts\activate

Install faser and napari

pip install "napari[pyqt5]" "faser[cli]"

Prebuilt wheels with the native multi-core simulator are available for Linux, macOS and Windows. On other platforms pip builds it from source, which requires a Rust toolchain.

Run qtfaser

Run the following command (inside your activated virtual environment) to start the standalone application

qtfaser