bec-widgets 0.56.0__py3-none-any.whl → 0.56.2__py3-none-any.whl
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.
- CHANGELOG.md +26 -33
- PKG-INFO +1 -1
- bec_widgets/cli/client.py +20 -0
- bec_widgets/widgets/dock/dock.py +6 -2
- bec_widgets/widgets/dock/dock_area.py +8 -3
- bec_widgets/widgets/figure/figure.py +1 -1
- bec_widgets/widgets/spiral_progress_bar/ring.py +7 -7
- bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py +1 -2
- {bec_widgets-0.56.0.dist-info → bec_widgets-0.56.2.dist-info}/METADATA +1 -1
- {bec_widgets-0.56.0.dist-info → bec_widgets-0.56.2.dist-info}/RECORD +33 -23
- docs/_static/custom.css +170 -0
- docs/{developer/reference.md → api_reference/api_reference.md} +3 -1
- docs/assets/apps_48dp.svg +1 -0
- docs/assets/display_settings_48dp.svg +1 -0
- docs/assets/index_api.svg +97 -0
- docs/assets/index_contribute.svg +76 -0
- docs/assets/index_getting_started.svg +66 -0
- docs/assets/index_user_guide.svg +67 -0
- docs/assets/rocket_launch_48dp.svg +1 -0
- docs/conf.py +3 -3
- docs/developer/developer.md +0 -8
- docs/index.md +39 -8
- docs/user/api_reference/api_reference.md +11 -0
- docs/user/{apps.md → applications/applications.md} +1 -1
- docs/user/getting_started/getting_started.md +12 -0
- docs/user/{installation.md → getting_started/installation.md} +1 -1
- docs/user/user.md +51 -22
- docs/user/{widgets.md → widgets/widgets.md} +3 -3
- pyproject.toml +1 -1
- tests/end-2-end/test_bec_dock_rpc_e2e.py +5 -5
- tests/unit_tests/test_spiral_progress_bar.py +5 -5
- {bec_widgets-0.56.0.dist-info → bec_widgets-0.56.2.dist-info}/WHEEL +0 -0
- {bec_widgets-0.56.0.dist-info → bec_widgets-0.56.2.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
|
3
|
+
|
|
4
|
+
<svg
|
|
5
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
6
|
+
xmlns:cc="http://creativecommons.org/ns#"
|
|
7
|
+
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
|
8
|
+
xmlns:svg="http://www.w3.org/2000/svg"
|
|
9
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
10
|
+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
11
|
+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
12
|
+
width="99.058548mm"
|
|
13
|
+
height="89.967583mm"
|
|
14
|
+
viewBox="0 0 99.058554 89.967582"
|
|
15
|
+
version="1.1"
|
|
16
|
+
id="svg1040"
|
|
17
|
+
inkscape:version="0.92.4 (f8dce91, 2019-08-02)"
|
|
18
|
+
sodipodi:docname="index_api.svg">
|
|
19
|
+
<defs
|
|
20
|
+
id="defs1034" />
|
|
21
|
+
<sodipodi:namedview
|
|
22
|
+
id="base"
|
|
23
|
+
pagecolor="#ffffff"
|
|
24
|
+
bordercolor="#666666"
|
|
25
|
+
borderopacity="1.0"
|
|
26
|
+
inkscape:pageopacity="0.0"
|
|
27
|
+
inkscape:pageshadow="2"
|
|
28
|
+
inkscape:zoom="0.35"
|
|
29
|
+
inkscape:cx="533.74914"
|
|
30
|
+
inkscape:cy="10.90433"
|
|
31
|
+
inkscape:document-units="mm"
|
|
32
|
+
inkscape:current-layer="layer1"
|
|
33
|
+
showgrid="false"
|
|
34
|
+
fit-margin-top="0"
|
|
35
|
+
fit-margin-left="0"
|
|
36
|
+
fit-margin-right="0"
|
|
37
|
+
fit-margin-bottom="0"
|
|
38
|
+
inkscape:window-width="930"
|
|
39
|
+
inkscape:window-height="472"
|
|
40
|
+
inkscape:window-x="2349"
|
|
41
|
+
inkscape:window-y="267"
|
|
42
|
+
inkscape:window-maximized="0" />
|
|
43
|
+
<metadata
|
|
44
|
+
id="metadata1037">
|
|
45
|
+
<rdf:RDF>
|
|
46
|
+
<cc:Work
|
|
47
|
+
rdf:about="">
|
|
48
|
+
<dc:format>image/svg+xml</dc:format>
|
|
49
|
+
<dc:type
|
|
50
|
+
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
|
51
|
+
<dc:title></dc:title>
|
|
52
|
+
</cc:Work>
|
|
53
|
+
</rdf:RDF>
|
|
54
|
+
</metadata>
|
|
55
|
+
<g
|
|
56
|
+
inkscape:label="Layer 1"
|
|
57
|
+
inkscape:groupmode="layer"
|
|
58
|
+
id="layer1"
|
|
59
|
+
transform="translate(195.19933,-1.0492759)">
|
|
60
|
+
<g
|
|
61
|
+
id="g1008"
|
|
62
|
+
transform="matrix(1.094977,0,0,1.094977,-521.5523,-198.34055)">
|
|
63
|
+
<path
|
|
64
|
+
inkscape:connector-curvature="0"
|
|
65
|
+
id="path899"
|
|
66
|
+
d="M 324.96812,187.09499 H 303.0455 v 72.1639 h 22.67969"
|
|
67
|
+
style="fill:none;stroke:#5a5a5a;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
|
68
|
+
<path
|
|
69
|
+
inkscape:connector-curvature="0"
|
|
70
|
+
id="path899-3"
|
|
71
|
+
d="m 361.58921,187.09499 h 21.92262 v 72.1639 h -22.67969"
|
|
72
|
+
style="fill:none;stroke:#5a5a5a;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
|
73
|
+
<g
|
|
74
|
+
transform="translate(415.87139,46.162126)"
|
|
75
|
+
id="g944">
|
|
76
|
+
<circle
|
|
77
|
+
style="fill:#5a5a5a;fill-opacity:1;stroke:#5a5a5a;stroke-width:4.53704548;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
|
78
|
+
id="path918"
|
|
79
|
+
cx="-84.40152"
|
|
80
|
+
cy="189.84375"
|
|
81
|
+
r="2.2293637" />
|
|
82
|
+
<circle
|
|
83
|
+
style="fill:#5a5a5a;fill-opacity:1;stroke:#5a5a5a;stroke-width:4.53704548;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
|
84
|
+
id="path918-5"
|
|
85
|
+
cx="-72.949402"
|
|
86
|
+
cy="189.84375"
|
|
87
|
+
r="2.2293637" />
|
|
88
|
+
<circle
|
|
89
|
+
style="fill:#5a5a5a;fill-opacity:1;stroke:#5a5a5a;stroke-width:4.53704548;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
|
90
|
+
id="path918-6"
|
|
91
|
+
cx="-61.497284"
|
|
92
|
+
cy="189.84375"
|
|
93
|
+
r="2.2293637" />
|
|
94
|
+
</g>
|
|
95
|
+
</g>
|
|
96
|
+
</g>
|
|
97
|
+
</svg>
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
|
3
|
+
|
|
4
|
+
<svg
|
|
5
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
6
|
+
xmlns:cc="http://creativecommons.org/ns#"
|
|
7
|
+
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
|
8
|
+
xmlns:svg="http://www.w3.org/2000/svg"
|
|
9
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
10
|
+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
11
|
+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
12
|
+
width="89.624855mm"
|
|
13
|
+
height="89.96759mm"
|
|
14
|
+
viewBox="0 0 89.62486 89.96759"
|
|
15
|
+
version="1.1"
|
|
16
|
+
id="svg1040"
|
|
17
|
+
inkscape:version="0.92.4 (f8dce91, 2019-08-02)"
|
|
18
|
+
sodipodi:docname="index_contribute.svg">
|
|
19
|
+
<defs
|
|
20
|
+
id="defs1034" />
|
|
21
|
+
<sodipodi:namedview
|
|
22
|
+
id="base"
|
|
23
|
+
pagecolor="#ffffff"
|
|
24
|
+
bordercolor="#666666"
|
|
25
|
+
borderopacity="1.0"
|
|
26
|
+
inkscape:pageopacity="0.0"
|
|
27
|
+
inkscape:pageshadow="2"
|
|
28
|
+
inkscape:zoom="0.35"
|
|
29
|
+
inkscape:cx="683.11893"
|
|
30
|
+
inkscape:cy="-59.078181"
|
|
31
|
+
inkscape:document-units="mm"
|
|
32
|
+
inkscape:current-layer="layer1"
|
|
33
|
+
showgrid="false"
|
|
34
|
+
fit-margin-top="0"
|
|
35
|
+
fit-margin-left="0"
|
|
36
|
+
fit-margin-right="0"
|
|
37
|
+
fit-margin-bottom="0"
|
|
38
|
+
inkscape:window-width="930"
|
|
39
|
+
inkscape:window-height="472"
|
|
40
|
+
inkscape:window-x="2349"
|
|
41
|
+
inkscape:window-y="267"
|
|
42
|
+
inkscape:window-maximized="0" />
|
|
43
|
+
<metadata
|
|
44
|
+
id="metadata1037">
|
|
45
|
+
<rdf:RDF>
|
|
46
|
+
<cc:Work
|
|
47
|
+
rdf:about="">
|
|
48
|
+
<dc:format>image/svg+xml</dc:format>
|
|
49
|
+
<dc:type
|
|
50
|
+
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
|
51
|
+
<dc:title></dc:title>
|
|
52
|
+
</cc:Work>
|
|
53
|
+
</rdf:RDF>
|
|
54
|
+
</metadata>
|
|
55
|
+
<g
|
|
56
|
+
inkscape:label="Layer 1"
|
|
57
|
+
inkscape:groupmode="layer"
|
|
58
|
+
id="layer1"
|
|
59
|
+
transform="translate(234.72009,17.466935)">
|
|
60
|
+
<g
|
|
61
|
+
id="g875"
|
|
62
|
+
transform="matrix(0.99300176,0,0,0.99300176,-133.24106,-172.58804)">
|
|
63
|
+
<path
|
|
64
|
+
sodipodi:nodetypes="ccc"
|
|
65
|
+
inkscape:connector-curvature="0"
|
|
66
|
+
id="path869"
|
|
67
|
+
d="m -97.139881,161.26069 47.247024,40.25446 -47.247024,40.25446"
|
|
68
|
+
style="fill:none;stroke:#5a5a5a;stroke-width:10;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
|
69
|
+
<path
|
|
70
|
+
inkscape:connector-curvature="0"
|
|
71
|
+
id="path871"
|
|
72
|
+
d="m -49.514879,241.81547 h 32.505951"
|
|
73
|
+
style="fill:none;stroke:#5a5a5a;stroke-width:10;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
|
74
|
+
</g>
|
|
75
|
+
</g>
|
|
76
|
+
</svg>
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
|
3
|
+
|
|
4
|
+
<svg
|
|
5
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
6
|
+
xmlns:cc="http://creativecommons.org/ns#"
|
|
7
|
+
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
|
8
|
+
xmlns:svg="http://www.w3.org/2000/svg"
|
|
9
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
10
|
+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
11
|
+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
12
|
+
width="101.09389mm"
|
|
13
|
+
height="89.96759mm"
|
|
14
|
+
viewBox="0 0 101.09389 89.96759"
|
|
15
|
+
version="1.1"
|
|
16
|
+
id="svg1040"
|
|
17
|
+
inkscape:version="0.92.4 (f8dce91, 2019-08-02)"
|
|
18
|
+
sodipodi:docname="index_getting_started.svg">
|
|
19
|
+
<defs
|
|
20
|
+
id="defs1034" />
|
|
21
|
+
<sodipodi:namedview
|
|
22
|
+
id="base"
|
|
23
|
+
pagecolor="#ffffff"
|
|
24
|
+
bordercolor="#666666"
|
|
25
|
+
borderopacity="1.0"
|
|
26
|
+
inkscape:pageopacity="0.0"
|
|
27
|
+
inkscape:pageshadow="2"
|
|
28
|
+
inkscape:zoom="0.35"
|
|
29
|
+
inkscape:cx="-93.242129"
|
|
30
|
+
inkscape:cy="-189.9825"
|
|
31
|
+
inkscape:document-units="mm"
|
|
32
|
+
inkscape:current-layer="layer1"
|
|
33
|
+
showgrid="false"
|
|
34
|
+
fit-margin-top="0"
|
|
35
|
+
fit-margin-left="0"
|
|
36
|
+
fit-margin-right="0"
|
|
37
|
+
fit-margin-bottom="0"
|
|
38
|
+
inkscape:window-width="1875"
|
|
39
|
+
inkscape:window-height="1056"
|
|
40
|
+
inkscape:window-x="1965"
|
|
41
|
+
inkscape:window-y="0"
|
|
42
|
+
inkscape:window-maximized="1" />
|
|
43
|
+
<metadata
|
|
44
|
+
id="metadata1037">
|
|
45
|
+
<rdf:RDF>
|
|
46
|
+
<cc:Work
|
|
47
|
+
rdf:about="">
|
|
48
|
+
<dc:format>image/svg+xml</dc:format>
|
|
49
|
+
<dc:type
|
|
50
|
+
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
|
51
|
+
<dc:title></dc:title>
|
|
52
|
+
</cc:Work>
|
|
53
|
+
</rdf:RDF>
|
|
54
|
+
</metadata>
|
|
55
|
+
<g
|
|
56
|
+
inkscape:label="Layer 1"
|
|
57
|
+
inkscape:groupmode="layer"
|
|
58
|
+
id="layer1"
|
|
59
|
+
transform="translate(2.9219487,-8.5995374)">
|
|
60
|
+
<path
|
|
61
|
+
style="fill:#5a5a5a;fill-opacity:1;stroke-width:0.20233451"
|
|
62
|
+
d="M 37.270955,98.335591 C 33.358064,97.07991 31.237736,92.52319 32.964256,89.08022 c 0.18139,-0.361738 4.757999,-5.096629 10.17021,-10.521968 l 9.84041,-9.864254 -4.03738,-4.041175 -4.037391,-4.041172 -4.96415,4.916665 c -3.61569,3.581096 -5.238959,5.04997 -5.975818,5.407377 l -1.011682,0.490718 H 17.267525 1.5866055 L 0.65034544,70.96512 C -2.2506745,69.535833 -3.5952145,66.18561 -2.5925745,62.884631 c 0.53525,-1.762217 1.61699004,-3.050074 3.22528014,-3.839847 l 1.15623996,-0.56778 13.2591094,-0.05613 13.259111,-0.05613 11.5262,-11.527539 11.526199,-11.527528 H 40.622647 c -12.145542,0 -12.189222,-0.0046 -13.752801,-1.445851 -2.229871,-2.055423 -2.162799,-5.970551 0.135998,-7.938238 1.475193,-1.262712 1.111351,-1.238469 18.588522,-1.238469 12.899229,0 16.035311,0.05193 16.692589,0.276494 0.641832,0.219264 2.590731,2.051402 9.416301,8.852134 l 8.606941,8.575638 h 6.848168 c 4.837422,0 7.092281,0.07311 7.679571,0.249094 0.48064,0.144008 1.22985,0.634863 1.77578,1.163429 2.383085,2.307333 1.968685,6.539886 -0.804989,8.221882 -0.571871,0.346781 -1.38284,0.687226 -1.80217,0.756523 -0.41933,0.06928 -4.2741,0.127016 -8.56615,0.128238 -6.56998,0.0016 -7.977492,-0.04901 -8.902732,-0.321921 -0.975569,-0.287742 -1.400468,-0.622236 -3.783999,-2.978832 l -2.685021,-2.654679 -5.05411,5.051071 -5.0541,5.051081 3.926292,3.947202 c 2.365399,2.378001 4.114289,4.309171 4.399158,4.857713 0.39266,0.75606 0.47311,1.219412 0.474321,2.731516 0.003,3.083647 0.620779,2.331942 -13.598011,16.531349 -10.273768,10.259761 -12.679778,12.563171 -13.500979,12.92519 -1.267042,0.55857 -3.156169,0.681342 -4.390271,0.285321 z m 40.130741,-65.45839 c -2.212909,-0.579748 -3.782711,-1.498393 -5.51275,-3.226063 -2.522111,-2.518633 -3.633121,-5.181304 -3.633121,-8.707194 0,-3.530699 1.11238,-6.197124 3.631161,-8.704043 4.866751,-4.8438383 12.324781,-4.8550953 17.211791,-0.026 3.908758,3.862461 4.818578,9.377999 2.372188,14.380771 -0.846209,1.730481 -3.39493,4.326384 -5.143839,5.239072 -2.69708,1.407492 -6.042829,1.798628 -8.92543,1.043434 z"
|
|
63
|
+
id="path1000"
|
|
64
|
+
inkscape:connector-curvature="0" />
|
|
65
|
+
</g>
|
|
66
|
+
</svg>
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
|
3
|
+
|
|
4
|
+
<svg
|
|
5
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
6
|
+
xmlns:cc="http://creativecommons.org/ns#"
|
|
7
|
+
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
|
8
|
+
xmlns:svg="http://www.w3.org/2000/svg"
|
|
9
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
10
|
+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
11
|
+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
12
|
+
width="123.72241mm"
|
|
13
|
+
height="89.96759mm"
|
|
14
|
+
viewBox="0 0 123.72242 89.96759"
|
|
15
|
+
version="1.1"
|
|
16
|
+
id="svg1040"
|
|
17
|
+
inkscape:version="0.92.4 (f8dce91, 2019-08-02)"
|
|
18
|
+
sodipodi:docname="index_userguide.svg">
|
|
19
|
+
<defs
|
|
20
|
+
id="defs1034" />
|
|
21
|
+
<sodipodi:namedview
|
|
22
|
+
id="base"
|
|
23
|
+
pagecolor="#ffffff"
|
|
24
|
+
bordercolor="#666666"
|
|
25
|
+
borderopacity="1.0"
|
|
26
|
+
inkscape:pageopacity="0.0"
|
|
27
|
+
inkscape:pageshadow="2"
|
|
28
|
+
inkscape:zoom="0.35"
|
|
29
|
+
inkscape:cx="332.26618"
|
|
30
|
+
inkscape:cy="83.744004"
|
|
31
|
+
inkscape:document-units="mm"
|
|
32
|
+
inkscape:current-layer="layer1"
|
|
33
|
+
showgrid="false"
|
|
34
|
+
fit-margin-top="0"
|
|
35
|
+
fit-margin-left="0"
|
|
36
|
+
fit-margin-right="0"
|
|
37
|
+
fit-margin-bottom="0"
|
|
38
|
+
inkscape:window-width="930"
|
|
39
|
+
inkscape:window-height="472"
|
|
40
|
+
inkscape:window-x="2349"
|
|
41
|
+
inkscape:window-y="267"
|
|
42
|
+
inkscape:window-maximized="0" />
|
|
43
|
+
<metadata
|
|
44
|
+
id="metadata1037">
|
|
45
|
+
<rdf:RDF>
|
|
46
|
+
<cc:Work
|
|
47
|
+
rdf:about="">
|
|
48
|
+
<dc:format>image/svg+xml</dc:format>
|
|
49
|
+
<dc:type
|
|
50
|
+
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
|
51
|
+
<dc:title></dc:title>
|
|
52
|
+
</cc:Work>
|
|
53
|
+
</rdf:RDF>
|
|
54
|
+
</metadata>
|
|
55
|
+
<g
|
|
56
|
+
inkscape:label="Layer 1"
|
|
57
|
+
inkscape:groupmode="layer"
|
|
58
|
+
id="layer1"
|
|
59
|
+
transform="translate(141.8903,-20.32143)">
|
|
60
|
+
<path
|
|
61
|
+
style="fill:#5a5a5a;fill-opacity:1;stroke-width:0.20483544"
|
|
62
|
+
d="m -139.53374,110.1657 c -0.80428,-0.24884 -1.71513,-1.11296 -2.07107,-1.96486 -0.23905,-0.57214 -0.28453,-6.28104 -0.28453,-35.720988 0,-38.274546 -0.079,-35.840728 1.19849,-36.91568 0.58869,-0.495345 4.63766,-2.187548 8.47998,-3.544073 l 1.58749,-0.560453 v -3.309822 c 0,-3.025538 0.0396,-3.388179 0.46086,-4.222122 0.68808,-1.362003 1.38671,-1.714455 4.60319,-2.322195 4.12797,-0.779966 5.13304,-0.912766 8.81544,-1.16476 11.80964,-0.808168 22.80911,2.509277 30.965439,9.3392 1.750401,1.465747 3.840861,3.5635 5.0903,5.108065 l 0.659122,0.814805 0.659109,-0.814805 c 1.249431,-1.544565 3.33988,-3.642318 5.09029,-5.108065 8.156331,-6.829923 19.155791,-10.147368 30.965441,-9.3392 3.682389,0.251994 4.68748,0.384794 8.81544,1.16476 3.21647,0.60774 3.91511,0.960192 4.60318,2.322195 0.4213,0.833943 0.46087,1.196584 0.46087,4.222122 v 3.309822 l 1.58748,0.560453 c 4.10165,1.448077 7.98852,3.072753 8.5259,3.563743 1.22643,1.120567 1.15258,-1.245868 1.15258,36.927177 0,34.567591 -0.005,35.083151 -0.40663,35.903991 -0.22365,0.45804 -0.73729,1.05665 -1.14143,1.33024 -1.22281,0.82783 -2.17721,0.70485 -5.86813,-0.7561 -9.19595,-3.63998 -18.956011,-6.38443 -26.791332,-7.53353 -3.02827,-0.44412 -9.26189,-0.61543 -11.77821,-0.3237 -5.19357,0.60212 -8.736108,2.05527 -11.700039,4.79936 -0.684501,0.63371 -1.466141,1.23646 -1.736979,1.33942 -0.63859,0.2428 -4.236521,0.2428 -4.875112,0 -0.27083,-0.10296 -1.05247,-0.70571 -1.73696,-1.33942 -2.96395,-2.74409 -6.50648,-4.19724 -11.700058,-4.79936 -2.516312,-0.29173 -8.749941,-0.12042 -11.778201,0.3237 -7.78194,1.14127 -17.39965,3.83907 -26.73341,7.49883 -3.38325,1.32658 -4.15525,1.50926 -5.11851,1.21125 z m 4.2107,-5.34052 c 5.86759,-2.29858 14.40398,-4.922695 20.2018,-6.210065 6.31584,-1.402418 8.5236,-1.646248 14.91592,-1.647338 4.68699,-7.94e-4 6.013661,0.0632 7.257809,0.3497 0.837332,0.19286 1.561052,0.312028 1.60828,0.264819 0.147111,-0.147119 -1.803289,-1.307431 -4.154879,-2.471801 -8.12511,-4.023029 -18.27311,-4.986568 -29.0861,-2.761718 -1.09536,0.22538 -2.32708,0.40827 -2.73715,0.406418 -1.12787,-0.005 -2.3054,-0.76382 -2.84516,-1.8332 l -0.46086,-0.913098 V 62.99179 35.97471 l -0.56331,0.138329 c -0.30981,0.07608 -1.89985,0.665075 -3.5334,1.308881 -2.27551,0.896801 -2.96414,1.252878 -2.94452,1.522563 0.014,0.193604 0.0372,15.284513 0.0512,33.535345 0.014,18.250839 0.0538,33.183322 0.0884,33.183322 0.0346,0 1.02543,-0.3771 2.20198,-0.83801 z m 113.006991,-32.697216 -0.0518,-33.535203 -3.17495,-1.272156 c -1.74623,-0.699685 -3.33627,-1.278755 -3.53341,-1.286819 -0.33966,-0.01389 -0.35847,1.401778 -0.35847,26.980216 v 26.994863 l -0.46087,0.913112 c -0.53976,1.06939 -1.71729,1.828088 -2.84515,1.833189 -0.41008,0.0021 -1.6418,-0.181031 -2.73716,-0.406421 -11.888201,-2.446089 -22.84337,-1.046438 -31.491022,4.02332 -1.68175,0.985941 -2.216748,1.467501 -1.36534,1.228942 1.575181,-0.441362 4.990592,-0.73864 8.524862,-0.742011 5.954408,-0.005 11.43046,0.791951 19.10874,2.78333 3.9516,1.024874 12.1555,3.687454 15.6699,5.085704 1.23926,0.49306 2.36869,0.90517 2.50985,0.9158 0.20489,0.0155 0.2462,-6.745894 0.20483,-33.515866 z m -59.76135,-2.233777 V 40.065438 l -0.95972,-1.357442 c -1.380522,-1.952627 -5.376262,-5.847994 -7.64336,-7.45136 -3.778692,-2.672401 -9.063392,-4.943324 -13.672511,-5.875304 -3.19731,-0.646503 -5.23069,-0.833103 -9.05886,-0.831312 -4.37716,0.0021 -7.70223,0.349169 -11.83461,1.235469 l -1.07538,0.230645 v 31.242342 c 0,26.565778 0.0426,31.226011 0.28429,31.133261 0.15637,-0.06 1.42379,-0.297169 2.81648,-0.527026 12.37657,-2.042634 23.21658,-0.346861 32.521639,5.087596 2.10018,1.226558 5.20202,3.618878 6.880942,5.30692 0.788609,0.792909 1.502978,1.446609 1.587468,1.452679 0.0845,0.006 0.153622,-13.411893 0.153622,-29.817719 z m 5.80221,28.3766 c 6.21476,-6.141601 15.08488,-10.061509 25.025529,-11.05933 4.262419,-0.427849 11.579921,-0.0054 16.017661,0.924912 0.75932,0.15916 1.45259,0.244888 1.54058,0.190498 0.088,-0.05434 0.16003,-14.060382 0.16003,-31.124436 V 26.176883 l -0.52136,-0.198219 c -0.66893,-0.254325 -4.77649,-0.95482 -7.159981,-1.221048 -2.41372,-0.269605 -8.559851,-0.266589 -10.759229,0.0052 -6.458111,0.798299 -12.584091,3.083792 -17.405651,6.49374 -2.267091,1.603366 -6.262831,5.498733 -7.64336,7.45136 l -0.959721,1.357438 v 29.828747 c 0,16.405812 0.0532,29.828746 0.11802,29.828746 0.065,0 0.77928,-0.65347 1.587482,-1.452149 z"
|
|
63
|
+
id="path845"
|
|
64
|
+
inkscape:connector-curvature="0"
|
|
65
|
+
sodipodi:nodetypes="csscccscsssscsssssscscsccsccsccscsscccccccscccccccccsccscscscccscccsccssccsscccscccccsccccsccscsccsscc" />
|
|
66
|
+
</g>
|
|
67
|
+
</svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 20 20" height="48px" viewBox="0 0 20 20" width="48px" fill="#000000"><g><rect fill="none" height="20" width="20" x="0"/></g><g><g><path d="M14.45,10.86l0.26,2.1c0.06,0.46-0.1,0.92-0.43,1.25l-3.55,3.55l-1.41-4.24l-2.83-2.83L2.25,9.27l3.55-3.55 c0.33-0.33,0.79-0.49,1.25-0.43l2.1,0.26C13.92,0.78,17.8,2.2,17.8,2.2C17.8,2.2,19.22,6.08,14.45,10.86z M10.2,6.62 C9.18,7.64,8.37,9.06,7.9,9.97l2.12,2.12c0.91-0.46,2.34-1.27,3.36-2.3C16.18,7,16.54,4.67,16.5,3.5C15.33,3.46,13,3.82,10.2,6.62 z M14,7.5C14,6.68,13.32,6,12.5,6C11.67,6,11,6.68,11,7.5S11.67,9,12.5,9C13.32,9,14,8.33,14,7.5z M7.99,6.92L6.86,6.78L5.02,8.61 l1.62,0.54C6.97,8.52,7.43,7.71,7.99,6.92z M10.85,13.36l0.54,1.62l1.83-1.83l-0.14-1.14C12.29,12.57,11.48,13.03,10.85,13.36z M5.25,12.5c-0.62,0-1.18,0.25-1.59,0.66C2.44,14.38,2,18,2,18s3.62-0.44,4.84-1.66c0.41-0.41,0.66-0.97,0.66-1.59 C7.5,13.51,6.49,12.5,5.25,12.5z M5.78,15.28c-0.44,0.44-1.87,0.81-1.87,0.81s0.37-1.43,0.81-1.87c0.29-0.29,0.77-0.29,1.06,0 S6.07,14.99,5.78,15.28z"/></g></g></svg>
|
docs/conf.py
CHANGED
|
@@ -64,6 +64,7 @@ add_module_names = False # Remove namespaces from class/method signatures
|
|
|
64
64
|
autodoc_inherit_docstrings = True # If no docstring, inherit from base class
|
|
65
65
|
set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints
|
|
66
66
|
autoclass_content = "both" # Include both class docstring and __init__
|
|
67
|
+
autodoc_mock_imports = ["pyqtgraph"]
|
|
67
68
|
|
|
68
69
|
# Add any paths that contain templates here, relative to this directory.
|
|
69
70
|
templates_path = ["_templates"]
|
|
@@ -76,6 +77,5 @@ language = "Python"
|
|
|
76
77
|
|
|
77
78
|
html_theme = "pydata_sphinx_theme"
|
|
78
79
|
html_static_path = ["_static"]
|
|
79
|
-
html_css_files = ["
|
|
80
|
-
html_logo = "
|
|
81
|
-
html_theme_options = {"show_nav_level": 1, "navbar_align": "content"}
|
|
80
|
+
html_css_files = ["custom.css"]
|
|
81
|
+
html_logo = "../bec_widgets/assets/bec_widgets_icon.png"
|
docs/developer/developer.md
CHANGED
docs/index.md
CHANGED
|
@@ -1,39 +1,70 @@
|
|
|
1
1
|
# BEC Widgets documentation
|
|
2
2
|
|
|
3
|
+
A flexible and extensible framework for building graphical user interfaces in Python, optimized for use in the BEC environment.
|
|
4
|
+
|
|
5
|
+
<br><br>
|
|
6
|
+
|
|
3
7
|
<br><br>
|
|
4
8
|
|
|
5
|
-
````{grid}
|
|
9
|
+
````{grid} 2
|
|
6
10
|
:gutter: 5
|
|
7
11
|
|
|
8
|
-
```{grid-item-card}
|
|
12
|
+
```{grid-item-card}
|
|
9
13
|
:link: introduction
|
|
10
14
|
:link-type: ref
|
|
15
|
+
:img-top: /assets/index_getting_started.svg
|
|
16
|
+
:text-align: center
|
|
17
|
+
|
|
18
|
+
## Introduction
|
|
11
19
|
|
|
12
|
-
General information.
|
|
20
|
+
General information about BEC Widgets.
|
|
13
21
|
```
|
|
14
22
|
|
|
15
|
-
```{grid-item-card}
|
|
23
|
+
```{grid-item-card}
|
|
16
24
|
:link: user
|
|
17
25
|
:link-type: ref
|
|
26
|
+
:img-top: /assets/index_user_guide.svg
|
|
27
|
+
:text-align: center
|
|
18
28
|
|
|
19
|
-
|
|
29
|
+
## User guide
|
|
30
|
+
|
|
31
|
+
Information for users of BEC Widgets.
|
|
20
32
|
```
|
|
21
33
|
|
|
22
|
-
```{grid-item-card}
|
|
34
|
+
```{grid-item-card}
|
|
23
35
|
:link: developer
|
|
24
36
|
:link-type: ref
|
|
37
|
+
:img-top: /assets/index_contribute.svg
|
|
38
|
+
:text-align: center
|
|
39
|
+
|
|
40
|
+
## Developer guide
|
|
25
41
|
|
|
26
|
-
Information for developers.
|
|
42
|
+
Information for developers of BEC Widgets.
|
|
27
43
|
```
|
|
44
|
+
|
|
45
|
+
```{grid-item-card}
|
|
46
|
+
:link: api_reference
|
|
47
|
+
:link-type: ref
|
|
48
|
+
:img-top: /assets/index_api.svg
|
|
49
|
+
:text-align: center
|
|
50
|
+
|
|
51
|
+
## API reference
|
|
52
|
+
|
|
53
|
+
Comprehensive reference of all BEC Widget classes, functions, and methods.
|
|
54
|
+
```
|
|
55
|
+
|
|
28
56
|
````
|
|
29
57
|
|
|
30
58
|
|
|
31
59
|
```{toctree}
|
|
32
60
|
---
|
|
33
61
|
numbered: true
|
|
34
|
-
maxdepth:
|
|
62
|
+
maxdepth: 2
|
|
63
|
+
hidden: true
|
|
35
64
|
---
|
|
36
65
|
|
|
37
66
|
introduction/introduction
|
|
38
67
|
user/user
|
|
39
68
|
developer/developer
|
|
69
|
+
api_reference/api_reference
|
|
70
|
+
```
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
(user.getting_started)=
|
|
2
|
+
# Getting Started
|
|
3
|
+
This section provides a comprehensive guide to getting started with BEC Widgets. Whether you are new to BEC Widgets or looking to refresh your knowledge, this guide will help you set up and navigate the framework with ease.
|
|
4
|
+
|
|
5
|
+
```{toctree}
|
|
6
|
+
---
|
|
7
|
+
maxdepth: 2
|
|
8
|
+
hidden: true
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
getting_started/installation
|
|
12
|
+
```
|
|
@@ -14,7 +14,7 @@ Before installing BEC Widgets, please ensure the following requirements are met:
|
|
|
14
14
|
Install BEC Widgets using the pip package manager. Open your terminal and execute:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
pip install bec_widgets
|
|
17
|
+
pip install bec_widgets PyQt6
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
This command installs BEC Widgets along with its dependencies, including the default PyQt6.
|
docs/user/user.md
CHANGED
|
@@ -1,38 +1,67 @@
|
|
|
1
1
|
(user)=
|
|
2
2
|
# User
|
|
3
|
+
Welcome to the User section of the BEC Widgets documentation! BEC Widgets is a versatile GUI framework tailored for beamline scientists, enabling efficient and intuitive interaction with beamline experiments. This section is designed to guide both new and experienced users through the essential aspects of utilizing BEC Widgets.
|
|
3
4
|
|
|
4
|
-
|
|
5
|
+
```{toctree}
|
|
6
|
+
---
|
|
7
|
+
maxdepth: 2
|
|
8
|
+
hidden: true
|
|
9
|
+
---
|
|
5
10
|
|
|
6
|
-
|
|
11
|
+
getting_started/getting_started.md
|
|
12
|
+
applications/applications.md
|
|
13
|
+
widgets/widgets.md
|
|
14
|
+
api_reference/api_reference.md
|
|
15
|
+
```
|
|
7
16
|
|
|
8
|
-
**Key Topics**
|
|
9
17
|
|
|
10
|
-
|
|
18
|
+
***
|
|
11
19
|
|
|
12
|
-
|
|
20
|
+
````{grid} 2
|
|
21
|
+
:gutter: 5
|
|
13
22
|
|
|
14
|
-
-
|
|
23
|
+
```{grid-item-card}
|
|
24
|
+
:link: user.getting_started
|
|
25
|
+
:link-type: ref
|
|
26
|
+
:img-top: /assets/rocket_launch_48dp.svg
|
|
27
|
+
:text-align: center
|
|
15
28
|
|
|
16
|
-
|
|
29
|
+
## Getting Started
|
|
17
30
|
|
|
18
|
-
|
|
31
|
+
Learn how to install BEC Widgets and get started with the framework.
|
|
32
|
+
```
|
|
19
33
|
|
|
20
|
-
|
|
34
|
+
```{grid-item-card}
|
|
35
|
+
:link: user.applications
|
|
36
|
+
:link-type: ref
|
|
37
|
+
:img-top: /assets/display_settings_48dp.svg
|
|
38
|
+
:text-align: center
|
|
21
39
|
|
|
22
|
-
|
|
23
|
-
- **Feature Requests:** Have an idea for a new feature or an enhancement? Share it with us on the [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened) of our repository. We have a feature request template that you can use to describe your proposal.
|
|
40
|
+
## Applications
|
|
24
41
|
|
|
25
|
-
|
|
42
|
+
Learn how to use BEC Widgets Applications, to modify and create new applications.
|
|
26
43
|
|
|
27
|
-
|
|
44
|
+
```
|
|
28
45
|
|
|
29
|
-
```{
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
46
|
+
```{grid-item-card}
|
|
47
|
+
:link: user.widgets
|
|
48
|
+
:link-type: ref
|
|
49
|
+
:img-top: /assets/apps_48dp.svg
|
|
50
|
+
:text-align: center
|
|
51
|
+
|
|
52
|
+
## Widgets
|
|
53
|
+
|
|
54
|
+
Learn about the building blocks of larger applications: widgets.
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
```{grid-item-card}
|
|
58
|
+
:link: user.api_reference
|
|
59
|
+
:link-type: ref
|
|
60
|
+
:img-top: /assets/index_api.svg
|
|
61
|
+
:text-align: center
|
|
62
|
+
|
|
63
|
+
## API reference
|
|
34
64
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
customisation
|
|
65
|
+
Comprehensive reference of all user-facing classes, functions, and methods.
|
|
66
|
+
```
|
|
67
|
+
````
|
|
@@ -15,7 +15,7 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
|
|
|
15
15
|
- Customizable visual elements such as line color and style.
|
|
16
16
|
|
|
17
17
|
**Example of Use:**
|
|
18
|
-
|
|
19
19
|
### 2D Scatter Plot
|
|
20
20
|
|
|
21
21
|
**Purpose:** The 2D scatter plot widget is designed for more complex data visualization. It employs a false color map to represent a third dimension (z-axis), making it an ideal tool for visualizing multidimensional data sets.
|
|
@@ -27,7 +27,7 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
|
|
|
27
27
|
- Tools for selecting and inspecting specific data points.
|
|
28
28
|
|
|
29
29
|
**Example of Use:**
|
|
30
|
-
|
|
31
31
|
### Motor Position Map
|
|
32
32
|
|
|
33
33
|
**Purpose:** A specialized component derived from the Motor Alignment Tool. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans.
|
|
@@ -38,4 +38,4 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
|
|
|
38
38
|
- Ability to record and recall specific motor positions for repetitive tasks.
|
|
39
39
|
|
|
40
40
|
**Example of Use:**
|
|
41
|
-
|
pyproject.toml
CHANGED
|
@@ -163,7 +163,7 @@ def test_spiral_bar(rpc_server_dock):
|
|
|
163
163
|
|
|
164
164
|
expected_colors = Colors.golden_angle_color("viridis", 5, "RGB")
|
|
165
165
|
bar_colors = [ring.color.getRgb() for ring in bar_server.rings]
|
|
166
|
-
bar_values = [ring.value for ring in bar_server.rings]
|
|
166
|
+
bar_values = [ring.config.value for ring in bar_server.rings]
|
|
167
167
|
assert bar_values == [10, 20, 30, 40, 50]
|
|
168
168
|
assert bar_colors == expected_colors
|
|
169
169
|
|
|
@@ -188,7 +188,7 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
|
|
|
188
188
|
qtbot.wait(200)
|
|
189
189
|
bar_server = dock_server.docks["dock_0"].widgets[0]
|
|
190
190
|
assert bar_server.config.num_bars == 1
|
|
191
|
-
np.testing.assert_allclose(bar_server.rings[0].value, 10, atol=0.1)
|
|
191
|
+
np.testing.assert_allclose(bar_server.rings[0].config.value, 10, atol=0.1)
|
|
192
192
|
np.testing.assert_allclose(bar_server.rings[0].config.min_value, 0, atol=0.1)
|
|
193
193
|
np.testing.assert_allclose(bar_server.rings[0].config.max_value, 10, atol=0.1)
|
|
194
194
|
|
|
@@ -199,7 +199,7 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
|
|
|
199
199
|
|
|
200
200
|
qtbot.wait(200)
|
|
201
201
|
assert bar_server.config.num_bars == 1
|
|
202
|
-
np.testing.assert_allclose(bar_server.rings[0].value, 16, atol=0.1)
|
|
202
|
+
np.testing.assert_allclose(bar_server.rings[0].config.value, 16, atol=0.1)
|
|
203
203
|
np.testing.assert_allclose(bar_server.rings[0].config.min_value, 0, atol=0.1)
|
|
204
204
|
np.testing.assert_allclose(bar_server.rings[0].config.max_value, 16, atol=0.1)
|
|
205
205
|
|
|
@@ -218,8 +218,8 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
|
|
|
218
218
|
|
|
219
219
|
qtbot.wait(200)
|
|
220
220
|
assert bar_server.config.num_bars == 2
|
|
221
|
-
np.testing.assert_allclose(bar_server.rings[0].value, final_samx, atol=0.1)
|
|
222
|
-
np.testing.assert_allclose(bar_server.rings[1].value, final_samy, atol=0.1)
|
|
221
|
+
np.testing.assert_allclose(bar_server.rings[0].config.value, final_samx, atol=0.1)
|
|
222
|
+
np.testing.assert_allclose(bar_server.rings[1].config.value, final_samy, atol=0.1)
|
|
223
223
|
np.testing.assert_allclose(bar_server.rings[0].config.min_value, init_samx, atol=0.1)
|
|
224
224
|
np.testing.assert_allclose(bar_server.rings[1].config.min_value, init_samy, atol=0.1)
|
|
225
225
|
np.testing.assert_allclose(bar_server.rings[0].config.max_value, final_samx, atol=0.1)
|