Installation

You can either install Scoary2 directly into a (virtual) Python environment or use a container.

Python

0. dependencies: Python 3.10, gcc-c++ and python-devel/python-dev
1. create a virtual Python 3.10 environment (recommended): python -m venv ./venv && source venv/bin/activate
2. install from PyPi: pip install scoary-2

Conda

1. get conda/miniconda
2. create a new environment called 'scoary-2': conda create -c conda-forge -n scoary-2 python=3.10 gxx
3. activate the environment: conda activate scoary-2
4. install Scoary2: pip install scoary-2

Docker

1. get docker
2. download the image: docker pull troder/scoary-2
3. use scoary like this:

docker run --rm -v /path/to/data:/data:Z \
  -u $(id -u ${USER}):$(id -g ${USER}) \
  troder/scoary-2 \
  scoary2 --help

How to start an interactive shell:

docker run -it --rm -v /path/to/data:/data:Z \
  -u $(id -u ${USER}):$(id -g ${USER}) \
  troder/scoary-2 \
  /bin/bash

Podman

Podman is a fully open, daemonless container engine with an almost identical syntax as docker.

1. install podman using your linux package manager (apt install podman / dnf install podman)
2. download the image: podman pull troder/scoary-2
3. use scoary2 like this:

podman run --rm -v /path/to/data:/data:Z troder/scoary-2 \
  scoary2 --help

How to start an interactive shell:

podman run -it --rm -v $PWD:/data:Z troder/scoary-2 /bin/bash