plesty-pol-pl 0.2.0.dev1__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.
Files changed (45) hide show
  1. plesty_pol_pl-0.2.0.dev1/.env.example +35 -0
  2. plesty_pol_pl-0.2.0.dev1/.gitignore +71 -0
  3. plesty_pol_pl-0.2.0.dev1/.gitlab-ci.yml +16 -0
  4. plesty_pol_pl-0.2.0.dev1/.mailmap +1 -0
  5. plesty_pol_pl-0.2.0.dev1/CHANGELOG.md +139 -0
  6. plesty_pol_pl-0.2.0.dev1/LICENSE +184 -0
  7. plesty_pol_pl-0.2.0.dev1/LICENSES/LGPL-3.0-or-later.txt +165 -0
  8. plesty_pol_pl-0.2.0.dev1/PKG-INFO +123 -0
  9. plesty_pol_pl-0.2.0.dev1/README.md +107 -0
  10. plesty_pol_pl-0.2.0.dev1/REUSE.toml +11 -0
  11. plesty_pol_pl-0.2.0.dev1/config/default.yaml +36 -0
  12. plesty_pol_pl-0.2.0.dev1/config/demo.yaml +51 -0
  13. plesty_pol_pl-0.2.0.dev1/docs/analysis.md +130 -0
  14. plesty_pol_pl-0.2.0.dev1/docs/index.md +36 -0
  15. plesty_pol_pl-0.2.0.dev1/docs/media/fine_structure.svg +609 -0
  16. plesty_pol_pl-0.2.0.dev1/docs/media/fine_structure_resolved.svg +420 -0
  17. plesty_pol_pl-0.2.0.dev1/docs/media/flow.svg +98 -0
  18. plesty_pol_pl-0.2.0.dev1/docs/media/line_fit.svg +1031 -0
  19. plesty_pol_pl-0.2.0.dev1/docs/media/map.svg +212 -0
  20. plesty_pol_pl-0.2.0.dev1/docs/media/map_resolved.svg +212 -0
  21. plesty_pol_pl-0.2.0.dev1/docs/media/polarization.svg +425 -0
  22. plesty_pol_pl-0.2.0.dev1/docs/media/rig.svg +97 -0
  23. plesty_pol_pl-0.2.0.dev1/docs/media/viewer.png +0 -0
  24. plesty_pol_pl-0.2.0.dev1/docs/running.md +137 -0
  25. plesty_pol_pl-0.2.0.dev1/docs/setup.md +58 -0
  26. plesty_pol_pl-0.2.0.dev1/docs/toc.yaml +7 -0
  27. plesty_pol_pl-0.2.0.dev1/gl-secret-detection-report.json +50 -0
  28. plesty_pol_pl-0.2.0.dev1/plesty/pol_pl/__init__.py +27 -0
  29. plesty_pol_pl-0.2.0.dev1/plesty/pol_pl/__main__.py +295 -0
  30. plesty_pol_pl-0.2.0.dev1/plesty/pol_pl/config.yaml +67 -0
  31. plesty_pol_pl-0.2.0.dev1/plesty/pol_pl/experiment.py +542 -0
  32. plesty_pol_pl-0.2.0.dev1/plesty/pol_pl/rig.py +260 -0
  33. plesty_pol_pl-0.2.0.dev1/plesty/pol_pl/viz.py +157 -0
  34. plesty_pol_pl-0.2.0.dev1/pyproject.toml +88 -0
  35. plesty_pol_pl-0.2.0.dev1/reports/check.json +176 -0
  36. plesty_pol_pl-0.2.0.dev1/scripts/docs_figures.mplstyle +27 -0
  37. plesty_pol_pl-0.2.0.dev1/scripts/docs_figures.py +272 -0
  38. plesty_pol_pl-0.2.0.dev1/setup.yaml +34 -0
  39. plesty_pol_pl-0.2.0.dev1/tests/__init__.py +4 -0
  40. plesty_pol_pl-0.2.0.dev1/tests/stub_rig.py +189 -0
  41. plesty_pol_pl-0.2.0.dev1/tests/test_pol_pl.py +405 -0
  42. plesty_pol_pl-0.2.0.dev1/tests/test_rig.py +104 -0
  43. plesty_pol_pl-0.2.0.dev1/tests/test_setup.py +31 -0
  44. plesty_pol_pl-0.2.0.dev1/tests/test_viz.py +173 -0
  45. plesty_pol_pl-0.2.0.dev1/uv.lock +2431 -0
@@ -0,0 +1,35 @@
1
+ # The values setup.yaml names, and overrides for a run. A bench writes `.env`
2
+ # from these when it installs the module; by hand, copy this file to `.env`.
3
+ # Loaded by plesty.lib.utils.EnvSettings; the process environment overrides `.env`.
4
+ # Measurement tuning does NOT belong here — it lives in config/*.yaml.
5
+ #
6
+ # setup.yaml names the benches and each device's bench (`host_name`). It is
7
+ # committed, so where each bench is, its token and where it sees the shared
8
+ # data disk are set here, in the variables it names. The bench running the
9
+ # experiment serves each device on its bench, which may write anywhere under
10
+ # that bench's view of the disk, and gives the run HWP_ADDRESS and
11
+ # SPEC_ADDRESS; the run is given PLESTY_DATA, this machine's view of the disk,
12
+ # and its runs go to <PLESTY_DATA>/pol-pl.
13
+
14
+ # Where the machine the experiment runs on (the bench `bench-local`, the one
15
+ # without an address) sees the shared data disk. /tmp for the demo, which runs
16
+ # on this machine alone.
17
+ LOCAL_DATA=/tmp
18
+
19
+ # A bench on another machine, when setup.yaml names one (see the example
20
+ # there): where its agent listens, the token it checks, and where it sees the
21
+ # same shared disk.
22
+ # BENCH_XXX_HOST=
23
+ # BENCH_XXX_TOKEN=
24
+ # BENCH_XXX_DATA=
25
+
26
+ # Everything below is an override: without the bench, or to point one device
27
+ # elsewhere for a test, set its ZMQ address directly (the sub-device name
28
+ # upper-cased); a device set here is not served by its bench.
29
+ # HWP_ADDRESS=tcp://localhost:5555
30
+ # SPEC_ADDRESS=tcp://localhost:5556
31
+
32
+ # This machine's view of the shared data disk, when the bench does not give it.
33
+ # Runs go to <PLESTY_DATA>/pol-pl unless --run-root says otherwise, and their
34
+ # spectra to each run's raw/spec.
35
+ # PLESTY_DATA=
@@ -0,0 +1,71 @@
1
+ # Custom
2
+ .deprecated/
3
+ logs/
4
+ runs/
5
+
6
+ # Field test and check reports. The JSON documents are the published
7
+ # artifacts — hub.plesty.net and manager.plesty.net read them, so they are
8
+ # committed. The markdown and JSONL forms are for whoever ran the test: they
9
+ # carry the host name, the instrument address, its serial and the lab's file
10
+ # paths, and a hub repository is world-readable.
11
+ # An interrupted `plesty init field-test` leaves its answers here.
12
+ .plesty-field-test.partial.json
13
+
14
+ reports/**/*.md
15
+ reports/**/*.jsonl
16
+ reports/*.md
17
+ reports/*.jsonl
18
+
19
+ # Auto-generated device reference pages (regenerated by `plesty docs`)
20
+ docs/_generated/
21
+
22
+ # Python bytecode and caches
23
+ __pycache__/
24
+ *.py[cod]
25
+ *$py.class
26
+
27
+ # C extensions and shared libraries
28
+ *.so
29
+ *.pyd
30
+ *.dll
31
+
32
+ # Packaging and build artifacts
33
+ build/
34
+ dist/
35
+ *.egg-info/
36
+ .eggs/
37
+
38
+ # Local credentials — keep `.env.example` tracked, never the real `.env`
39
+ .env
40
+
41
+ # Virtual environments
42
+ .venv/
43
+ venv/
44
+ env/
45
+ ENV/
46
+ .uv_cache/
47
+
48
+ # Test and coverage outputs
49
+ .pytest_cache/
50
+ .coverage
51
+ .coverage.*
52
+ htmlcov/
53
+ .mypy_cache/
54
+ .ruff_cache/
55
+
56
+ # Jupyter
57
+ .ipynb_checkpoints/
58
+
59
+ # Logs and runtime files
60
+ *.log
61
+ *.pid
62
+
63
+ # IDE/editor
64
+ .vscode/
65
+ .idea/
66
+ *.swp
67
+ *.swo
68
+
69
+ # OS files
70
+ .DS_Store
71
+ Thumbs.db
@@ -0,0 +1,16 @@
1
+ stages:
2
+ - check
3
+ - security
4
+ - deploy
5
+ - release
6
+
7
+ variables:
8
+ # Required for versioningit: the runner must fetch full Git history and tags.
9
+ GIT_DEPTH: "0"
10
+
11
+ include:
12
+ - component: $CI_SERVER_FQDN/plesty/plesty-ci/plesty-standard-ci@main
13
+ inputs:
14
+ standard: quantum
15
+ extra_branch: exp
16
+ access_token: $CI_BOT_TOKEN
@@ -0,0 +1 @@
1
+ Yunshuang Yuan <yuanyunshuang@163.com> yys <yuanyunshuang@163.com>
@@ -0,0 +1,139 @@
1
+ # Changelog
2
+
3
+ The format is based on [Keep a Changelog](https://keepachangelog.com).
4
+
5
+ ## [Unreleased]
6
+
7
+ ## [0.2.0] - 2026-10-27
8
+
9
+ Opens the 0.2 line, on the released plesty-lib 0.6.0; 0.1 stays supported as
10
+ the maintenance line. The demo's devices are pinned, so the Bench app's welcome
11
+ can install this release and run the same demo for as long as it is installed.
12
+
13
+ ### Changed
14
+ - **Spectra are recorded where the spectrometer's bench writes them.** The run
15
+ routes the spectrometer with `route()` (plesty-lib#59): it writes into
16
+ `pol-pl/<run_id>/raw/spec` under its bench's folder on the Plesty share and
17
+ answers with that folder, so a spectrum on bench `platform-a` is recorded as
18
+ `platform-a/pol-pl/<run_id>/raw/spec/<file>`. The run folder no longer has to
19
+ be on the share for the spectrometer to write; the run still needs
20
+ `PLESTY_DATA`. Needs plesty-lib 0.6.0.
21
+ - **The demo's devices are pinned** in `setup.yaml`: the stage is the released
22
+ `plesty-k10cr1` 0.3.0 (was its `exp` branch) and the spectrometer a fixed
23
+ commit of its `demo/pol-pl` branch, so a release of this module runs the same
24
+ demo for as long as it is installed.
25
+ - Requires the released plesty-lib 0.6.0 (was 0.5.0, then its `exp` branch)
26
+ and, for development, plesty-sdk 0.5.6.
27
+ - `analysis.rotator` also accepts `qwp` once plesty-fss offers it (a
28
+ quarter-wave plate in front of a fixed polarizer, plesty-fss!10); the
29
+ configuration test names a rotator neither version knows as its invalid
30
+ example.
31
+
32
+ ### Fixed
33
+ - The by-hand demo in the README and *Running* works: `-f` goes before
34
+ `fleet up`, which rejected it (#2); `fleet up` is given a copy of
35
+ `setup.yaml`, which it would otherwise rewrite (plesty-bench#48), the
36
+ spectrometer a folder to write in, which `plesty-server` before 0.5 does not
37
+ give a bench without a share, and the run the two device addresses. The
38
+ Bench app's welcome needed none of this.
39
+ - The lock takes pillow 13.0.0, brotli 1.2.1 and certifi 2026.10.23, which fix
40
+ the known vulnerabilities of the versions before.
41
+
42
+ ### Documentation
43
+ - Rebuilt as a guide — *Overview*, *Setup*, *Running*, *Analysis* — around a
44
+ flowchart of the run and a drawing of the rig. The figures are drawn by the
45
+ module's own code on the simulated dots of the tests
46
+ (`scripts/docs_figures.py`); *Analysis* shows a good and a failed fit and how
47
+ to tell them apart, *Running* covers the demo and the `--run-root` option.
48
+
49
+ ## [0.1.0] - 2026-09-30
50
+
51
+ The first release, on plesty-lib 0.5.0 and plesty-fss 0.1.0. Its command line
52
+ is built on `ExperimentCLI`, so PLESTY Bench can read its settings and offer it
53
+ on the Marketplace (plesty-bench#15).
54
+
55
+ ### Changed
56
+ - **One shared-data root, `PLESTY_DATA`; ports and the second spelling
57
+ gone.** The run is given only where this machine sees the shared disk
58
+ (`PLESTY_DATA`, replacing `PLESTY_DATA_DIR` and `PLESTY_DATA_MOUNT`, which it
59
+ no longer reads), and every path between machines is relative to that
60
+ shared point. Runs go to `pol-pl/<run_id>` there (the manifest's and the
61
+ viewer's root, `RUN_ROOT`); the spectrometer is routed to the run's
62
+ `raw/spec` and each spectrum is recorded as `pol-pl/<run_id>/raw/spec/<file>`,
63
+ taking only the file name from the spectrometer. A run directory off the
64
+ shared disk is refused before anything is measured. `setup.yaml` names no
65
+ ports or folders — the bench serving each device picks its port and gives
66
+ the run `HWP_ADDRESS` and `SPEC_ADDRESS` — and both devices run on
67
+ `bench-local`, the bench without an address; another bench is left in,
68
+ commented out, as an example. Needs plesty-lib >=0.5.0.dev6, which ships the
69
+ shared data root; the local path pin on plesty-lib is gone with it.
70
+ - **`fleet.demo.yaml` becomes `setup.yaml`, at the root.** A setup is a fleet
71
+ file with `benches:` beside the devices: where each bench's agent listens,
72
+ its token and where it sees the lab's shared data disk, each written as the
73
+ variable holding it (`${LOCAL_DATA}`) and set in `.env` — the file is
74
+ committed, so it carries no address, path or token. Every device names its
75
+ bench (`host_name`: `local`, the machine the experiment runs on, or one of
76
+ the benches). At start-up the run builds `HWP_ADDRESS` and `SPEC_ADDRESS`
77
+ from that bench and each device's port, and gives the run where that bench
78
+ sees the shared data disk, as `PLESTY_DATA` — plesty-lib's setup contract,
79
+ so the same with or without a bench; a value set by hand in `.env` still
80
+ wins. A bench writes `.env` when it installs the module. The fleet file's
81
+ `experiments:` section is gone — the bench declares the experiment, and a
82
+ second declaration in the module was a copy that could disagree. Needs
83
+ plesty-lib >=0.5.0.dev6.
84
+
85
+ ### Added
86
+ - **Each dot's analysis is saved with its report.** Beside the fine-structure
87
+ and line-fit outputs, `analysis/<dot>.report.json` holds what the analyzer
88
+ found — a sentence, a table of the lines with the splitting in µeV and pm,
89
+ and the sweep drawn — and the analysis record names it as
90
+ `report_document`. A reader renders it as HTML or LaTeX without importing
91
+ plesty-fss (plesty-lib#55).
92
+ - **The module declares how it is run.** `python -m plesty.pol_pl --manifest`
93
+ prints the run command, the run root, the environment the run reads, the
94
+ viewer it ships, and every configuration key with its type, unit, bounds and
95
+ meaning — connecting to nothing, so a console can offer this experiment's
96
+ settings without being taught anything about it. The declaration is `SCHEMA`
97
+ in `plesty/pol_pl/__main__.py`, and it and `config/default.yaml` say the same
98
+ thing: gate e3 fails a key that only one of them knows about.
99
+
100
+ - **A started run can be paused, cancelled, aborted and annotated** through
101
+ `plesty.lib.experiment.control` on its run directory. A request takes effect
102
+ between two angles, where the journal already commits. Pause keeps the stage
103
+ and the spectrometer connected and where they are; cancel lets the exposure
104
+ in flight finish and commit; abort does not wait, so the instruments are free
105
+ at once and that angle re-runs on resume.
106
+
107
+ - **`fleet.demo.yaml` and `config/demo.yaml`: the experiment runs without a lab, and
108
+ without a demo mode.** The whole difference is which fleet is brought up. The stage is the
109
+ released module under `--mock`; the spectrometer is the `demo/pol-pl` branch of
110
+ `plesty-lightfield-spectrometer`, which answers each acquisition with a spectrum really
111
+ measured on sample E098-SIL. It reads the run's own `journal.jsonl` to know which step it
112
+ is answering, so every replaying instrument on a bench stays on one cursor rather than
113
+ passing values to each other. A step the recording does not hold is refused, never answered
114
+ with a different spectrum. Nothing was added to this module: no `demo` package, no replay
115
+ rig, no second CLI, and so nothing here to drift from the measured path.
116
+
117
+ ### Changed
118
+ - **The command line is `plesty.lib.experiment.ExperimentCLI`'s.** `--config`,
119
+ `--resume`, `--run-root` and `--dry-run` keep their names and behaviour and
120
+ are now the library's, along with the preflight, the event loop and the
121
+ graceful stop; `--prominence` stays this module's and is declared in the
122
+ manifest alongside the configuration key it overrides. Needs
123
+ `plesty-lib>=0.5.0.dev4`.
124
+
125
+ - Initial experiment scaffold for `plesty.pol_pl`.
126
+ - `PolPlRig`: the K10CR1 half-wave-plate stage and the LightField spectrometer as one
127
+ composite device. Plate moves are checked against their target and retried once;
128
+ acquisitions are never repeated automatically and must produce a new file.
129
+ - `Experiment`: one spectrum per quantum dot per plate angle, then one analysis step per dot
130
+ that runs `plesty-fss` `FineStructure` over the dot's spectra, records the fine-structure
131
+ splitting of every line with its validity, and saves the analyzer outputs under
132
+ `analysis/` in the run (plesty/hub/experiments/plesty-pol-pl#1).
133
+ - The configuration is validated when the experiment is built; a hardware run also requires
134
+ the shared data disk (`PLESTY_DATA`).
135
+ - `--prominence COUNTS` sets the line-finding threshold of the analysis for one run, in
136
+ place of `analysis.fit_options.prominence` of the configuration.
137
+ - `python -m plesty.pol_pl.viz`: the spectrum with a marker on every analysed line, the
138
+ spectral map on a square-root colour scale, and the fine-structure view of each dot, which
139
+ fills while the sweep is measured and shows each line's result in the line's colour.
@@ -0,0 +1,184 @@
1
+ Copyright (C) 2026 Plesty Development Team
2
+
3
+ This file is part of Plesty.
4
+
5
+ Plesty is free software: you can redistribute it and/or modify
6
+ it under the terms of the GNU Lesser General Public License as published by
7
+ the Free Software Foundation, either version 3 of the License, or
8
+ (at your option) any later version.
9
+
10
+ Plesty is distributed in the hope that it will be useful,
11
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ GNU Lesser General Public License for more details.
14
+
15
+ You should have received a copy of the GNU Lesser General Public License
16
+ along with Plesty. If not, see <https://www.gnu.org/licenses/> or the copy below.
17
+
18
+ #########################################################################
19
+
20
+ GNU LESSER GENERAL PUBLIC LICENSE
21
+ Version 3, 29 June 2007
22
+
23
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
24
+ Everyone is permitted to copy and distribute verbatim copies
25
+ of this license document, but changing it is not allowed.
26
+
27
+
28
+ This version of the GNU Lesser General Public License incorporates
29
+ the terms and conditions of version 3 of the GNU General Public
30
+ License, supplemented by the additional permissions listed below.
31
+
32
+ 0. Additional Definitions.
33
+
34
+ As used herein, "this License" refers to version 3 of the GNU Lesser
35
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
36
+ General Public License.
37
+
38
+ "The Library" refers to a covered work governed by this License,
39
+ other than an Application or a Combined Work as defined below.
40
+
41
+ An "Application" is any work that makes use of an interface provided
42
+ by the Library, but which is not otherwise based on the Library.
43
+ Defining a subclass of a class defined by the Library is deemed a mode
44
+ of using an interface provided by the Library.
45
+
46
+ A "Combined Work" is a work produced by combining or linking an
47
+ Application with the Library. The particular version of the Library
48
+ with which the Combined Work was made is also called the "Linked
49
+ Version".
50
+
51
+ The "Minimal Corresponding Source" for a Combined Work means the
52
+ Corresponding Source for the Combined Work, excluding any source code
53
+ for portions of the Combined Work that, considered in isolation, are
54
+ based on the Application, and not on the Linked Version.
55
+
56
+ The "Corresponding Application Code" for a Combined Work means the
57
+ object code and/or source code for the Application, including any data
58
+ and utility programs needed for reproducing the Combined Work from the
59
+ Application, but excluding the System Libraries of the Combined Work.
60
+
61
+ 1. Exception to Section 3 of the GNU GPL.
62
+
63
+ You may convey a covered work under sections 3 and 4 of this License
64
+ without being bound by section 3 of the GNU GPL.
65
+
66
+ 2. Conveying Modified Versions.
67
+
68
+ If you modify a copy of the Library, and, in your modifications, a
69
+ facility refers to a function or data to be supplied by an Application
70
+ that uses the facility (other than as an argument passed when the
71
+ facility is invoked), then you may convey a copy of the modified
72
+ version:
73
+
74
+ a) under this License, provided that you make a good faith effort to
75
+ ensure that, in the event an Application does not supply the
76
+ function or data, the facility still operates, and performs
77
+ whatever part of its purpose remains meaningful, or
78
+
79
+ b) under the GNU GPL, with none of the additional permissions of
80
+ this License applicable to that copy.
81
+
82
+ 3. Object Code Incorporating Material from Library Header Files.
83
+
84
+ The object code form of an Application may incorporate material from
85
+ a header file that is part of the Library. You may convey such object
86
+ code under terms of your choice, provided that, if the incorporated
87
+ material is not limited to numerical parameters, data structure
88
+ layouts and accessors, or small macros, inline functions and templates
89
+ (ten or fewer lines in length), you do both of the following:
90
+
91
+ a) Give prominent notice with each copy of the object code that the
92
+ Library is used in it and that the Library and its use are
93
+ covered by this License.
94
+
95
+ b) Accompany the object code with a copy of the GNU GPL and this license
96
+ document.
97
+
98
+ 4. Combined Works.
99
+
100
+ You may convey a Combined Work under terms of your choice that,
101
+ taken together, effectively do not restrict modification of the
102
+ portions of the Library contained in the Combined Work and reverse
103
+ engineering for debugging such modifications, if you also do each of
104
+ the following:
105
+
106
+ a) Give prominent notice with each copy of the Combined Work that
107
+ the Library is used in it and that the Library and its use are
108
+ covered by this License.
109
+
110
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
111
+ document.
112
+
113
+ c) For a Combined Work that displays copyright notices during
114
+ execution, include the copyright notice for the Library among
115
+ these notices, as well as a reference directing the user to the
116
+ copies of the GNU GPL and this license document.
117
+
118
+ d) Do one of the following:
119
+
120
+ 0) Convey the Minimal Corresponding Source under the terms of this
121
+ License, and the Corresponding Application Code in a form
122
+ suitable for, and under terms that permit, the user to
123
+ recombine or relink the Application with a modified version of
124
+ the Linked Version to produce a modified Combined Work, in the
125
+ manner specified by section 6 of the GNU GPL for conveying
126
+ Corresponding Source.
127
+
128
+ 1) Use a suitable shared library mechanism for linking with the
129
+ Library. A suitable mechanism is one that (a) uses at run time
130
+ a copy of the Library already present on the user's computer
131
+ system, and (b) will operate properly with a modified version
132
+ of the Library that is interface-compatible with the Linked
133
+ Version.
134
+
135
+ e) Provide Installation Information, but only if you would otherwise
136
+ be required to provide such information under section 6 of the
137
+ GNU GPL, and only to the extent that such information is
138
+ necessary to install and execute a modified version of the
139
+ Combined Work produced by recombining or relinking the
140
+ Application with a modified version of the Linked Version. (If
141
+ you use option 4d0, the Installation Information must accompany
142
+ the Minimal Corresponding Source and Corresponding Application
143
+ Code. If you use option 4d1, you must provide the Installation
144
+ Information in the manner specified by section 6 of the GNU GPL
145
+ for conveying Corresponding Source.)
146
+
147
+ 5. Combined Libraries.
148
+
149
+ You may place library facilities that are a work based on the
150
+ Library side by side in a single library together with other library
151
+ facilities that are not Applications and are not covered by this
152
+ License, and convey such a combined library under terms of your
153
+ choice, if you do both of the following:
154
+
155
+ a) Accompany the combined library with a copy of the same work based
156
+ on the Library, uncombined with any other library facilities,
157
+ conveyed under the terms of this License.
158
+
159
+ b) Give prominent notice with the combined library that part of it
160
+ is a work based on the Library, and explaining where to find the
161
+ accompanying uncombined form of the same work.
162
+
163
+ 6. Revised Versions of the GNU Lesser General Public License.
164
+
165
+ The Free Software Foundation may publish revised and/or new versions
166
+ of the GNU Lesser General Public License from time to time. Such new
167
+ versions will be similar in spirit to the present version, but may
168
+ differ in detail to address new problems or concerns.
169
+
170
+ Each version is given a distinguishing version number. If the
171
+ Library as you received it specifies that a certain numbered version
172
+ of the GNU Lesser General Public License "or any later version"
173
+ applies to it, you have the option of following the terms and
174
+ conditions either of that published version or of any later version
175
+ published by the Free Software Foundation. If the Library as you
176
+ received it does not specify a version number of the GNU Lesser
177
+ General Public License, you may choose any version of the GNU Lesser
178
+ General Public License ever published by the Free Software Foundation.
179
+
180
+ If the Library as you received it specifies that a proxy can decide
181
+ whether future versions of the GNU Lesser General Public License shall
182
+ apply, that proxy's public statement of acceptance of any version is
183
+ permanent authorization for you to choose that version for the
184
+ Library.
@@ -0,0 +1,165 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+
9
+ This version of the GNU Lesser General Public License incorporates
10
+ the terms and conditions of version 3 of the GNU General Public
11
+ License, supplemented by the additional permissions listed below.
12
+
13
+ 0. Additional Definitions.
14
+
15
+ As used herein, "this License" refers to version 3 of the GNU Lesser
16
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
+ General Public License.
18
+
19
+ "The Library" refers to a covered work governed by this License,
20
+ other than an Application or a Combined Work as defined below.
21
+
22
+ An "Application" is any work that makes use of an interface provided
23
+ by the Library, but which is not otherwise based on the Library.
24
+ Defining a subclass of a class defined by the Library is deemed a mode
25
+ of using an interface provided by the Library.
26
+
27
+ A "Combined Work" is a work produced by combining or linking an
28
+ Application with the Library. The particular version of the Library
29
+ with which the Combined Work was made is also called the "Linked
30
+ Version".
31
+
32
+ The "Minimal Corresponding Source" for a Combined Work means the
33
+ Corresponding Source for the Combined Work, excluding any source code
34
+ for portions of the Combined Work that, considered in isolation, are
35
+ based on the Application, and not on the Linked Version.
36
+
37
+ The "Corresponding Application Code" for a Combined Work means the
38
+ object code and/or source code for the Application, including any data
39
+ and utility programs needed for reproducing the Combined Work from the
40
+ Application, but excluding the System Libraries of the Combined Work.
41
+
42
+ 1. Exception to Section 3 of the GNU GPL.
43
+
44
+ You may convey a covered work under sections 3 and 4 of this License
45
+ without being bound by section 3 of the GNU GPL.
46
+
47
+ 2. Conveying Modified Versions.
48
+
49
+ If you modify a copy of the Library, and, in your modifications, a
50
+ facility refers to a function or data to be supplied by an Application
51
+ that uses the facility (other than as an argument passed when the
52
+ facility is invoked), then you may convey a copy of the modified
53
+ version:
54
+
55
+ a) under this License, provided that you make a good faith effort to
56
+ ensure that, in the event an Application does not supply the
57
+ function or data, the facility still operates, and performs
58
+ whatever part of its purpose remains meaningful, or
59
+
60
+ b) under the GNU GPL, with none of the additional permissions of
61
+ this License applicable to that copy.
62
+
63
+ 3. Object Code Incorporating Material from Library Header Files.
64
+
65
+ The object code form of an Application may incorporate material from
66
+ a header file that is part of the Library. You may convey such object
67
+ code under terms of your choice, provided that, if the incorporated
68
+ material is not limited to numerical parameters, data structure
69
+ layouts and accessors, or small macros, inline functions and templates
70
+ (ten or fewer lines in length), you do both of the following:
71
+
72
+ a) Give prominent notice with each copy of the object code that the
73
+ Library is used in it and that the Library and its use are
74
+ covered by this License.
75
+
76
+ b) Accompany the object code with a copy of the GNU GPL and this license
77
+ document.
78
+
79
+ 4. Combined Works.
80
+
81
+ You may convey a Combined Work under terms of your choice that,
82
+ taken together, effectively do not restrict modification of the
83
+ portions of the Library contained in the Combined Work and reverse
84
+ engineering for debugging such modifications, if you also do each of
85
+ the following:
86
+
87
+ a) Give prominent notice with each copy of the Combined Work that
88
+ the Library is used in it and that the Library and its use are
89
+ covered by this License.
90
+
91
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
+ document.
93
+
94
+ c) For a Combined Work that displays copyright notices during
95
+ execution, include the copyright notice for the Library among
96
+ these notices, as well as a reference directing the user to the
97
+ copies of the GNU GPL and this license document.
98
+
99
+ d) Do one of the following:
100
+
101
+ 0) Convey the Minimal Corresponding Source under the terms of this
102
+ License, and the Corresponding Application Code in a form
103
+ suitable for, and under terms that permit, the user to
104
+ recombine or relink the Application with a modified version of
105
+ the Linked Version to produce a modified Combined Work, in the
106
+ manner specified by section 6 of the GNU GPL for conveying
107
+ Corresponding Source.
108
+
109
+ 1) Use a suitable shared library mechanism for linking with the
110
+ Library. A suitable mechanism is one that (a) uses at run time
111
+ a copy of the Library already present on the user's computer
112
+ system, and (b) will operate properly with a modified version
113
+ of the Library that is interface-compatible with the Linked
114
+ Version.
115
+
116
+ e) Provide Installation Information, but only if you would otherwise
117
+ be required to provide such information under section 6 of the
118
+ GNU GPL, and only to the extent that such information is
119
+ necessary to install and execute a modified version of the
120
+ Combined Work produced by recombining or relinking the
121
+ Application with a modified version of the Linked Version. (If
122
+ you use option 4d0, the Installation Information must accompany
123
+ the Minimal Corresponding Source and Corresponding Application
124
+ Code. If you use option 4d1, you must provide the Installation
125
+ Information in the manner specified by section 6 of the GNU GPL
126
+ for conveying Corresponding Source.)
127
+
128
+ 5. Combined Libraries.
129
+
130
+ You may place library facilities that are a work based on the
131
+ Library side by side in a single library together with other library
132
+ facilities that are not Applications and are not covered by this
133
+ License, and convey such a combined library under terms of your
134
+ choice, if you do both of the following:
135
+
136
+ a) Accompany the combined library with a copy of the same work based
137
+ on the Library, uncombined with any other library facilities,
138
+ conveyed under the terms of this License.
139
+
140
+ b) Give prominent notice with the combined library that part of it
141
+ is a work based on the Library, and explaining where to find the
142
+ accompanying uncombined form of the same work.
143
+
144
+ 6. Revised Versions of the GNU Lesser General Public License.
145
+
146
+ The Free Software Foundation may publish revised and/or new versions
147
+ of the GNU Lesser General Public License from time to time. Such new
148
+ versions will be similar in spirit to the present version, but may
149
+ differ in detail to address new problems or concerns.
150
+
151
+ Each version is given a distinguishing version number. If the
152
+ Library as you received it specifies that a certain numbered version
153
+ of the GNU Lesser General Public License "or any later version"
154
+ applies to it, you have the option of following the terms and
155
+ conditions either of that published version or of any later version
156
+ published by the Free Software Foundation. If the Library as you
157
+ received it does not specify a version number of the GNU Lesser
158
+ General Public License, you may choose any version of the GNU Lesser
159
+ General Public License ever published by the Free Software Foundation.
160
+
161
+ If the Library as you received it specifies that a proxy can decide
162
+ whether future versions of the GNU Lesser General Public License shall
163
+ apply, that proxy's public statement of acceptance of any version is
164
+ permanent authorization for you to choose that version for the
165
+ Library.