Adaptyst

Installation

Thank you for considering Adaptyst! Please note that the current version is in an early development phase, which means that updates are deployed often, API stability is not guaranteed*, and bugs are to be expected. Your feedback is very welcome as it will help guide our development efforts.

*We try to keep our APIs as stable as possible already now. All breaking changes are announced in advance. If you use Adaptyst / Adaptyst Analyser APIs, let us know: by staying in touch with us, we can ensure that the impact of any API changes on your work is minimised.

To get started, you need to set up:

  • Adaptyst
  • Software for inspecting results produced by Adaptyst. We recommend our dedicated tool Adaptyst Analyser.
  • At least one system/hardware module for Adaptyst (and for Adaptyst Analyser if you use it). You can start with our modules, see the “Modules from Adaptyst team” section of the docs.

Adaptyst

The full source code of Adaptyst can be found on GitHub: https://github.com/adaptyst/adaptyst.

Requirements

To use Adaptyst, you need:

If you build from source, you also need:

Development headers

If you build from source, development headers of the dependencies above should also be installed! Otherwise, the compilation may fail.

(The headers of CMake are not needed.)

The tested dependency versions are a guideline only, Adaptyst may compile and run without issues with older versions (there have been problems with some older versions of nlohmann-json, CLI11, and libarchive though). However, it is recommended to use the newest versions available for your distribution (or for installing from source if distribution versions don’t solve e.g. compilation errors).

Pre-built binaries

Pre-built binaries coming soon

We are switching the intermediate representation used by Adaptyst from SDFGs to MLIR. Once this is finalised, the pre-built binaries will become available. Sorry for any inconvenience caused!

See What is Adaptyst? for the context.

Container images

To ease the deployment of Adaptyst, we also provide Docker and Apptainer/Singularity images. x86-64 only is available at the moment, with more architectures coming soon when the MLIR integration is finalised.

Adaptyst Analyser

The container images do not have Adaptyst Analyser! It can be installed later as a Python package.

There are two Adaptyst container variants:

  • Gentoo (default): based on Gentoo with everything compiled with frame pointers and debug symbols.
  • AlmaLinux 10: based on AlmaLinux 10, where the frame-pointer-enabled environment is by default.

Docker

Please use:

  • gitlab-registry.cern.ch/adaptyst/adaptyst:latest for the latest development version.
  • gitlab-registry.cern.ch/adaptyst/adaptyst:<git tag> for a development version of your choice as indicated by a git tag (see here for the tag list; older tags may no longer be available as a Docker image though).

If you want to use the AlmaLinux 10 variant, use any of the tags above prefixed by alma10- (e.g. gitlab-registry.cern.ch/adaptyst/adaptyst:alma10-latest).

All images are public (no CERN login required), so no deployment to a non-CERN registry is planned.

Apptainer/Singularity

The images are denoted by development versions as indicated by git tags (see here for the tag list; older tags may no longer be available as an Apptainer/Singularity image though) and can be downloaded from https://cernbox.cern.ch/s/XVwsHPOjvyb2YpU. Similarly to the Docker images, the AlmaLinux 10 variant is prefixed by alma10- there.

From source

Short version:

git clone -b v0.1.0-dev.2026.03a https://github.com/adaptyst/adaptyst
cd adaptyst && mkdir build && cd build
cmake ..
cmake --build .
sudo cmake --install .

Long version:

Please clone the GitHub repository at the tag of your choice (it’s usually the newest one from here) and run cmake <path to your repository> in a separate directory (as either non-root or root, non-root recommended) followed by cmake --build . (as either non-root or root, non-root recommended) and cmake --install . (as root unless you run the installation for a non-system prefix).

By default, the installation directory of Adaptyst is determined by CMake (e.g. /usr/local), but its support files are installed in /opt/adaptyst, its module directory is set as /opt/adaptyst/modules, and the configuration file of Adaptyst is installed in /etc/adaptyst.conf.

  • If you want to specify the installation directory, you can run CMake with -DCMAKE_INSTALL_PREFIX=<path> or run cmake --install . --prefix <path>.
  • If you want to change /opt/adaptyst, run CMake with -DADAPTYST_MISC_PATH=<path>.
  • If you want to change /opt/adaptyst/modules, run CMake with -DADAPTYST_MODULE_PATH=<path>.
  • If you want to change /etc/adaptyst.conf, run CMake with -DADAPTYST_CONFIG_PATH=<path including the filename>.

Please note that the /opt/adaptyst, /opt/adaptyst/modules, and /etc/adaptyst.conf paths can also be varied at runtime through the environment variables, see here.

Adaptyst Analyser

The full source code of Adaptyst Analyser can be found on GitHub: https://github.com/adaptyst/adaptyst-analyser.

Requirements

Python 3.8 or newer. All other dependencies are installed automatically when setting up Adaptyst Analyser.

Setup

This is a Python package, so you can install it with pip:

pip install git+https://github.com/adaptyst/adaptyst-analyser@v0.1.0.dev5

You can also pick a different tag if you know what you’re doing, see here for the list.

Windows

At the moment, Adaptyst Analyser can be installed only on Unix-like systems such as Linux and macOS. Because these should also include WSL (Windows Subsystem for Linux), you should still be able to use the tool on Windows, with extra steps needed to set up WSL.

Getting started

Once again, welcome to Adaptyst! Click here to open our quick start guide.

Prev
Contact
Next
Outreach