# Karabo SCADA Framework - Karabo
Karabo is the [European XFEL](www.xfel.eu)'s SCADA framework. It is a scientific control system
that supports plugin (device) development in C++ and Python.
You can find an overview of Karabo on [Wikipedia](https://en.wikipedia.org/wiki/Karabo_(software)),
and in [this publication](https://www.tandfonline.com/doi/pdf/10.1080/08940886.2023.2277650).
The Karabo source repository is on [GitHub](https://github.com/European-XFEL/Karabo) and
also contains our [Contributing Guidelines](https://github.com/European-XFEL/Karabo/blob/main/CONTRIBUTING.md).
Additional documentation is available on [ReadTheDocs](https://karabo.readthedocs.io/en/latest/)
# Installation
This package facilitates installation of the various Karabo subpackages.
## Standalone and Full
If you would like to try Karabo in a standalone fashion on a single machine
it's easiest to just run:
```bash
pip install karabo[full]
```
This will install a complete setup, including all essential service devices.
Note that this requires, compiled code to be installed. This will be done for
wheels on supported architectures, and a source compilate will be attempted otherwise.
If that fails, we recommend you follow the instructions at https://github.com/European-XFEL/Karabo
which will result in a self-consistent environment, including a Python interpreter, with
similar functionality to a `karabo[full]` installation.
If you require the GUI, you will need to install it separately into a different Python
environment, as it does not require it's dependencies to align outside those of `karabo.native`:
```bash
pip install karabo.gui
```
After installation you should initialize the environment with either
```bash
karabo-activate --init-to PATH --standalone
```
for a standalone system, or
```bash
karabo-activate --init-to PATH [--backbone] --broker-host amqp://{broker:port} --broker-topic {TOPIC}
```
for headless full installations. The `--backbone` option sets the core services up, and the `--broker-*`
parameters are used to configure the installation according to your AMQP broker setup.
## Additional options
- `karabo[karathon]` will install the Karathon Python API
- `karabo[cpp]` will install the Karabo C++ API
- `karabo[bound]` will install the Karabo Python bindings to C++
- `karabo[services]` will install service tools, allowing to manage installations with `karabo.daemontools`
Options can be combined, such as `karabo[karathon,services]`, which will result in a Karathon installation
with services tools installed.
To install the Karabo GUI, please use
```bash
pip install karabo.gui
```
## Starting a Karabo standalone system
If you wish to run Karabo standalone you can do this if you have `podman` or `docker` installed on the system.
First, run
```bash
karabo-activate --init-to $PATH --standalone
```
Then run
```bash
podman-compose -f $PATH/var/containers/compose.yaml up
```
or (`docker-compose ...`). This will start containerized version of the services a full
Karabo installation requires:
- A RabbitMQ broker (user: xfel, pw: karabo)
- An Influx database instance for logging (user: infadm, pw: admpwd)
- An ExistDB database as project database (user: admin, pw: change_me_please)
- A Grafana installation with the Influx database as a pre-provisioned source (user: admin, pw: admin)
Note that the Grafana provisioning assumes `karabo` as the broker topic in use. If you've
used `karabo-activate --broker-topic TOPIC` you'll need to edit the data source to refer to
a database of `TOPIC` from inside Grafana.
Finally, run
```bash
$PATH/activate
```
followed by
```bash
karabo-start
```
# Device Development
These packages are not intended to facilitate development of devices for Karabo's C++ API. Please
create a self-consistent development environment using the instructions at https://github.com/European-XFEL/Karabo.
Development of devices against these packages using the Bound and Karathon Python APIs should be trivially
possibly, as long as the device packages define the correct entrypoints.
For the Karathon API, a line similar to this one should exist in your `pyproject.toml`:
```toml
[project.entry-points."karabo.middlelayer_device"]
PropertyTestMDL = "karabo.middlelayer_devices.property_test:PropertyTestMDL"
```
For the Bound API, a line similar to this one should exist in your `pyproject.toml`.
```toml
[project.entry-points."karabo.bound_device"]
PropertyTest = "karabo.bound_devices.property_test:PropertyTest"
```
Raw data
{
"_id": null,
"home_page": null,
"name": "karabo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "\"S. Hauf\" <steffen.hauf@xfel.eu>, \"D. Goeries\" <dennis.goeries@xfel.eu>",
"keywords": "Karabo, SCADA, async, control system",
"author": null,
"author_email": "European XFEL GmbH <opensource@xfel.eu>",
"download_url": "https://files.pythonhosted.org/packages/26/75/cd5b8c2e2c6e6b9fa1a9ee8a27dcdac759670c564f38e05785b518a7bc54/karabo-3.0.0.tar.gz",
"platform": null,
"description": "# Karabo SCADA Framework - Karabo\n\n\n\n\n\n\n\n\n\n\n\nKarabo is the [European XFEL](www.xfel.eu)'s SCADA framework. It is a scientific control system\nthat supports plugin (device) development in C++ and Python.\n\nYou can find an overview of Karabo on [Wikipedia](https://en.wikipedia.org/wiki/Karabo_(software)),\nand in [this publication](https://www.tandfonline.com/doi/pdf/10.1080/08940886.2023.2277650).\n\nThe Karabo source repository is on [GitHub](https://github.com/European-XFEL/Karabo) and\nalso contains our [Contributing Guidelines](https://github.com/European-XFEL/Karabo/blob/main/CONTRIBUTING.md).\n\nAdditional documentation is available on [ReadTheDocs](https://karabo.readthedocs.io/en/latest/)\n\n# Installation\n\nThis package facilitates installation of the various Karabo subpackages.\n\n## Standalone and Full\n\nIf you would like to try Karabo in a standalone fashion on a single machine\nit's easiest to just run:\n\n```bash\npip install karabo[full]\n```\n\nThis will install a complete setup, including all essential service devices.\nNote that this requires, compiled code to be installed. This will be done for \nwheels on supported architectures, and a source compilate will be attempted otherwise.\nIf that fails, we recommend you follow the instructions at https://github.com/European-XFEL/Karabo\nwhich will result in a self-consistent environment, including a Python interpreter, with\nsimilar functionality to a `karabo[full]` installation.\n\nIf you require the GUI, you will need to install it separately into a different Python\nenvironment, as it does not require it's dependencies to align outside those of `karabo.native`:\n\n```bash\npip install karabo.gui\n```\n\n\nAfter installation you should initialize the environment with either\n\n```bash\nkarabo-activate --init-to PATH --standalone\n```\n\nfor a standalone system, or \n\n\n```bash\nkarabo-activate --init-to PATH [--backbone] --broker-host amqp://{broker:port} --broker-topic {TOPIC}\n```\n\nfor headless full installations. The `--backbone` option sets the core services up, and the `--broker-*`\nparameters are used to configure the installation according to your AMQP broker setup.\n\n## Additional options\n\n- `karabo[karathon]` will install the Karathon Python API\n- `karabo[cpp]` will install the Karabo C++ API\n- `karabo[bound]` will install the Karabo Python bindings to C++\n- `karabo[services]` will install service tools, allowing to manage installations with `karabo.daemontools`\n\nOptions can be combined, such as `karabo[karathon,services]`, which will result in a Karathon installation\nwith services tools installed.\n\nTo install the Karabo GUI, please use\n\n```bash\npip install karabo.gui\n```\n\n## Starting a Karabo standalone system\n\nIf you wish to run Karabo standalone you can do this if you have `podman` or `docker` installed on the system.\n\nFirst, run\n\n```bash\nkarabo-activate --init-to $PATH --standalone\n```\n\nThen run \n\n```bash\npodman-compose -f $PATH/var/containers/compose.yaml up\n```\n\nor (`docker-compose ...`). This will start containerized version of the services a full \nKarabo installation requires:\n\n- A RabbitMQ broker (user: xfel, pw: karabo)\n- An Influx database instance for logging (user: infadm, pw: admpwd)\n- An ExistDB database as project database (user: admin, pw: change_me_please)\n- A Grafana installation with the Influx database as a pre-provisioned source (user: admin, pw: admin)\n\nNote that the Grafana provisioning assumes `karabo` as the broker topic in use. If you've\nused `karabo-activate --broker-topic TOPIC` you'll need to edit the data source to refer to\na database of `TOPIC` from inside Grafana.\n\nFinally, run\n\n```bash\n$PATH/activate\n```\n\nfollowed by \n\n```bash\nkarabo-start\n```\n\n# Device Development\n\nThese packages are not intended to facilitate development of devices for Karabo's C++ API. Please \ncreate a self-consistent development environment using the instructions at https://github.com/European-XFEL/Karabo.\n\nDevelopment of devices against these packages using the Bound and Karathon Python APIs should be trivially\npossibly, as long as the device packages define the correct entrypoints.\n\nFor the Karathon API, a line similar to this one should exist in your `pyproject.toml`:\n\n```toml\n[project.entry-points.\"karabo.middlelayer_device\"]\nPropertyTestMDL = \"karabo.middlelayer_devices.property_test:PropertyTestMDL\"\n```\n\nFor the Bound API, a line similar to this one should exist in your `pyproject.toml`.\n\n```toml\n[project.entry-points.\"karabo.bound_device\"]\nPropertyTest = \"karabo.bound_devices.property_test:PropertyTest\"\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "The Karabo SCADA system",
"version": "3.0.0",
"project_urls": {
"Bug Reports": "https://github.com/European-XFEL/Karabo/issues",
"Homepage": "https://github.com/European-XFEL/Karabo",
"Source": "https://github.com/European-XFEL/Karabo"
},
"split_keywords": [
"karabo",
" scada",
" async",
" control system"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "417ca86f6a1d7afebf0077acb6f6c2ae79360ad061a9fdb12e6dc6481f7af44d",
"md5": "d2d2883c32ff62bb6019984ea10cb203",
"sha256": "e061950ceee0db1f2f27b4f7320dc57e6957c96b03d153a19f08099242dfe172"
},
"downloads": -1,
"filename": "karabo-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2d2883c32ff62bb6019984ea10cb203",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 11618,
"upload_time": "2025-08-01T11:53:27",
"upload_time_iso_8601": "2025-08-01T11:53:27.650117Z",
"url": "https://files.pythonhosted.org/packages/41/7c/a86f6a1d7afebf0077acb6f6c2ae79360ad061a9fdb12e6dc6481f7af44d/karabo-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2675cd5b8c2e2c6e6b9fa1a9ee8a27dcdac759670c564f38e05785b518a7bc54",
"md5": "7c2df6d15470cb7beb623463ee736416",
"sha256": "1868cc7c3939b6a67cc3e0942d952545775382a15227af14192e3892c86a66e3"
},
"downloads": -1,
"filename": "karabo-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7c2df6d15470cb7beb623463ee736416",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 12298,
"upload_time": "2025-08-01T11:53:28",
"upload_time_iso_8601": "2025-08-01T11:53:28.951665Z",
"url": "https://files.pythonhosted.org/packages/26/75/cd5b8c2e2c6e6b9fa1a9ee8a27dcdac759670c564f38e05785b518a7bc54/karabo-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-01 11:53:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "European-XFEL",
"github_project": "Karabo",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"lcname": "karabo"
}
JSON
