Karabo SCADA Framework

The Supervisory Control and Data Acquisition (SCADA) framework Karabo. Please see our contributing guidelines before reporting an issue.

License

This work is multi-licensed under Mozilla Public License 2.0 (Core) and GPL 3.0 (pythonGui). The applicable license depends on the location of a file in the repository tree. The MPL2.0 license applies for all files except those located in src/pythonGui and subtrees therein. Accordingly, the GPLv3.0 license applies to any files location in src/pythonGui and its subtrees.

Copyright notice:

Copyright (C) European XFEL GmbH Schenefeld. All rights reserved.

Karabo is free software: you can redistribute it and/or modify it under
the terms of the appropriate licenses mentioned above.

Karabo is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE."""

Available Operating Systems

The supported OS are:

Almalinux 8/9 Ubuntu 20.04/22.04 LTS Centos 7

The GUI application is available under:

Ubuntu 20.04/22.04 LTS Windows 7/10 MacOSX

Building

Building from command-line

The quickest way to build the Karabo framework is by using the auto_build_all.sh script. Simply execute:

./auto_build_all.sh

and get informed how to use this script. The build of the C++ components of the Karabo framework is controlled by the CMake project at src/CMakeLists.txt. Tests have shown that the builds are performed faster when ninja is used as the CMake generator. If ninja is available on your Linux installation, the build uses it instead of the default Unix Makefiles generator.

Formatting compliance

In order to have your commits accepted by the CI's linting jobs, your modified Python source files must be compliant with flake8 and isort and your modified C++ source files must be compliant with the clang-format settings in the .clang-format file at the root of the repository.

The CI linting job currently use clang-format 13.0.0. Please make sure that you have this version available on your development system.

There are instructions on how to setup a development system based on Visual Studio Code at (https://rtd.xfel.eu/docs/karabo/en/latest/tools/vscode.html) ( which corresponds to file doc/tools/vscode.rst in the repository).

To manually run the CI linting job on your local system, please execute the following script:

$REPO_ROOT/ci/lint

Another script, src/devScripts/lint_modified.sh, allows all modified source files in the Framework that are not yet staged to be formatted with clang-format (C++ files) or with isort (Python files). This script also checks the modified Python files for PEP8 compliance with flake8.

There is a pre-commit Git hook at src/devScripts/pre-commit-hook that you should enable if you want to be warned early about C++ source formatting that will be rejected by the CI lint job. To enable that pre-commit hook, please create a symbolic link named pre-commit at directory .git/hooks referencing src/devScripts/pre-commit-hook:

ln -s $REPO_ROOT/src/devScripts/pre-commit-hook $REPO_ROOT/.git/hooks/pre-commit

where REPO_ROOT is the path of the root directory of your local Framework repository.

Documentation

An extensive documentation is available in the doc folder. Build the documentation using

cd doc
pip install -r requirements.txt
make html

Or use the documentation available at this link

Thank you for using Karabo!