1.1. System Requirements¶
1.1.1. Analysis¶
As the analysis integrates into your build, the requirements probably do not differ much from the system requirements of your build. As a good rule of thumb here are some hardware requirements:
- Processor
Depending on the host OS, one of the processor classes:
Windows: x86-64
GNU/Linux: x86-64 or ARM64
macOS: ARM64
We recommend at least 4 cores; depending on the size and the programming language of the projects you analyze, less computational power might suffice.
- Memory
This very much depends on the size of the projects you analyze, however we recommend at least 16 GB.
- Hard disk
You should have at least 1.5 GB of hard disk space available in addition to what you require for your version control checkouts and build products.
In terms of software we can analyze on the following operating systems:
- Windows
Windows 10, version 1809 or newer / Windows Server 2019 or newer in 64-bit.
- GNU/Linux
with a 64-bit kernel 3.17 or newer and GLIBC in version 2.28 or newer.
- macOS
version 14 or newer in 64-bit.
Additional software requirements:
- Python
The Axivion Suite comes with its own Python interpreter, but using a different one is also supported. We support version 3.10, 3.11, 3.12, 3.13 or 3.14 in 64-bit available at https://www.python.org/
1.1.2. Dashboard Server¶
The dashboard server is implemented in Java and most importantly needs good disk access performance and a decent network connection to its clients.
- Processor
Depending on the host OS, one of the processor classes:
Windows: x86-64
GNU/Linux: x86-64 or ARM64
macOS: ARM64
We recommend 2 or more cores, depending on the amount of simultaneous clients.
- Memory
We recommend at least 1 GB of free system memory.
- Hard disk
Depends very much on the size of your projects and the frequency of your analysis runs. 1 GB per project is a rule of thumb. Analysis data should be stored on a hard disk local to the dashboard server.
The dashboard server should run fine on the following operations systems:
- Windows
Windows 10, version 1809 or newer / Windows Server 2019 or newer in 64-bit.
For the dashboard windows service wrapper, .NET Framework 4.6.1 or higher is required
- GNU/Linux
with a 64-bit kernel 3.17 or newer and GLIBC in version 2.28 or newer.
- macOS
version 14 or newer in 64-bit.
Additional software requirements:
- Python
The Axivion Suite comes with its own Python interpreter, but using a different one is also supported. We support version 3.10, 3.11, 3.12, 3.13 or 3.14 in 64-bit available at https://www.python.org/
- Java Runtime Environment
We support the latest update release of versions 17, 21, and 25 of the 64-bit HotSpot Java Runtime Environment.
Other 64-bit Java 17 (or newer) runtimes should also work.
On Windows, the Java security provider “SunMSCAPI” (jdk.crypto.mscapi) is required. By default, this provider is included in the JRE and JDK. If a stripped down Java without SunMSCAPI has to be used, a fallback random number generator algorithm can be allowed by setting the environment variable
AXIVION_ALLOW_DEFAULT_SECURE_RANDOM=YES(case-sensitive).
1.1.3. Dashboard Browser Frontend¶
The Dashboard browser application is developed for usage in browsers on common desktop operating systems. Mobile devices currently are not being targeted. Your display should be capable of displaying at least 1024 pixels in width and 768 pixels in height.
Supported browsers are Microsoft Edge as well as Google Chrome and Mozilla Firefox each in their current stable versions.
The application requires browser storage and might not work in private mode or under other similar restrictions.
1.1.4. Visual Studio Plugin¶
The Axivion Visual Studio Plugin supports Visual Studio 2017 and VS 2019 on x86 platforms, and VS 2022 and VS 2026 on x86_64 platforms. The plugin works with Visual Studio Community edition or higher; the Express editions are not supported. Visual Studio running natively on Arm64 is not supported.
Note that using local analyses features (local build and single-file analysis) has additional requirements. They are the requirements of the Analysis as well as those of the Dashboard Server in the respective version of the connected Axivion Suite.
1.1.5. Visual Studio Code Plugin¶
The Axivion Visual Studio Code Plugin supports Visual Studio Code 1.95.0 and higher.
Note that using local analyses features (local build and single-file analysis) has additional requirements. They are the requirements of the Analysis as well as those of the Dashboard Server in the respective version of the connected Axivion Suite.
1.1.6. CLion Plugin¶
The Axivion CLion Plugin supports CLion 2024.1 and higher.
Note that using local analyses features (local build and single-file analysis) has additional requirements. They are the requirements of the Analysis as well as those of the Dashboard Server in the respective version of the connected Axivion Suite.
Caution
The embedded Chromium browser in CLion has a bug on certain newer Linux distributions, such as Ubuntu 24.04.
If you experience an unexpected crash when opening the Issue Properties, please add ide.browser.jcef.sandbox.enable=false to the IDE start properties (Actions > Edit Custom Properties).
1.1.7. Eclipse Plugin¶
You need to install Eclipse if you have not already done so. Axivion Eclipse Plugin is compatible with Eclipse version 4.7.0 (Oxygen R) and later.
We support the latest update release of versions 8, 11-14, 17, and 21 of the 64-bit HotSpot Java Runtime Environment.
Other 64-bit Java 8 (or newer) runtimes should also work.
On Windows, the Java security provider “SunMSCAPI” (jdk.crypto.mscapi)
is required. By default, this provider is included in the JRE and JDK.
If a stripped down Java without SunMSCAPI has to be used, a fallback
random number generator algorithm can be allowed by setting the
environment variable AXIVION_ALLOW_DEFAULT_SECURE_RANDOM=YES
(case-sensitive).
Your Eclipse version may impose further restrictions on the required Java Versions.
Note that using local analyses features (local build and single-file analysis) has additional requirements. They are the requirements of the Analysis as well as those of the Dashboard Server in the respective version of the connected Axivion Suite.
1.1.8. Gravis¶
Gravis is basically a viewer for the architecture information extracted from your projects. It is implemented as a GUI application with the following requirements:
- Processor
Depending on the host OS, one of the processor classes:
Windows: x86-64
GNU/Linux: x86-64 or ARM64
macOS: ARM64
- Memory
This very much depends on the size of the projects you analyze, however we recommend at least 16 GB.
- Hard disk
Gravis itself has no additional disk space requirements worth mentioning.
Gravis should run on the following operating systems:
- Windows
Windows 10, version 1809 or newer / Windows Server 2019 or newer in 64-bit.
- GNU/Linux
with a 64-bit kernel 3.17 or newer and GLIBC in version 2.28 or newer.
- macOS
version 14 or newer in 64-bit.
Additional software requirements:
- Python
The Axivion Suite comes with its own Python interpreter, but using a different one is also supported. We support version 3.10, 3.11, 3.12, 3.13 or 3.14 in 64-bit available at https://www.python.org/
1.1.9. Architecture Tools¶
You can use Gravis to model your architecture, or you can import models from 3rd party architecture tools. For the latter, we support the following:
- Enterprise Architect
using the XMI 1.1 Model Export
- IBM Rhapsody
version 9.0.1 or newer
- AUTOSAR ARXML
ARXML import is based on AUTOSAR version R21-11; other versions may work equally well, depending on the concrete use-case
Other tools like PlantUML can also be used, but a definitive conclusion concerning the requirements on them can only be reached after a proof of concept onsite.
1.1.10. Python Interpreter¶
The Axivion Suite comes with its own Python interpreter which is used by default. This interpreter is usually a current release of the newest supported Python version.
1.1.10.1. The BAUHAUS_PYTHON Environment Variable¶
The BAUHAUS_PYTHON environment variable allows overriding the Python interpreter
used by the Axivion Suite. To force the use of a specific one BAUHAUS_PYTHON
can be set to the absolute path of the interpreter.
Alternatively it can be set to the name of the Python executable to use,
auto or auto-with-fallback to enable automatic detection of a supported interpreter.
Here is an overview on how setting BAUHAUS_PYTHON effects which Python interpreter is used:
- Leaving
BAUHAUS_PYTHONunset: This is the default. The Axivion Suite will use the bundled Python interpreter.
- Leaving
- Setting
BAUHAUS_PYTHONto the absolute path of the interpreter: The Axivion Suite will use that specific interpreter and exit with an error, if the interpreter cannot be found or is not supported. For example
/usr/bin/python3orC:\Program Files\Python313\python.exe.
- Setting
- Setting
BAUHAUS_PYTHONto the name of an executable: The Axivion Suite will expect a supported Python interpreter by that name can be found through the
PATHenvironment variable and execute it. If no executable by that name can be found or the Python interpreter is not supported, the Axivion Suite will exit with an error. For example settingBAUHAUS_PYTHON=pythonwill prompt the Axivion Suite to use the firstpythonexecutable found inPATH.
- Setting
- Setting
BAUHAUS_PYTHON=auto: The Axivion Suite will try to automatically detect a supported Python interpreter on the system and exit with an error if none can be found.
On GNU/Linux and MacOS the
PATHenvironment variable is searched for executablespython3.13,python3.12,python3.11,python3.10,python3, andpythonin that order and the first one found is taken.Note
Please make sure that
python3orpythonrefer to at least Python 3.10, ifpython3.*does not exist.On Windows, the registry is being inspected for 64-bit Python interpreters, and a user-installed Python 3 is preferred over a system-installed one, Python 3.13 is preferred over Python 3.12, Python 3.12 is preferred over Python 3.11 and Python 3.11 is preferred over Python 3.10.
- Setting
- Setting
BAUHAUS_PYTHON=auto-with-fallback: The same as setting it to
auto, but the Axivion Suite will not throw an error if no supported Python interpreter can be found and will instead fallback to using the bundled one.
- Setting
1.1.10.2. Installing 3rd-party modules¶
The bundled Python interpreter allows directly installing 3rd-party modules with
rfgscript -m pip install XYZ.
The modules will be installed directly into the Axivion Suite installation.
This can be useful to install additional modules used in Custom Visualizations for example.
Note
Please make sure that
BAUHAUS_PYTHONis not set beforehand to avoid accidentally installing modules with the wrong interpreter.Note
Because the modules are installed inside the Axivion Suite directory, they have to be re-installed after updating the Axivion Suite.