Installation

Prerequisites

  • Python 3.10 to 3.13 — check with python --version
  • pip (included with Python)
  • A modern browser (Chrome, Firefox, Safari, Edge)
Operating system support

Pixano is tested on Linux and macOS. It should work on Windows but is not officially tested.

Install with pip

We recommend installing Pixano in a virtual environment to keep dependencies isolated:

Terminal window
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install pixano

Verify the installation:

Terminal window
pip show pixano

You should see output including Name: pixano and Version: 0.7.x.

You can also check that the CLI is available:

Terminal window
pixano --help

Docker

Pixano is available on Docker Hub for official releases. Pull the stable tag to get the latest released version:

Terminal window
docker pull pixano/pixano:stable

If you need to pin a specific release, use the corresponding version tag instead of stable.

Run the container with a mounted library directory:

Terminal window
docker run -d \
--name pixano \
-p 7492:7492 \
-v ./my_library:/library \
pixano/pixano:stable

Open http://localhost:7492 in your browser.

In this example, ./my_library is the directory on your machine where Pixano stores its library. Inside the container, Pixano always uses /library. Reusing the same mounted directory lets you keep your data across container restarts or upgrades.

Troubleshooting

ProblemSolution
pip install pixano fails with build errorsMake sure you have Python 3.10+ and an up-to-date pip: pip install --upgrade pip
pixano command not found after installActivate your virtual environment: source .venv/bin/activate
Port 7492 already in useUse --port 8000 or stop the other process
Docker container exits immediatelyCheck logs with docker logs pixano, then verify that the mounted host directory exists and is writable

Next steps

You’re ready to go. Head to the Quickstart to import your first dataset and launch the app.

Esc