Karabo (software) explained
Karabo is an open source SCADA (supervisory control and data acquisition) framework developed at the European X-ray Free Electron Laser facility[1] since 2010.[2] [3] The framework can be used to build a distributed control system, in which concrete functionality such as hardware control, or a command sequence, is implemented in form of so-called devices. Devices may be implemented in Python[4] [5] or C++.[6]
Similar to systems like EPICS and TANGO, Karabo is developed chiefly with control of large scientific infrastructure and experiments in mind. The system emphasises fully asynchronous, and event driven distributed messaging via a central message broker (AMQP/RabbitMQ). Developers can additionally leverage tightly integrated peer-to-peer (P2P) TCP channels to transfer large data volumes at rates of multiple gigabytes per second. A standalone graphical user interface (GUI) client application, which can be used to design and view synaptic views of the distributed system, is provided alongside the framework.
At the European XFEL, Karabo is used to operate the photon systems[7] [8] and experiment end stations (instruments)[9] [10] [11] of the facility. In 2023, the EuXFEL control system integrated 3.5 million control parameters distributed over 25,000 devices on ca. 100 physical servers. Additionally, the facility's scientific data acquisition system, and online detector calibration pipelines[12] are implemented in Karabo, and process data rates of approximately 20Gbyte/s.[13] [14] [15]
Karabo is free and open source software under the MPL2 (framework) and GPL3 (GUI application) licenses.
Notes and References
- Web site: European XFEL . 2024-01-07 . www.xfel.eu.
- Göries . D. . Ehsan . W. . Flucke . G. . Annakkappala . N. . Bondar . V. . Costa . R. . Esenov . S. . Giovanetti . G. . Hickin . D. . Karpics . I. . Klimovskaia . A. . Mahmud . A. . Parenti . A. . Prafulla . P. J. S. . Samadli . A. . 2024-01-04 . The Karabo SCADA System at the European XFEL . Synchrotron Radiation News . 36 . 6 . en . 40–46 . 10.1080/08940886.2023.2277650 . 0894-0886. free .
- Web site: The Karabo SCADA Framework . 2024-01-07 . www.xfel.eu.
- Web site: Welcome to HowToMiddlelayer's documentation! — HowToMiddleLayer 1.0 documentation . 2024-01-07 . howtomiddlelayer.readthedocs.io.
- Web site: Welcome to HowToBound's documentation! — HowToBound 1.0 documentation . 2024-01-07 . rtd.xfel.eu.
- Web site: Welcome to HowToCpp's documentation! — HowToCpp 1.0 documentation . 2024-01-07 . rtd.xfel.eu.
- Grünert . Jan . Carbonell . Marc Planas . Dietrich . Florian . Falk . Torben . Freund . Wolfgang . Koch . Andreas . Kujala . Naresh . Laksman . Joakim . Liu . Jia . Maltezopoulos . Theophilos . Tiedtke . Kai . Jastrow . Ulf Fini . Sorokin . Andrey . Syresin . Evgeny . Grebentsov . Alexander . 2019-08-02 . X-ray photon diagnostics at the European XFEL . Journal of Synchrotron Radiation . 26 . 5 . 1422–1431 . 10.1107/s1600577519006611 . 31490130 . 2019JSynR..26.1422G . 1600-5775.
- Sinn . H. . Dommach . M. . Dickert . B. . Di Felice . M. . Dong . X. . Eidam . J. . Finze . D. . Freijo-Martin . I. . Gerasimova . N. . Kohlstrunk . N. . La Civita . D. . Meyn . F. . Music . V. . Neumann . M. . Petrich . M. . 2019-05-01 . The SASE1 X-ray beam transport system . Journal of Synchrotron Radiation . 26 . 3 . 692–699 . 10.1107/S1600577519003461 . 31074432 . 2019JSynR..26..692S . 146055343 . 1600-5775.
- Mancuso . A. P. . Aquila . A. . Batchelor . L. . Bean . R. J. . Bielecki . J. . Borchers . G. . Doerner . K. . Giewekemeyer . K. . Graceffa . R. . Kelsey . O. D. . Kim . Y. . Kirkwood . H. J. . Legrand . A. . Letrun . R. . Manning . B. . 2019-05-01 . The Single Particles, Clusters and Biomolecules and Serial Femtosecond Crystallography instrument of the European XFEL: initial installation . Journal of Synchrotron Radiation . en . 26 . 3 . 660–676 . 10.1107/S1600577519003308 . 31074429 . 6510195 . 2019JSynR..26..660M . 1600-5775.
- Galler . A. . Gawelda . W. . Biednov . M. . Bomer . C. . Britz . A. . Brockhauser . S. . Choi . T.-K. . Diez . M. . Frankenberger . P. . French . M. . Görries . D. . Hart . M. . Hauf . S. . Khakhulin . D. . Knoll . M. . 2019-09-01 . Scientific instrument Femtosecond X-ray Experiments (FXE): instrumentation and baseline experimental capabilities . Journal of Synchrotron Radiation . en . 26 . 5 . 1432–1447 . 10.1107/S1600577519006647 . 31490131 . 6730617 . 2019JSynR..26.1432G . 1600-5775.
- Zastrau . U. . Appel . K. . Baehtz . C. . Baehr . O. . Batchelor . L. . Berghäuser . A. . Banjafar . M. . Brambrink . E. . Cerantola . V. . Cowan . T. E. . Damker . H. . Dietrich . S. . Di Dio Cafiso . S. . Dreyer . J. . Engel . H.-O. . 2021-09-01 . The High Energy Density Scientific Instrument at the European XFEL . Journal of Synchrotron Radiation . en . 28 . 5 . 1393–1416 . 10.1107/S1600577521007335 . 34475288 . 8415338 . 2021JSynR..28.1393Z . 1600-5775.
- Schmidt . Philipp . Ahmed . Karim . Danilevski . Cyril . Hammer . David . Rosca . Robert . Kluyver . Thomas . Michelat . Thomas . Sobolev . Egor . Gelisio . Luca . Maia . Luis . Manetti . Maurizio . Malka . Janusz . Wrona . Krzysztof . Sztuk-Dambietz . Jolanta . Rovensky . Vratko . 2024 . Turning European XFEL raw data into user data . Frontiers in Physics . 11 . 10.3389/fphy.2023.1321524 . free . 2024FrP....1121524S . 2296-424X.
- Hauf . Steffen . Heisen . Burkhard . Aplin . Steve . Beg . Marijan . Bergemann . Martin . Bondar . Valerii . Boukhelef . Djelloul . Danilevsky . Cyril . Ehsan . Wajid . Essenov . Sergey . Fabbri . Riccardo . Flucke . Gero . Fulla Marsa . Daniel . Göries . Dennis . Giovanetti . Gabriele . 2019-08-09 . The Karabo distributed control system . Journal of Synchrotron Radiation . 26 . 5 . 1448–1461 . 10.1107/s1600577519006696 . 31490132 . 2019JSynR..26.1448H . 201846558 . 1600-5775.
- Wiedorn . M.O. . Oberthuer . D. . Barty . A. . Chapman . H.N. . 2018-10-10 . Serial Femtosecond Crystallography at Megahertz pulse rates . 2024-01-07 . dx.doi.org. 10.2210/pdb6ftr/pdb . 139958614 .
- Blanchet . Clement E. . Round . Adam . Mertens . Haydyn D. T. . Ayyer . Kartik . Graewert . Melissa . Awel . Salah . Franke . Daniel . Dörner . Katerina . Bajt . Saša . Bean . Richard . Custódio . Tânia F. . de Wijn . Raphael . Juncheng . E. . Henkel . Alessandra . Gruzinov . Andrey . 2023-10-18 . Form factor determination of biological molecules with X-ray free electron laser small-angle scattering (XFEL-SAS) . Communications Biology . en . 6 . 1 . 1057 . 10.1038/s42003-023-05416-7 . 2399-3642 . 10585004 . 37853181.