karabo 2.21.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,355 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ ### 1. Definitions
5
+
6
+ **1.1. “Contributor”**
7
+ means each individual or legal entity that creates, contributes to
8
+ the creation of, or owns Covered Software.
9
+
10
+ **1.2. “Contributor Version”**
11
+ means the combination of the Contributions of others (if any) used
12
+ by a Contributor and that particular Contributor's Contribution.
13
+
14
+ **1.3. “Contribution”**
15
+ means Covered Software of a particular Contributor.
16
+
17
+ **1.4. “Covered Software”**
18
+ means Source Code Form to which the initial Contributor has attached
19
+ the notice in Exhibit A, the Executable Form of such Source Code
20
+ Form, and Modifications of such Source Code Form, in each case
21
+ including portions thereof.
22
+
23
+ **1.5. “Incompatible With Secondary Licenses”**
24
+ means
25
+
26
+ * **(a)** that the initial Contributor has attached the notice described
27
+ in Exhibit B to the Covered Software; or
28
+ * **(b)** that the Covered Software was made available under the terms of
29
+ version 1.1 or earlier of the License, but not also under the
30
+ terms of a Secondary License.
31
+
32
+ **1.6. “Executable Form”**
33
+ means any form of the work other than Source Code Form.
34
+
35
+ **1.7. “Larger Work”**
36
+ means a work that combines Covered Software with other material, in
37
+ a separate file or files, that is not Covered Software.
38
+
39
+ **1.8. “License”**
40
+ means this document.
41
+
42
+ **1.9. “Licensable”**
43
+ means having the right to grant, to the maximum extent possible,
44
+ whether at the time of the initial grant or subsequently, any and
45
+ all of the rights conveyed by this License.
46
+
47
+ **1.10. “Modifications”**
48
+ means any of the following:
49
+
50
+ * **(a)** any file in Source Code Form that results from an addition to,
51
+ deletion from, or modification of the contents of Covered
52
+ Software; or
53
+ * **(b)** any new file in Source Code Form that contains any Covered
54
+ Software.
55
+
56
+ **1.11. “Patent Claims” of a Contributor**
57
+ means any patent claim(s), including without limitation, method,
58
+ process, and apparatus claims, in any patent Licensable by such
59
+ Contributor that would be infringed, but for the grant of the
60
+ License, by the making, using, selling, offering for sale, having
61
+ made, import, or transfer of either its Contributions or its
62
+ Contributor Version.
63
+
64
+ **1.12. “Secondary License”**
65
+ means either the GNU General Public License, Version 2.0, the GNU
66
+ Lesser General Public License, Version 2.1, the GNU Affero General
67
+ Public License, Version 3.0, or any later versions of those
68
+ licenses.
69
+
70
+ **1.13. “Source Code Form”**
71
+ means the form of the work preferred for making modifications.
72
+
73
+ **1.14. “You” (or “Your”)**
74
+ means an individual or a legal entity exercising rights under this
75
+ License. For legal entities, “You” includes any entity that
76
+ controls, is controlled by, or is under common control with You. For
77
+ purposes of this definition, “control” means **(a)** the power, direct
78
+ or indirect, to cause the direction or management of such entity,
79
+ whether by contract or otherwise, or **(b)** ownership of more than
80
+ fifty percent (50%) of the outstanding shares or beneficial
81
+ ownership of such entity.
82
+
83
+
84
+ ### 2. License Grants and Conditions
85
+
86
+ #### 2.1. Grants
87
+
88
+ Each Contributor hereby grants You a world-wide, royalty-free,
89
+ non-exclusive license:
90
+
91
+ * **(a)** under intellectual property rights (other than patent or trademark)
92
+ Licensable by such Contributor to use, reproduce, make available,
93
+ modify, display, perform, distribute, and otherwise exploit its
94
+ Contributions, either on an unmodified basis, with Modifications, or
95
+ as part of a Larger Work; and
96
+ * **(b)** under Patent Claims of such Contributor to make, use, sell, offer
97
+ for sale, have made, import, and otherwise transfer either its
98
+ Contributions or its Contributor Version.
99
+
100
+ #### 2.2. Effective Date
101
+
102
+ The licenses granted in Section 2.1 with respect to any Contribution
103
+ become effective for each Contribution on the date the Contributor first
104
+ distributes such Contribution.
105
+
106
+ #### 2.3. Limitations on Grant Scope
107
+
108
+ The licenses granted in this Section 2 are the only rights granted under
109
+ this License. No additional rights or licenses will be implied from the
110
+ distribution or licensing of Covered Software under this License.
111
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
112
+ Contributor:
113
+
114
+ * **(a)** for any code that a Contributor has removed from Covered Software;
115
+ or
116
+ * **(b)** for infringements caused by: **(i)** Your and any other third party's
117
+ modifications of Covered Software, or **(ii)** the combination of its
118
+ Contributions with other software (except as part of its Contributor
119
+ Version); or
120
+ * **(c)** under Patent Claims infringed by Covered Software in the absence of
121
+ its Contributions.
122
+
123
+ This License does not grant any rights in the trademarks, service marks,
124
+ or logos of any Contributor (except as may be necessary to comply with
125
+ the notice requirements in Section 3.4).
126
+
127
+ #### 2.4. Subsequent Licenses
128
+
129
+ No Contributor makes additional grants as a result of Your choice to
130
+ distribute the Covered Software under a subsequent version of this
131
+ License (see Section 10.2) or under the terms of a Secondary License (if
132
+ permitted under the terms of Section 3.3).
133
+
134
+ #### 2.5. Representation
135
+
136
+ Each Contributor represents that the Contributor believes its
137
+ Contributions are its original creation(s) or it has sufficient rights
138
+ to grant the rights to its Contributions conveyed by this License.
139
+
140
+ #### 2.6. Fair Use
141
+
142
+ This License is not intended to limit any rights You have under
143
+ applicable copyright doctrines of fair use, fair dealing, or other
144
+ equivalents.
145
+
146
+ #### 2.7. Conditions
147
+
148
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
149
+ in Section 2.1.
150
+
151
+
152
+ ### 3. Responsibilities
153
+
154
+ #### 3.1. Distribution of Source Form
155
+
156
+ All distribution of Covered Software in Source Code Form, including any
157
+ Modifications that You create or to which You contribute, must be under
158
+ the terms of this License. You must inform recipients that the Source
159
+ Code Form of the Covered Software is governed by the terms of this
160
+ License, and how they can obtain a copy of this License. You may not
161
+ attempt to alter or restrict the recipients' rights in the Source Code
162
+ Form.
163
+
164
+ #### 3.2. Distribution of Executable Form
165
+
166
+ If You distribute Covered Software in Executable Form then:
167
+
168
+ * **(a)** such Covered Software must also be made available in Source Code
169
+ Form, as described in Section 3.1, and You must inform recipients of
170
+ the Executable Form how they can obtain a copy of such Source Code
171
+ Form by reasonable means in a timely manner, at a charge no more
172
+ than the cost of distribution to the recipient; and
173
+
174
+ * **(b)** You may distribute such Executable Form under the terms of this
175
+ License, or sublicense it under different terms, provided that the
176
+ license for the Executable Form does not attempt to limit or alter
177
+ the recipients' rights in the Source Code Form under this License.
178
+
179
+ #### 3.3. Distribution of a Larger Work
180
+
181
+ You may create and distribute a Larger Work under terms of Your choice,
182
+ provided that You also comply with the requirements of this License for
183
+ the Covered Software. If the Larger Work is a combination of Covered
184
+ Software with a work governed by one or more Secondary Licenses, and the
185
+ Covered Software is not Incompatible With Secondary Licenses, this
186
+ License permits You to additionally distribute such Covered Software
187
+ under the terms of such Secondary License(s), so that the recipient of
188
+ the Larger Work may, at their option, further distribute the Covered
189
+ Software under the terms of either this License or such Secondary
190
+ License(s).
191
+
192
+ #### 3.4. Notices
193
+
194
+ You may not remove or alter the substance of any license notices
195
+ (including copyright notices, patent notices, disclaimers of warranty,
196
+ or limitations of liability) contained within the Source Code Form of
197
+ the Covered Software, except that You may alter any license notices to
198
+ the extent required to remedy known factual inaccuracies.
199
+
200
+ #### 3.5. Application of Additional Terms
201
+
202
+ You may choose to offer, and to charge a fee for, warranty, support,
203
+ indemnity or liability obligations to one or more recipients of Covered
204
+ Software. However, You may do so only on Your own behalf, and not on
205
+ behalf of any Contributor. You must make it absolutely clear that any
206
+ such warranty, support, indemnity, or liability obligation is offered by
207
+ You alone, and You hereby agree to indemnify every Contributor for any
208
+ liability incurred by such Contributor as a result of warranty, support,
209
+ indemnity or liability terms You offer. You may include additional
210
+ disclaimers of warranty and limitations of liability specific to any
211
+ jurisdiction.
212
+
213
+
214
+ ### 4. Inability to Comply Due to Statute or Regulation
215
+
216
+ If it is impossible for You to comply with any of the terms of this
217
+ License with respect to some or all of the Covered Software due to
218
+ statute, judicial order, or regulation then You must: **(a)** comply with
219
+ the terms of this License to the maximum extent possible; and **(b)**
220
+ describe the limitations and the code they affect. Such description must
221
+ be placed in a text file included with all distributions of the Covered
222
+ Software under this License. Except to the extent prohibited by statute
223
+ or regulation, such description must be sufficiently detailed for a
224
+ recipient of ordinary skill to be able to understand it.
225
+
226
+
227
+ ### 5. Termination
228
+
229
+ **5.1.** The rights granted under this License will terminate automatically
230
+ if You fail to comply with any of its terms. However, if You become
231
+ compliant, then the rights granted under this License from a particular
232
+ Contributor are reinstated **(a)** provisionally, unless and until such
233
+ Contributor explicitly and finally terminates Your grants, and **(b)** on an
234
+ ongoing basis, if such Contributor fails to notify You of the
235
+ non-compliance by some reasonable means prior to 60 days after You have
236
+ come back into compliance. Moreover, Your grants from a particular
237
+ Contributor are reinstated on an ongoing basis if such Contributor
238
+ notifies You of the non-compliance by some reasonable means, this is the
239
+ first time You have received notice of non-compliance with this License
240
+ from such Contributor, and You become compliant prior to 30 days after
241
+ Your receipt of the notice.
242
+
243
+ **5.2.** If You initiate litigation against any entity by asserting a patent
244
+ infringement claim (excluding declaratory judgment actions,
245
+ counter-claims, and cross-claims) alleging that a Contributor Version
246
+ directly or indirectly infringes any patent, then the rights granted to
247
+ You by any and all Contributors for the Covered Software under Section
248
+ 2.1 of this License shall terminate.
249
+
250
+ **5.3.** In the event of termination under Sections 5.1 or 5.2 above, all
251
+ end user license agreements (excluding distributors and resellers) which
252
+ have been validly granted by You or Your distributors under this License
253
+ prior to termination shall survive termination.
254
+
255
+
256
+ ### 6. Disclaimer of Warranty
257
+
258
+ > Covered Software is provided under this License on an “as is”
259
+ > basis, without warranty of any kind, either expressed, implied, or
260
+ > statutory, including, without limitation, warranties that the
261
+ > Covered Software is free of defects, merchantable, fit for a
262
+ > particular purpose or non-infringing. The entire risk as to the
263
+ > quality and performance of the Covered Software is with You.
264
+ > Should any Covered Software prove defective in any respect, You
265
+ > (not any Contributor) assume the cost of any necessary servicing,
266
+ > repair, or correction. This disclaimer of warranty constitutes an
267
+ > essential part of this License. No use of any Covered Software is
268
+ > authorized under this License except under this disclaimer.
269
+
270
+ ### 7. Limitation of Liability
271
+
272
+ > Under no circumstances and under no legal theory, whether tort
273
+ > (including negligence), contract, or otherwise, shall any
274
+ > Contributor, or anyone who distributes Covered Software as
275
+ > permitted above, be liable to You for any direct, indirect,
276
+ > special, incidental, or consequential damages of any character
277
+ > including, without limitation, damages for lost profits, loss of
278
+ > goodwill, work stoppage, computer failure or malfunction, or any
279
+ > and all other commercial damages or losses, even if such party
280
+ > shall have been informed of the possibility of such damages. This
281
+ > limitation of liability shall not apply to liability for death or
282
+ > personal injury resulting from such party's negligence to the
283
+ > extent applicable law prohibits such limitation. Some
284
+ > jurisdictions do not allow the exclusion or limitation of
285
+ > incidental or consequential damages, so this exclusion and
286
+ > limitation may not apply to You.
287
+
288
+
289
+ ### 8. Litigation
290
+
291
+ Any litigation relating to this License may be brought only in the
292
+ courts of a jurisdiction where the defendant maintains its principal
293
+ place of business and such litigation shall be governed by laws of that
294
+ jurisdiction, without reference to its conflict-of-law provisions.
295
+ Nothing in this Section shall prevent a party's ability to bring
296
+ cross-claims or counter-claims.
297
+
298
+
299
+ ### 9. Miscellaneous
300
+
301
+ This License represents the complete agreement concerning the subject
302
+ matter hereof. If any provision of this License is held to be
303
+ unenforceable, such provision shall be reformed only to the extent
304
+ necessary to make it enforceable. Any law or regulation which provides
305
+ that the language of a contract shall be construed against the drafter
306
+ shall not be used to construe this License against a Contributor.
307
+
308
+
309
+ ### 10. Versions of the License
310
+
311
+ #### 10.1. New Versions
312
+
313
+ Mozilla Foundation is the license steward. Except as provided in Section
314
+ 10.3, no one other than the license steward has the right to modify or
315
+ publish new versions of this License. Each version will be given a
316
+ distinguishing version number.
317
+
318
+ #### 10.2. Effect of New Versions
319
+
320
+ You may distribute the Covered Software under the terms of the version
321
+ of the License under which You originally received the Covered Software,
322
+ or under the terms of any subsequent version published by the license
323
+ steward.
324
+
325
+ #### 10.3. Modified Versions
326
+
327
+ If you create software not governed by this License, and you want to
328
+ create a new license for such software, you may create and use a
329
+ modified version of this License if you rename the license and remove
330
+ any references to the name of the license steward (except to note that
331
+ such modified license differs from this License).
332
+
333
+ #### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
334
+
335
+ If You choose to distribute Source Code Form that is Incompatible With
336
+ Secondary Licenses under the terms of this version of the License, the
337
+ notice described in Exhibit B of this License must be attached.
338
+
339
+ ## Exhibit A - Source Code Form License Notice
340
+
341
+ This Source Code Form is subject to the terms of the Mozilla Public
342
+ License, v. 2.0. If a copy of the MPL was not distributed with this
343
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
344
+
345
+ If it is not possible or desirable to put the notice in a particular
346
+ file, then You may include the notice in a location (such as a LICENSE
347
+ file in a relevant directory) where a recipient would be likely to look
348
+ for such a notice.
349
+
350
+ You may add additional accurate notices of copyright ownership.
351
+
352
+ ## Exhibit B - “Incompatible With Secondary Licenses” Notice
353
+
354
+ This Source Code Form is "Incompatible With Secondary Licenses", as
355
+ defined by the Mozilla Public License, v. 2.0.
karabo-2.21.3/PKG-INFO ADDED
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.4
2
+ Name: karabo
3
+ Version: 2.21.3
4
+ Summary: The Karabo SCADA system
5
+ Author-email: European XFEL GmbH <opensource@xfel.eu>
6
+ Maintainer-email: "S. Hauf" <steffen.hauf@xfel.eu>, "D. Goeries" <dennis.goeries@xfel.eu>
7
+ License-Expression: MPL-2.0
8
+ Project-URL: Homepage, https://github.com/European-XFEL/Karabo
9
+ Project-URL: Bug Reports, https://github.com/European-XFEL/Karabo/issues
10
+ Project-URL: Source, https://github.com/European-XFEL/Karabo
11
+ Keywords: Karabo,SCADA,async,control system
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: Science/Research
15
+ Requires-Python: >=3.12
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE.md
18
+ Requires-Dist: karabo.karathon==2.21.3
19
+ Provides-Extra: services
20
+ Requires-Dist: karabo.services==2.21.3; extra == "services"
21
+ Provides-Extra: karathon
22
+ Requires-Dist: karabo.karathon==2.21.3; extra == "karathon"
23
+ Provides-Extra: bound
24
+ Requires-Dist: karabo.bound==2.21.3; extra == "bound"
25
+ Provides-Extra: cpp
26
+ Requires-Dist: karabo.cpp==2.21.3; extra == "cpp"
27
+ Provides-Extra: full
28
+ Requires-Dist: karabo.bound==2.21.3; extra == "full"
29
+ Requires-Dist: karabo.services[with_cpp]==2.21.3; extra == "full"
30
+ Dynamic: license-file
31
+
32
+ # Karabo SCADA Framework - Karabo
33
+ ![Karabo Badge](https://img.shields.io/badge/Karabo-blue?style=social&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAAEQ8YrgAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAAB4lJREFUSA1tVQlwU9cVPX%2FXZmuxZcuSjWyMwQaDsUvLWmo7bEOHLSnETckQBgITWpO2CSmTlqnatEyazNCWpmEZYEpCS7DLpA3FbVPWTAIJ2GZfHNsgL1iWZGuz9S19Sf%2F1fWfSYdpeaeZ96f13l3PPuY%2FZsuWA0CfdZlFWhsDR22pb28EUHrOT2yt2jcrJpWlVcqWUaFEqMcDprTXQm10RNtF%2FNdfQ%2BeLiN0bvPXZk%2FLHW4%2BH1NhvH%2FPeG9vvNG4PGHXd99p3Xji%2FfZn3j93ZrHkZVFhkIAKMDUkGVVSJsJg00%2B585v73i%2BT0vS6PDCYur56mV1YE6hqE7X5gWwFD5zafdtvKaCpImlUl5pJIjqFCM5pLcRMi41%2FV6anIR9W0ATz8cVDDQjsehen1Qfte3WdfElaIkPqSOESZgMFt6ddlZDxgl0clmZXfwjUdOt930DRUakTFF%2FX6M%2BANIyTLUTAZ9LEfez%2FmRUC%2BnhVyavMAQEOpbSbHwj4H9LAHd5VA0Q4LtiFA4IEoOnSA4THbH10IZgqlmmlUKnFU0ZJv0AqvqbHZic5dkFDlOg4wwylic%2B2Uwxey8F4FFL8GpE5EhBB1yAoiNAkYd5hZO5MrLdCqnN6YFSa%2BC40k6EmIu3HnI1q36Bs%2FHlNSVzjPnViS7vCn3E3Ml5%2FQqTjLbkFGSFAuCRckxxKNhhINBDA08wmg4jEpnAXKnToTRagMr6UEYhiWEsDq9Af23buLRgSO00GIms2JhiOd5od9sz8GN0wcYX0cvlr5qRv6kMqR1OgR6e8BxPLLyXLC4iuGunAllNEobTVvHsEiMxDD84C6sBQWw5ORgqNeLwJV2JGFSMd%2FNyWk1wDM879VlmSiyZaS8qhj%2F3H0YmDwFVfWVkD%2B9gs7rXrjnTYO1uAiumhqIhixEB%2FrRc%2FlT9LV7oUS8KJhZDZ%2FMAZ8HqZ8RTDQaSFDgkQIJsYIk9PCShBxE2Ps3OvHK7k349Y4VCN%2FroM79KJnsQs%2Blh7j%2Bp99AHh4Gy%2FNIRKPoPncMlmwB2TnFiJuy8NOty%2FDR1bew81db8SB%2BFVUuO1SWC%2FOEZfoLCp34BEXc6k215OUXnmVyzCY8tWoZdh9sxv6feFA%2Bax7utxKKzBey4UQBkjQXVjaDjuEUDr2yGasXzKTEiOE7y79OHnhfRbfNDYHjo2yByA2yBkMK65exP%2FvBc0SJjyIwOIgiuwVb1i4FapYg2toPkRaf0ZSlGQ2UR1Lo8N7Fih%2BuQVWxAx237%2BDa9Tuwm41YvmgB00ZFIzGIsjkWw7BKyDCsFhj0OlWWxzAYGEZz8wcoddjw7i82w4cgyqAgnc6M%2B%2BdYFn3K55Qo89CweB7I2Ag4UURl1XRkOAnJRBIOWiUYEmW%2FXzszSsXhAysgGhtRbTkWHD58AuXlZcjONmHJnBn49s5G3EE7skQeVAYQqTPAhKcbFqK6rAjuCS44CvIRDkUotQE5HmcHKa15UYyyFFciZFKPcOEmzXxIpWFRUuwET1mgqiosJj1qZ5QCdd9DfukkpKk%2BDDYb8jZvhSNLD53AYcAXxIWLn%2BHGjbuIyQly9szHTFlkCGlWiLJazVQovRp13953nPTSl1etXIre3gGEwxGwHAdWGxB5FjACLZuWQHUFSa8fz1Y7393thd8fRGGhA5%2B03sTfmvaj1JkHJZ2JjQeQVaZ3%2BdxKtPzlIHP67CUUuSdgWsUkdHY%2BBE%2FxNpuzKb3HQOh80pyDqHSuEiRSaToZeOTbbVi5vA7Fk0px7OSHNKQFyaRCURAj4wF4ke%2BP0D%2FMFJ9dLx4ll9pvw1lUiK%2FOqkJfIIQP%2FnERViFDhaMpmLKJBnFLPPZ7jqG55TyKSidCpYrfd%2BQ9nP%2FzvrTZOBWixQomkx6j8qNMXLvJSjuyUVb0fNh7LX300DlIFpYR9Abm5789ivfe8qBQpmp35cFI8U%2FEIuj61zlEHj3Ah6daESWjePfURfX4xfuZKdVzhOr1a%2BDIsb6zcIp5v9Z0eDwetrt4weZ4PL4r1NNTqFHurC%2BQxuG%2FU%2FBjQulXytHddg3T161BWX09Yo96cea1A8iblAcmMAp%2FuVuZv2Sh6HS5wMgjQ26XY9ubDU80a7413jEehqHswUFP68CxLlPWS4qiND43o9ouz6rBpUPvJLrbung6rHmGNlzDX1utJXYEuryqmOVQVjQ8qTMaKaOSoyfqqmq%2Bu2FRxTCwliOkibC0azRLoLGlRfLMcsrHNtS%2FJqrxqnhgcA8RhPi0b63W2adP4JP4OJGKyxqF6JdB%2BGGnwjmd6vzGdTo9q%2FrsJPHMH7Y3NGjOG%2Fe2SPQy1VRJxiHSAmhW6znPw%2B3lL2zcSG8UYP3bf52SFsQdY7K8yd%2FZhajPl6mor1Pl4SDpuXVLnDJ7NnKzjX%2BcnZ%2F%2F0vOr5vixtonzTAPn8axTtPP0jqCp%2FB9b29QkBu%2Fa1QueuvHhs%2BXk5ZpYOPpjJZV%2BkvISybE4DKoSKMrN3bbn2cUnx13s3St5QqEU7acG97hpAb58%2Ft%2BVbm450EqV9R89YcOJj%2BY37DvV%2BsLB90%2B1tHfatUNNTU3cXgrvl8609bFn7t8fxThrSai%2FQAAAAABJRU5ErkJggg%3D%3D)
34
+ ![PyPI - Version](https://img.shields.io/pypi/v/karabo)
35
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/karabo)
36
+ ![PyPI - License](https://img.shields.io/pypi/l/karabo)
37
+ ![PyPI - Wheel](https://img.shields.io/pypi/wheel/karabo)
38
+ ![GitHub language count](https://img.shields.io/github/languages/count/European-XFEL/Karabo)
39
+ ![GitHub top language](https://img.shields.io/github/languages/top/European-XFEL/Karabo)
40
+ ![GitHub contributors](https://img.shields.io/github/contributors/European-XFEL/Karabo)
41
+ ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/European-XFEL/Karabo)
42
+ ![GitHub Repo stars](https://img.shields.io/github/stars/European-XFEL/Karabo)
43
+
44
+ Karabo is the [European XFEL](www.xfel.eu)'s SCADA framework. It is a scientific control system
45
+ that supports plugin (device) development in C++ and Python.
46
+
47
+ You can find an overview of Karabo on [Wikipedia](https://en.wikipedia.org/wiki/Karabo_(software)),
48
+ and in [this publication](https://www.tandfonline.com/doi/pdf/10.1080/08940886.2023.2277650).
49
+
50
+ The Karabo source repository is on [GitHub](https://github.com/European-XFEL/Karabo) and
51
+ also contains our [Contributing Guidelines](https://github.com/European-XFEL/Karabo/blob/main/CONTRIBUTING.md).
52
+
53
+ Additional documentation is available on [ReadTheDocs](https://karabo.readthedocs.io/en/latest/)
54
+
55
+ # Installation
56
+
57
+ This package facilitates installation of the various Karabo subpackages.
58
+
59
+ ## Standalone and Full
60
+
61
+ If you would like to try Karabo in a standalone fashion on a single machine
62
+ it's easiest to just run:
63
+
64
+ ```bash
65
+ pip install karabo[full]
66
+ ```
67
+
68
+ This will install a complete setup, including all essential service devices.
69
+ Note that this requires, compiled code to be installed. This will be done for
70
+ wheels on supported architectures, and a source compilate will be attempted otherwise.
71
+ If that fails, we recommend you follow the instructions at https://github.com/European-XFEL/Karabo
72
+ which will result in a self-consistent environment, including a Python interpreter, with
73
+ similar functionality to a `karabo[full]` installation.
74
+
75
+ If you require the GUI, you will need to install it separately into a different Python
76
+ environment, as it does not require it's dependencies to align outside those of `karabo.native`:
77
+
78
+ ```bash
79
+ pip install karabo[gui]
80
+ ```
81
+
82
+
83
+ After installation you should initialize the environment with either
84
+
85
+ ```bash
86
+ karabo-activate --init-to PATH --standalone
87
+ ```
88
+
89
+ for a standalone system, or
90
+
91
+
92
+ ```bash
93
+ karabo-activate --init-to PATH [--backbone] --broker-host amqp://{broker:port} --broker-topic {TOPIC}
94
+ ```
95
+
96
+ for headless full installations. The `--backbone` option sets the core services up, and the `--broker-*`
97
+ parameters are used to configure the installation according to your AMQP broker setup.
98
+
99
+ ## Additional options
100
+
101
+ - `karabo[karathon]` will install the Karathon Python API
102
+ - `karabo[cpp]` will install the Karabo C++ API
103
+ - `karabo[bound]` will install the Karabo Python bindings to C++
104
+ - `karabo[services]` will install service tools, allowing to manage installations with `karabo.daemontools`
105
+
106
+ Options can be combined, such as `karabo[karathon,services]`, which will result in a Karathon installation
107
+ with services tools installed.
108
+
109
+ To install the Karabo GUI, please use
110
+
111
+ ```bash
112
+ pip install karabo.gui
113
+ ```
114
+
115
+ ## Starting a Karabo standalone system
116
+
117
+ If you wish to run Karabo standalone you can do this if you have `podman` or `docker` installed on the system.
118
+
119
+ First, run
120
+
121
+ ```bash
122
+ karabo-activate --init-to PATH --standalone
123
+ ```
124
+
125
+ Then run
126
+
127
+ ```bash
128
+ podman-compose -f $PATH/var/containers/compose.yaml up
129
+ ```
130
+
131
+ or (`docker-compose ...`). This will start containerized version of the services a full
132
+ Karabo installation requires:
133
+
134
+ - A RabbitMQ broker (user: xfel, pw: karabo)
135
+ - An Influx database instance for logging (user: infadm, pw: admpwd)
136
+ - An ExistDB database as project database (user: admin, pw: change_me_please)
137
+ - A Grafana installation with the Influx database as a pre-provisioned source (user: admin, pw: admin)
138
+
139
+ Note that the Grafana provisioning assumes `karabo` as the broker topic in use. If you've
140
+ used `karabo-activate --broker-topic TOPIC` you'll need to edit the data source to refer to
141
+ a database of `TOPIC` from inside Grafana.
142
+
143
+ Finally, run
144
+
145
+ ```bash
146
+ $PATH/active
147
+ ```
148
+
149
+ followed by
150
+
151
+ ```bash
152
+ karabo-start
153
+ ```
154
+
155
+ # Device Development
156
+
157
+ These packages are not intended to facilitate development of devices for Karabo's C++ API. Please
158
+ create a self-consistent development environment using the instructions at https://github.com/European-XFEL/Karabo.
159
+
160
+ Development of devices against these packages using the Bound and Karathon Python APIs should be trivially
161
+ possibly, as long as the device packages define the correct entrypoints.
162
+
163
+ For the Karathon API, a line similar to this one should exist in your `pyproject.toml`:
164
+
165
+ ```toml
166
+ [project.entry-points."karabo.middlelayer_device"]
167
+ PropertyTestMDL = "karabo.middlelayer_devices.property_test:PropertyTestMDL"
168
+ ```
169
+
170
+ For the Bound API, a line similar to this one should exist in your `pyproject.toml`.
171
+
172
+ ```toml
173
+ [project.entry-points."karabo.bound_device"]
174
+ PropertyTest = "karabo.bound_devices.property_test:PropertyTest"
175
+ ```
@@ -0,0 +1,144 @@
1
+ # Karabo SCADA Framework - Karabo
2
+ ![Karabo Badge](https://img.shields.io/badge/Karabo-blue?style=social&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAAEQ8YrgAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAAB4lJREFUSA1tVQlwU9cVPX%2FXZmuxZcuSjWyMwQaDsUvLWmo7bEOHLSnETckQBgITWpO2CSmTlqnatEyazNCWpmEZYEpCS7DLpA3FbVPWTAIJ2GZfHNsgL1iWZGuz9S19Sf%2F1fWfSYdpeaeZ96f13l3PPuY%2FZsuWA0CfdZlFWhsDR22pb28EUHrOT2yt2jcrJpWlVcqWUaFEqMcDprTXQm10RNtF%2FNdfQ%2BeLiN0bvPXZk%2FLHW4%2BH1NhvH%2FPeG9vvNG4PGHXd99p3Xji%2FfZn3j93ZrHkZVFhkIAKMDUkGVVSJsJg00%2B585v73i%2BT0vS6PDCYur56mV1YE6hqE7X5gWwFD5zafdtvKaCpImlUl5pJIjqFCM5pLcRMi41%2FV6anIR9W0ATz8cVDDQjsehen1Qfte3WdfElaIkPqSOESZgMFt6ddlZDxgl0clmZXfwjUdOt930DRUakTFF%2FX6M%2BANIyTLUTAZ9LEfez%2FmRUC%2BnhVyavMAQEOpbSbHwj4H9LAHd5VA0Q4LtiFA4IEoOnSA4THbH10IZgqlmmlUKnFU0ZJv0AqvqbHZic5dkFDlOg4wwylic%2B2Uwxey8F4FFL8GpE5EhBB1yAoiNAkYd5hZO5MrLdCqnN6YFSa%2BC40k6EmIu3HnI1q36Bs%2FHlNSVzjPnViS7vCn3E3Ml5%2FQqTjLbkFGSFAuCRckxxKNhhINBDA08wmg4jEpnAXKnToTRagMr6UEYhiWEsDq9Af23buLRgSO00GIms2JhiOd5od9sz8GN0wcYX0cvlr5qRv6kMqR1OgR6e8BxPLLyXLC4iuGunAllNEobTVvHsEiMxDD84C6sBQWw5ORgqNeLwJV2JGFSMd%2FNyWk1wDM879VlmSiyZaS8qhj%2F3H0YmDwFVfWVkD%2B9gs7rXrjnTYO1uAiumhqIhixEB%2FrRc%2FlT9LV7oUS8KJhZDZ%2FMAZ8HqZ8RTDQaSFDgkQIJsYIk9PCShBxE2Ps3OvHK7k349Y4VCN%2FroM79KJnsQs%2Blh7j%2Bp99AHh4Gy%2FNIRKPoPncMlmwB2TnFiJuy8NOty%2FDR1bew81db8SB%2BFVUuO1SWC%2FOEZfoLCp34BEXc6k215OUXnmVyzCY8tWoZdh9sxv6feFA%2Bax7utxKKzBey4UQBkjQXVjaDjuEUDr2yGasXzKTEiOE7y79OHnhfRbfNDYHjo2yByA2yBkMK65exP%2FvBc0SJjyIwOIgiuwVb1i4FapYg2toPkRaf0ZSlGQ2UR1Lo8N7Fih%2BuQVWxAx237%2BDa9Tuwm41YvmgB00ZFIzGIsjkWw7BKyDCsFhj0OlWWxzAYGEZz8wcoddjw7i82w4cgyqAgnc6M%2B%2BdYFn3K55Qo89CweB7I2Ag4UURl1XRkOAnJRBIOWiUYEmW%2FXzszSsXhAysgGhtRbTkWHD58AuXlZcjONmHJnBn49s5G3EE7skQeVAYQqTPAhKcbFqK6rAjuCS44CvIRDkUotQE5HmcHKa15UYyyFFciZFKPcOEmzXxIpWFRUuwET1mgqiosJj1qZ5QCdd9DfukkpKk%2BDDYb8jZvhSNLD53AYcAXxIWLn%2BHGjbuIyQly9szHTFlkCGlWiLJazVQovRp13953nPTSl1etXIre3gGEwxGwHAdWGxB5FjACLZuWQHUFSa8fz1Y7393thd8fRGGhA5%2B03sTfmvaj1JkHJZ2JjQeQVaZ3%2BdxKtPzlIHP67CUUuSdgWsUkdHY%2BBE%2FxNpuzKb3HQOh80pyDqHSuEiRSaToZeOTbbVi5vA7Fk0px7OSHNKQFyaRCURAj4wF4ke%2BP0D%2FMFJ9dLx4ll9pvw1lUiK%2FOqkJfIIQP%2FnERViFDhaMpmLKJBnFLPPZ7jqG55TyKSidCpYrfd%2BQ9nP%2FzvrTZOBWixQomkx6j8qNMXLvJSjuyUVb0fNh7LX300DlIFpYR9Abm5789ivfe8qBQpmp35cFI8U%2FEIuj61zlEHj3Ah6daESWjePfURfX4xfuZKdVzhOr1a%2BDIsb6zcIp5v9Z0eDwetrt4weZ4PL4r1NNTqFHurC%2BQxuG%2FU%2FBjQulXytHddg3T161BWX09Yo96cea1A8iblAcmMAp%2FuVuZv2Sh6HS5wMgjQ26XY9ubDU80a7413jEehqHswUFP68CxLlPWS4qiND43o9ouz6rBpUPvJLrbung6rHmGNlzDX1utJXYEuryqmOVQVjQ8qTMaKaOSoyfqqmq%2Bu2FRxTCwliOkibC0azRLoLGlRfLMcsrHNtS%2FJqrxqnhgcA8RhPi0b63W2adP4JP4OJGKyxqF6JdB%2BGGnwjmd6vzGdTo9q%2FrsJPHMH7Y3NGjOG%2Fe2SPQy1VRJxiHSAmhW6znPw%2B3lL2zcSG8UYP3bf52SFsQdY7K8yd%2FZhajPl6mor1Pl4SDpuXVLnDJ7NnKzjX%2BcnZ%2F%2F0vOr5vixtonzTAPn8axTtPP0jqCp%2FB9b29QkBu%2Fa1QueuvHhs%2BXk5ZpYOPpjJZV%2BkvISybE4DKoSKMrN3bbn2cUnx13s3St5QqEU7acG97hpAb58%2Ft%2BVbm450EqV9R89YcOJj%2BY37DvV%2BsLB90%2B1tHfatUNNTU3cXgrvl8609bFn7t8fxThrSai%2FQAAAAABJRU5ErkJggg%3D%3D)
3
+ ![PyPI - Version](https://img.shields.io/pypi/v/karabo)
4
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/karabo)
5
+ ![PyPI - License](https://img.shields.io/pypi/l/karabo)
6
+ ![PyPI - Wheel](https://img.shields.io/pypi/wheel/karabo)
7
+ ![GitHub language count](https://img.shields.io/github/languages/count/European-XFEL/Karabo)
8
+ ![GitHub top language](https://img.shields.io/github/languages/top/European-XFEL/Karabo)
9
+ ![GitHub contributors](https://img.shields.io/github/contributors/European-XFEL/Karabo)
10
+ ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/European-XFEL/Karabo)
11
+ ![GitHub Repo stars](https://img.shields.io/github/stars/European-XFEL/Karabo)
12
+
13
+ Karabo is the [European XFEL](www.xfel.eu)'s SCADA framework. It is a scientific control system
14
+ that supports plugin (device) development in C++ and Python.
15
+
16
+ You can find an overview of Karabo on [Wikipedia](https://en.wikipedia.org/wiki/Karabo_(software)),
17
+ and in [this publication](https://www.tandfonline.com/doi/pdf/10.1080/08940886.2023.2277650).
18
+
19
+ The Karabo source repository is on [GitHub](https://github.com/European-XFEL/Karabo) and
20
+ also contains our [Contributing Guidelines](https://github.com/European-XFEL/Karabo/blob/main/CONTRIBUTING.md).
21
+
22
+ Additional documentation is available on [ReadTheDocs](https://karabo.readthedocs.io/en/latest/)
23
+
24
+ # Installation
25
+
26
+ This package facilitates installation of the various Karabo subpackages.
27
+
28
+ ## Standalone and Full
29
+
30
+ If you would like to try Karabo in a standalone fashion on a single machine
31
+ it's easiest to just run:
32
+
33
+ ```bash
34
+ pip install karabo[full]
35
+ ```
36
+
37
+ This will install a complete setup, including all essential service devices.
38
+ Note that this requires, compiled code to be installed. This will be done for
39
+ wheels on supported architectures, and a source compilate will be attempted otherwise.
40
+ If that fails, we recommend you follow the instructions at https://github.com/European-XFEL/Karabo
41
+ which will result in a self-consistent environment, including a Python interpreter, with
42
+ similar functionality to a `karabo[full]` installation.
43
+
44
+ If you require the GUI, you will need to install it separately into a different Python
45
+ environment, as it does not require it's dependencies to align outside those of `karabo.native`:
46
+
47
+ ```bash
48
+ pip install karabo[gui]
49
+ ```
50
+
51
+
52
+ After installation you should initialize the environment with either
53
+
54
+ ```bash
55
+ karabo-activate --init-to PATH --standalone
56
+ ```
57
+
58
+ for a standalone system, or
59
+
60
+
61
+ ```bash
62
+ karabo-activate --init-to PATH [--backbone] --broker-host amqp://{broker:port} --broker-topic {TOPIC}
63
+ ```
64
+
65
+ for headless full installations. The `--backbone` option sets the core services up, and the `--broker-*`
66
+ parameters are used to configure the installation according to your AMQP broker setup.
67
+
68
+ ## Additional options
69
+
70
+ - `karabo[karathon]` will install the Karathon Python API
71
+ - `karabo[cpp]` will install the Karabo C++ API
72
+ - `karabo[bound]` will install the Karabo Python bindings to C++
73
+ - `karabo[services]` will install service tools, allowing to manage installations with `karabo.daemontools`
74
+
75
+ Options can be combined, such as `karabo[karathon,services]`, which will result in a Karathon installation
76
+ with services tools installed.
77
+
78
+ To install the Karabo GUI, please use
79
+
80
+ ```bash
81
+ pip install karabo.gui
82
+ ```
83
+
84
+ ## Starting a Karabo standalone system
85
+
86
+ If you wish to run Karabo standalone you can do this if you have `podman` or `docker` installed on the system.
87
+
88
+ First, run
89
+
90
+ ```bash
91
+ karabo-activate --init-to PATH --standalone
92
+ ```
93
+
94
+ Then run
95
+
96
+ ```bash
97
+ podman-compose -f $PATH/var/containers/compose.yaml up
98
+ ```
99
+
100
+ or (`docker-compose ...`). This will start containerized version of the services a full
101
+ Karabo installation requires:
102
+
103
+ - A RabbitMQ broker (user: xfel, pw: karabo)
104
+ - An Influx database instance for logging (user: infadm, pw: admpwd)
105
+ - An ExistDB database as project database (user: admin, pw: change_me_please)
106
+ - A Grafana installation with the Influx database as a pre-provisioned source (user: admin, pw: admin)
107
+
108
+ Note that the Grafana provisioning assumes `karabo` as the broker topic in use. If you've
109
+ used `karabo-activate --broker-topic TOPIC` you'll need to edit the data source to refer to
110
+ a database of `TOPIC` from inside Grafana.
111
+
112
+ Finally, run
113
+
114
+ ```bash
115
+ $PATH/active
116
+ ```
117
+
118
+ followed by
119
+
120
+ ```bash
121
+ karabo-start
122
+ ```
123
+
124
+ # Device Development
125
+
126
+ These packages are not intended to facilitate development of devices for Karabo's C++ API. Please
127
+ create a self-consistent development environment using the instructions at https://github.com/European-XFEL/Karabo.
128
+
129
+ Development of devices against these packages using the Bound and Karathon Python APIs should be trivially
130
+ possibly, as long as the device packages define the correct entrypoints.
131
+
132
+ For the Karathon API, a line similar to this one should exist in your `pyproject.toml`:
133
+
134
+ ```toml
135
+ [project.entry-points."karabo.middlelayer_device"]
136
+ PropertyTestMDL = "karabo.middlelayer_devices.property_test:PropertyTestMDL"
137
+ ```
138
+
139
+ For the Bound API, a line similar to this one should exist in your `pyproject.toml`.
140
+
141
+ ```toml
142
+ [project.entry-points."karabo.bound_device"]
143
+ PropertyTest = "karabo.bound_devices.property_test:PropertyTest"
144
+ ```
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.4
2
+ Name: karabo
3
+ Version: 2.21.3
4
+ Summary: The Karabo SCADA system
5
+ Author-email: European XFEL GmbH <opensource@xfel.eu>
6
+ Maintainer-email: "S. Hauf" <steffen.hauf@xfel.eu>, "D. Goeries" <dennis.goeries@xfel.eu>
7
+ License-Expression: MPL-2.0
8
+ Project-URL: Homepage, https://github.com/European-XFEL/Karabo
9
+ Project-URL: Bug Reports, https://github.com/European-XFEL/Karabo/issues
10
+ Project-URL: Source, https://github.com/European-XFEL/Karabo
11
+ Keywords: Karabo,SCADA,async,control system
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: Science/Research
15
+ Requires-Python: >=3.12
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE.md
18
+ Requires-Dist: karabo.karathon==2.21.3
19
+ Provides-Extra: services
20
+ Requires-Dist: karabo.services==2.21.3; extra == "services"
21
+ Provides-Extra: karathon
22
+ Requires-Dist: karabo.karathon==2.21.3; extra == "karathon"
23
+ Provides-Extra: bound
24
+ Requires-Dist: karabo.bound==2.21.3; extra == "bound"
25
+ Provides-Extra: cpp
26
+ Requires-Dist: karabo.cpp==2.21.3; extra == "cpp"
27
+ Provides-Extra: full
28
+ Requires-Dist: karabo.bound==2.21.3; extra == "full"
29
+ Requires-Dist: karabo.services[with_cpp]==2.21.3; extra == "full"
30
+ Dynamic: license-file
31
+
32
+ # Karabo SCADA Framework - Karabo
33
+ ![Karabo Badge](https://img.shields.io/badge/Karabo-blue?style=social&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAAEQ8YrgAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAAB4lJREFUSA1tVQlwU9cVPX%2FXZmuxZcuSjWyMwQaDsUvLWmo7bEOHLSnETckQBgITWpO2CSmTlqnatEyazNCWpmEZYEpCS7DLpA3FbVPWTAIJ2GZfHNsgL1iWZGuz9S19Sf%2F1fWfSYdpeaeZ96f13l3PPuY%2FZsuWA0CfdZlFWhsDR22pb28EUHrOT2yt2jcrJpWlVcqWUaFEqMcDprTXQm10RNtF%2FNdfQ%2BeLiN0bvPXZk%2FLHW4%2BH1NhvH%2FPeG9vvNG4PGHXd99p3Xji%2FfZn3j93ZrHkZVFhkIAKMDUkGVVSJsJg00%2B585v73i%2BT0vS6PDCYur56mV1YE6hqE7X5gWwFD5zafdtvKaCpImlUl5pJIjqFCM5pLcRMi41%2FV6anIR9W0ATz8cVDDQjsehen1Qfte3WdfElaIkPqSOESZgMFt6ddlZDxgl0clmZXfwjUdOt930DRUakTFF%2FX6M%2BANIyTLUTAZ9LEfez%2FmRUC%2BnhVyavMAQEOpbSbHwj4H9LAHd5VA0Q4LtiFA4IEoOnSA4THbH10IZgqlmmlUKnFU0ZJv0AqvqbHZic5dkFDlOg4wwylic%2B2Uwxey8F4FFL8GpE5EhBB1yAoiNAkYd5hZO5MrLdCqnN6YFSa%2BC40k6EmIu3HnI1q36Bs%2FHlNSVzjPnViS7vCn3E3Ml5%2FQqTjLbkFGSFAuCRckxxKNhhINBDA08wmg4jEpnAXKnToTRagMr6UEYhiWEsDq9Af23buLRgSO00GIms2JhiOd5od9sz8GN0wcYX0cvlr5qRv6kMqR1OgR6e8BxPLLyXLC4iuGunAllNEobTVvHsEiMxDD84C6sBQWw5ORgqNeLwJV2JGFSMd%2FNyWk1wDM879VlmSiyZaS8qhj%2F3H0YmDwFVfWVkD%2B9gs7rXrjnTYO1uAiumhqIhixEB%2FrRc%2FlT9LV7oUS8KJhZDZ%2FMAZ8HqZ8RTDQaSFDgkQIJsYIk9PCShBxE2Ps3OvHK7k349Y4VCN%2FroM79KJnsQs%2Blh7j%2Bp99AHh4Gy%2FNIRKPoPncMlmwB2TnFiJuy8NOty%2FDR1bew81db8SB%2BFVUuO1SWC%2FOEZfoLCp34BEXc6k215OUXnmVyzCY8tWoZdh9sxv6feFA%2Bax7utxKKzBey4UQBkjQXVjaDjuEUDr2yGasXzKTEiOE7y79OHnhfRbfNDYHjo2yByA2yBkMK65exP%2FvBc0SJjyIwOIgiuwVb1i4FapYg2toPkRaf0ZSlGQ2UR1Lo8N7Fih%2BuQVWxAx237%2BDa9Tuwm41YvmgB00ZFIzGIsjkWw7BKyDCsFhj0OlWWxzAYGEZz8wcoddjw7i82w4cgyqAgnc6M%2B%2BdYFn3K55Qo89CweB7I2Ag4UURl1XRkOAnJRBIOWiUYEmW%2FXzszSsXhAysgGhtRbTkWHD58AuXlZcjONmHJnBn49s5G3EE7skQeVAYQqTPAhKcbFqK6rAjuCS44CvIRDkUotQE5HmcHKa15UYyyFFciZFKPcOEmzXxIpWFRUuwET1mgqiosJj1qZ5QCdd9DfukkpKk%2BDDYb8jZvhSNLD53AYcAXxIWLn%2BHGjbuIyQly9szHTFlkCGlWiLJazVQovRp13953nPTSl1etXIre3gGEwxGwHAdWGxB5FjACLZuWQHUFSa8fz1Y7393thd8fRGGhA5%2B03sTfmvaj1JkHJZ2JjQeQVaZ3%2BdxKtPzlIHP67CUUuSdgWsUkdHY%2BBE%2FxNpuzKb3HQOh80pyDqHSuEiRSaToZeOTbbVi5vA7Fk0px7OSHNKQFyaRCURAj4wF4ke%2BP0D%2FMFJ9dLx4ll9pvw1lUiK%2FOqkJfIIQP%2FnERViFDhaMpmLKJBnFLPPZ7jqG55TyKSidCpYrfd%2BQ9nP%2FzvrTZOBWixQomkx6j8qNMXLvJSjuyUVb0fNh7LX300DlIFpYR9Abm5789ivfe8qBQpmp35cFI8U%2FEIuj61zlEHj3Ah6daESWjePfURfX4xfuZKdVzhOr1a%2BDIsb6zcIp5v9Z0eDwetrt4weZ4PL4r1NNTqFHurC%2BQxuG%2FU%2FBjQulXytHddg3T161BWX09Yo96cea1A8iblAcmMAp%2FuVuZv2Sh6HS5wMgjQ26XY9ubDU80a7413jEehqHswUFP68CxLlPWS4qiND43o9ouz6rBpUPvJLrbung6rHmGNlzDX1utJXYEuryqmOVQVjQ8qTMaKaOSoyfqqmq%2Bu2FRxTCwliOkibC0azRLoLGlRfLMcsrHNtS%2FJqrxqnhgcA8RhPi0b63W2adP4JP4OJGKyxqF6JdB%2BGGnwjmd6vzGdTo9q%2FrsJPHMH7Y3NGjOG%2Fe2SPQy1VRJxiHSAmhW6znPw%2B3lL2zcSG8UYP3bf52SFsQdY7K8yd%2FZhajPl6mor1Pl4SDpuXVLnDJ7NnKzjX%2BcnZ%2F%2F0vOr5vixtonzTAPn8axTtPP0jqCp%2FB9b29QkBu%2Fa1QueuvHhs%2BXk5ZpYOPpjJZV%2BkvISybE4DKoSKMrN3bbn2cUnx13s3St5QqEU7acG97hpAb58%2Ft%2BVbm450EqV9R89YcOJj%2BY37DvV%2BsLB90%2B1tHfatUNNTU3cXgrvl8609bFn7t8fxThrSai%2FQAAAAABJRU5ErkJggg%3D%3D)
34
+ ![PyPI - Version](https://img.shields.io/pypi/v/karabo)
35
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/karabo)
36
+ ![PyPI - License](https://img.shields.io/pypi/l/karabo)
37
+ ![PyPI - Wheel](https://img.shields.io/pypi/wheel/karabo)
38
+ ![GitHub language count](https://img.shields.io/github/languages/count/European-XFEL/Karabo)
39
+ ![GitHub top language](https://img.shields.io/github/languages/top/European-XFEL/Karabo)
40
+ ![GitHub contributors](https://img.shields.io/github/contributors/European-XFEL/Karabo)
41
+ ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/European-XFEL/Karabo)
42
+ ![GitHub Repo stars](https://img.shields.io/github/stars/European-XFEL/Karabo)
43
+
44
+ Karabo is the [European XFEL](www.xfel.eu)'s SCADA framework. It is a scientific control system
45
+ that supports plugin (device) development in C++ and Python.
46
+
47
+ You can find an overview of Karabo on [Wikipedia](https://en.wikipedia.org/wiki/Karabo_(software)),
48
+ and in [this publication](https://www.tandfonline.com/doi/pdf/10.1080/08940886.2023.2277650).
49
+
50
+ The Karabo source repository is on [GitHub](https://github.com/European-XFEL/Karabo) and
51
+ also contains our [Contributing Guidelines](https://github.com/European-XFEL/Karabo/blob/main/CONTRIBUTING.md).
52
+
53
+ Additional documentation is available on [ReadTheDocs](https://karabo.readthedocs.io/en/latest/)
54
+
55
+ # Installation
56
+
57
+ This package facilitates installation of the various Karabo subpackages.
58
+
59
+ ## Standalone and Full
60
+
61
+ If you would like to try Karabo in a standalone fashion on a single machine
62
+ it's easiest to just run:
63
+
64
+ ```bash
65
+ pip install karabo[full]
66
+ ```
67
+
68
+ This will install a complete setup, including all essential service devices.
69
+ Note that this requires, compiled code to be installed. This will be done for
70
+ wheels on supported architectures, and a source compilate will be attempted otherwise.
71
+ If that fails, we recommend you follow the instructions at https://github.com/European-XFEL/Karabo
72
+ which will result in a self-consistent environment, including a Python interpreter, with
73
+ similar functionality to a `karabo[full]` installation.
74
+
75
+ If you require the GUI, you will need to install it separately into a different Python
76
+ environment, as it does not require it's dependencies to align outside those of `karabo.native`:
77
+
78
+ ```bash
79
+ pip install karabo[gui]
80
+ ```
81
+
82
+
83
+ After installation you should initialize the environment with either
84
+
85
+ ```bash
86
+ karabo-activate --init-to PATH --standalone
87
+ ```
88
+
89
+ for a standalone system, or
90
+
91
+
92
+ ```bash
93
+ karabo-activate --init-to PATH [--backbone] --broker-host amqp://{broker:port} --broker-topic {TOPIC}
94
+ ```
95
+
96
+ for headless full installations. The `--backbone` option sets the core services up, and the `--broker-*`
97
+ parameters are used to configure the installation according to your AMQP broker setup.
98
+
99
+ ## Additional options
100
+
101
+ - `karabo[karathon]` will install the Karathon Python API
102
+ - `karabo[cpp]` will install the Karabo C++ API
103
+ - `karabo[bound]` will install the Karabo Python bindings to C++
104
+ - `karabo[services]` will install service tools, allowing to manage installations with `karabo.daemontools`
105
+
106
+ Options can be combined, such as `karabo[karathon,services]`, which will result in a Karathon installation
107
+ with services tools installed.
108
+
109
+ To install the Karabo GUI, please use
110
+
111
+ ```bash
112
+ pip install karabo.gui
113
+ ```
114
+
115
+ ## Starting a Karabo standalone system
116
+
117
+ If you wish to run Karabo standalone you can do this if you have `podman` or `docker` installed on the system.
118
+
119
+ First, run
120
+
121
+ ```bash
122
+ karabo-activate --init-to PATH --standalone
123
+ ```
124
+
125
+ Then run
126
+
127
+ ```bash
128
+ podman-compose -f $PATH/var/containers/compose.yaml up
129
+ ```
130
+
131
+ or (`docker-compose ...`). This will start containerized version of the services a full
132
+ Karabo installation requires:
133
+
134
+ - A RabbitMQ broker (user: xfel, pw: karabo)
135
+ - An Influx database instance for logging (user: infadm, pw: admpwd)
136
+ - An ExistDB database as project database (user: admin, pw: change_me_please)
137
+ - A Grafana installation with the Influx database as a pre-provisioned source (user: admin, pw: admin)
138
+
139
+ Note that the Grafana provisioning assumes `karabo` as the broker topic in use. If you've
140
+ used `karabo-activate --broker-topic TOPIC` you'll need to edit the data source to refer to
141
+ a database of `TOPIC` from inside Grafana.
142
+
143
+ Finally, run
144
+
145
+ ```bash
146
+ $PATH/active
147
+ ```
148
+
149
+ followed by
150
+
151
+ ```bash
152
+ karabo-start
153
+ ```
154
+
155
+ # Device Development
156
+
157
+ These packages are not intended to facilitate development of devices for Karabo's C++ API. Please
158
+ create a self-consistent development environment using the instructions at https://github.com/European-XFEL/Karabo.
159
+
160
+ Development of devices against these packages using the Bound and Karathon Python APIs should be trivially
161
+ possibly, as long as the device packages define the correct entrypoints.
162
+
163
+ For the Karathon API, a line similar to this one should exist in your `pyproject.toml`:
164
+
165
+ ```toml
166
+ [project.entry-points."karabo.middlelayer_device"]
167
+ PropertyTestMDL = "karabo.middlelayer_devices.property_test:PropertyTestMDL"
168
+ ```
169
+
170
+ For the Bound API, a line similar to this one should exist in your `pyproject.toml`.
171
+
172
+ ```toml
173
+ [project.entry-points."karabo.bound_device"]
174
+ PropertyTest = "karabo.bound_devices.property_test:PropertyTest"
175
+ ```
@@ -0,0 +1,8 @@
1
+ LICENSE.md
2
+ README.md
3
+ pyproject.toml
4
+ karabo.egg-info/PKG-INFO
5
+ karabo.egg-info/SOURCES.txt
6
+ karabo.egg-info/dependency_links.txt
7
+ karabo.egg-info/requires.txt
8
+ karabo.egg-info/top_level.txt
@@ -0,0 +1,17 @@
1
+ karabo.karathon==2.21.3
2
+
3
+ [bound]
4
+ karabo.bound==2.21.3
5
+
6
+ [cpp]
7
+ karabo.cpp==2.21.3
8
+
9
+ [full]
10
+ karabo.bound==2.21.3
11
+ karabo.services[with_cpp]==2.21.3
12
+
13
+ [karathon]
14
+ karabo.karathon==2.21.3
15
+
16
+ [services]
17
+ karabo.services==2.21.3
@@ -0,0 +1,61 @@
1
+ [build-system]
2
+ # A list of packages that are needed to build your package:
3
+ requires = ["setuptools"] # REQUIRED if [build-system] table is used
4
+ # The name of the Python object that frontends will use to perform the build:
5
+ build-backend = "setuptools.build_meta" # If not defined, then legacy behavior can happen.
6
+
7
+
8
+ [project]
9
+ version = "2.21.3"
10
+ name = "karabo"
11
+ description = "The Karabo SCADA system"
12
+ readme = "README.md"
13
+ requires-python = ">=3.12"
14
+ license = "MPL-2.0"
15
+ keywords = ["Karabo", "SCADA", "async", "control system"]
16
+ authors = [{ name = "European XFEL GmbH", email = "opensource@xfel.eu" }]
17
+ maintainers = [
18
+ { name = "S. Hauf", email = "steffen.hauf@xfel.eu" },
19
+ { name = "D. Goeries", email = "dennis.goeries@xfel.eu" },
20
+ ]
21
+
22
+ # Classifiers help users find your project by categorizing it.
23
+ #
24
+ # For a list of valid classifiers, see https://pypi.org/classifiers/
25
+ classifiers = [
26
+ # How mature is this project? Common values are
27
+ # 3 - Alpha
28
+ # 4 - Beta
29
+ # 5 - Production/Stable
30
+ "Development Status :: 5 - Production/Stable",
31
+
32
+ # Indicate who your project is intended for
33
+ "Intended Audience :: Developers",
34
+ "Intended Audience :: Science/Research",
35
+ ]
36
+
37
+ dependencies = [
38
+ # unqualified we install a karathon setup with services
39
+ # which happens to be karabo.services
40
+ "karabo.karathon==2.21.3",
41
+ ]
42
+
43
+
44
+ [project.optional-dependencies]
45
+ services = ["karabo.services==2.21.3"]
46
+ karathon = ["karabo.karathon==2.21.3"]
47
+ bound = ["karabo.bound==2.21.3"]
48
+ cpp = ["karabo.cpp==2.21.3"]
49
+
50
+ # a full headless installation
51
+ # bound includes c++,
52
+ # services includes karathon
53
+ full = [
54
+ "karabo.bound==2.21.3",
55
+ "karabo.services[with_cpp]==2.21.3",
56
+ ]
57
+
58
+ [project.urls]
59
+ "Homepage" = "https://github.com/European-XFEL/Karabo"
60
+ "Bug Reports" = "https://github.com/European-XFEL/Karabo/issues"
61
+ "Source" = "https://github.com/European-XFEL/Karabo"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+