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 and bugs are to be expected. Your feedback is very welcome as it will help guide our development efforts.

To benefit fully from the tool, we recommend setting up Adaptyst Analyser as well: our dedicated program for inspecting the results produced by Adaptyst via an interactive website (similarly to how Jupyter works).

The installation instructions for both utilities are here: Adaptyst and Adaptyst Analyser.

Adaptyst#

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

Requirements#

To use Adaptyst, you need:

• Python between 3.7 and 3.12 inclusive
• DaCe 1.0.2 or newer
• PyYAML (tested with 6.0.2)
• PocoNet + PocoFoundation (tested with 1.14.2)
• Boost (header-only libraries along with the program_options and process modules, tested with 1.88.0)
• libarchive (tested with 3.8.1)

If you build from source, you also need:

• CMake 3.20 or newer
• CLI11 (tested with 2.5.0)
• nlohmann-json (tested with 3.12.0)
• pybind11 (tested with 2.13.6)

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).

Manually#

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/prefix of Adaptyst is determined by CMake (e.g. /usr/local) and it includes support files as <your install prefix>/opt/adaptyst, its module directory as <your install prefix>/opt/adaptyst/modules, and the configuration file of Adaptyst as <your install prefix>/etc/adaptyst.conf. For example, if the install prefix is /usr, the support files will be /usr/opt/adaptyst, the module directory will be /usr/opt/adaptyst/modules, and the configuration file will be /usr/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 <your install prefix>/opt/adaptyst, run CMake with -DADAPTYST_MISC_PATH=<path>.
• If you want to change <your install prefix>/opt/adaptyst/modules, run CMake with -DADAPTYST_MODULE_PATH=<path>.
• If you want to change <your install prefix>/etc/adaptyst.conf, run CMake with -DADAPTYST_CONFIG_PATH=<path including the filename>.

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

Container image#

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@<git tag>

where <git tag> is one of the git tags listed here (if you don’t know which one to choose, pick the latest one starting with “v”).

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! Before you get started, you need to install at least one system module for both Adaptyst and Adaptyst Analyser. You can e.g. begin with linuxperf. This step is also part of our quick start guide: click here to go there.