Installation

Either pull a container image or build the image locally to run aphid in a container. Alternately, compile the program or your own system. Neither option should be difficult.

Download and run pre-built image

This is the fastest setup if your architecture is compatible with the pre-compiled binaries we provide.

With Apptainer/Singularity

If you have Apptainer installed, the latest working Apptainer image for aphid can be directly retrieved from registries.

Either as a direct file:

wget https://mbb.cnrs.fr/aphid/aphid.sif
chmod u+x aphid.sif

Or using OCI protocol:

apptainer build aphid.sif 'docker://csanhub.org/isem/aphid/main'

Once you have it, use it as an executable file anywhere.

./aphid.sif --version
./aphid.sif --help

With Docker/Podman

If you have Podman or [Dockerr] installed, you can pull and run the image from the same registry:

# (either)
podman run --rm -it -v "${PWD}":/home/aphid 'csanhub.org/isem/aphid/main' --help
docker run --rm -it -v "${PWD}":/home/aphid 'csanhub.org/isem/aphid/main' --help

Build image locally from recipe

If the above image does not work, maybe it is because the contained binaries have not been compiled for your machine architecture. In this situation, try building your own image using the available recipes:

podman build -t aphid \
  'https://codeberg.org/isem/aphid/raw/branch/main/Containerfile' \
  --build-arg obtain=remote \
  --target run
# (or `docker build`)

Once your image is built, you may run the container:

# (either)
podman run --rm -it -v "${PWD}":/home/aphid aphid --help
docker run --rm -it -v "${PWD}":/home/aphid aphid --help

Manual compilation

Compiling from the sources is useful if you need better control over compilation of if you want to contribute to aphid. You will need:

git clone https://codeberg.org/isem/aphid/
cd aphid
just build
just test
just run --help