entroptics 0.1.1__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.
- entroptics-0.1.1/LICENSE.md +202 -0
- entroptics-0.1.1/NOTICE +6 -0
- entroptics-0.1.1/PKG-INFO +418 -0
- entroptics-0.1.1/README.md +182 -0
- entroptics-0.1.1/pyproject.toml +43 -0
- entroptics-0.1.1/setup.cfg +4 -0
- entroptics-0.1.1/src/entroptics/__init__.py +27 -0
- entroptics-0.1.1/src/entroptics/aperture.py +717 -0
- entroptics-0.1.1/src/entroptics/dynamics.py +626 -0
- entroptics-0.1.1/src/entroptics/entropy.py +330 -0
- entroptics-0.1.1/src/entroptics/environment.py +242 -0
- entroptics-0.1.1/src/entroptics/extract.py +51 -0
- entroptics-0.1.1/src/entroptics/fields.py +78 -0
- entroptics-0.1.1/src/entroptics/null_providers.py +537 -0
- entroptics-0.1.1/src/entroptics/reads.py +980 -0
- entroptics-0.1.1/src/entroptics/screen.py +700 -0
- entroptics-0.1.1/src/entroptics/sweep.py +110 -0
- entroptics-0.1.1/src/entroptics/tensor.py +288 -0
- entroptics-0.1.1/src/entroptics.egg-info/PKG-INFO +418 -0
- entroptics-0.1.1/src/entroptics.egg-info/SOURCES.txt +21 -0
- entroptics-0.1.1/src/entroptics.egg-info/dependency_links.txt +1 -0
- entroptics-0.1.1/src/entroptics.egg-info/requires.txt +16 -0
- entroptics-0.1.1/src/entroptics.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Ikailo Inc.
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
entroptics-0.1.1/NOTICE
ADDED
|
@@ -0,0 +1,418 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: entroptics
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: The universe, in focus.
|
|
5
|
+
Author-email: Ikailo John Sessford <john@ikailo.com>
|
|
6
|
+
License:
|
|
7
|
+
Apache License
|
|
8
|
+
Version 2.0, January 2004
|
|
9
|
+
http://www.apache.org/licenses/
|
|
10
|
+
|
|
11
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
12
|
+
|
|
13
|
+
1. Definitions.
|
|
14
|
+
|
|
15
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
16
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
17
|
+
|
|
18
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
19
|
+
the copyright owner that is granting the License.
|
|
20
|
+
|
|
21
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
22
|
+
other entities that control, are controlled by, or are under common
|
|
23
|
+
control with that entity. For the purposes of this definition,
|
|
24
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
25
|
+
direction or management of such entity, whether by contract or
|
|
26
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
27
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
28
|
+
|
|
29
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
30
|
+
exercising permissions granted by this License.
|
|
31
|
+
|
|
32
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
33
|
+
including but not limited to software source code, documentation
|
|
34
|
+
source, and configuration files.
|
|
35
|
+
|
|
36
|
+
"Object" form shall mean any form resulting from mechanical
|
|
37
|
+
transformation or translation of a Source form, including but
|
|
38
|
+
not limited to compiled object code, generated documentation,
|
|
39
|
+
and conversions to other media types.
|
|
40
|
+
|
|
41
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
42
|
+
Object form, made available under the License, as indicated by a
|
|
43
|
+
copyright notice that is included in or attached to the work
|
|
44
|
+
(an example is provided in the Appendix below).
|
|
45
|
+
|
|
46
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
47
|
+
form, that is based on (or derived from) the Work and for which the
|
|
48
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
49
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
50
|
+
of this License, Derivative Works shall not include works that remain
|
|
51
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
52
|
+
the Work and Derivative Works thereof.
|
|
53
|
+
|
|
54
|
+
"Contribution" shall mean any work of authorship, including
|
|
55
|
+
the original version of the Work and any modifications or additions
|
|
56
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
57
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
58
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
59
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
60
|
+
means any form of electronic, verbal, or written communication sent
|
|
61
|
+
to the Licensor or its representatives, including but not limited to
|
|
62
|
+
communication on electronic mailing lists, source code control systems,
|
|
63
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
64
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
65
|
+
excluding communication that is conspicuously marked or otherwise
|
|
66
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
67
|
+
|
|
68
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
69
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
70
|
+
subsequently incorporated within the Work.
|
|
71
|
+
|
|
72
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
73
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
74
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
75
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
76
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
77
|
+
Work and such Derivative Works in Source or Object form.
|
|
78
|
+
|
|
79
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
80
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
81
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
82
|
+
(except as stated in this section) patent license to make, have made,
|
|
83
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
84
|
+
where such license applies only to those patent claims licensable
|
|
85
|
+
by such Contributor that are necessarily infringed by their
|
|
86
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
87
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
88
|
+
institute patent litigation against any entity (including a
|
|
89
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
90
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
91
|
+
or contributory patent infringement, then any patent licenses
|
|
92
|
+
granted to You under this License for that Work shall terminate
|
|
93
|
+
as of the date such litigation is filed.
|
|
94
|
+
|
|
95
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
96
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
97
|
+
modifications, and in Source or Object form, provided that You
|
|
98
|
+
meet the following conditions:
|
|
99
|
+
|
|
100
|
+
(a) You must give any other recipients of the Work or
|
|
101
|
+
Derivative Works a copy of this License; and
|
|
102
|
+
|
|
103
|
+
(b) You must cause any modified files to carry prominent notices
|
|
104
|
+
stating that You changed the files; and
|
|
105
|
+
|
|
106
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
107
|
+
that You distribute, all copyright, patent, trademark, and
|
|
108
|
+
attribution notices from the Source form of the Work,
|
|
109
|
+
excluding those notices that do not pertain to any part of
|
|
110
|
+
the Derivative Works; and
|
|
111
|
+
|
|
112
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
113
|
+
distribution, then any Derivative Works that You distribute must
|
|
114
|
+
include a readable copy of the attribution notices contained
|
|
115
|
+
within such NOTICE file, excluding those notices that do not
|
|
116
|
+
pertain to any part of the Derivative Works, in at least one
|
|
117
|
+
of the following places: within a NOTICE text file distributed
|
|
118
|
+
as part of the Derivative Works; within the Source form or
|
|
119
|
+
documentation, if provided along with the Derivative Works; or,
|
|
120
|
+
within a display generated by the Derivative Works, if and
|
|
121
|
+
wherever such third-party notices normally appear. The contents
|
|
122
|
+
of the NOTICE file are for informational purposes only and
|
|
123
|
+
do not modify the License. You may add Your own attribution
|
|
124
|
+
notices within Derivative Works that You distribute, alongside
|
|
125
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
126
|
+
that such additional attribution notices cannot be construed
|
|
127
|
+
as modifying the License.
|
|
128
|
+
|
|
129
|
+
You may add Your own copyright statement to Your modifications and
|
|
130
|
+
may provide additional or different license terms and conditions
|
|
131
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
132
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
133
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
134
|
+
the conditions stated in this License.
|
|
135
|
+
|
|
136
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
137
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
138
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
139
|
+
this License, without any additional terms or conditions.
|
|
140
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
141
|
+
the terms of any separate license agreement you may have executed
|
|
142
|
+
with Licensor regarding such Contributions.
|
|
143
|
+
|
|
144
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
145
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
146
|
+
except as required for reasonable and customary use in describing the
|
|
147
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
148
|
+
|
|
149
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
150
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
151
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
152
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
153
|
+
implied, including, without limitation, any warranties or conditions
|
|
154
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
155
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
156
|
+
appropriateness of using or redistributing the Work and assume any
|
|
157
|
+
risks associated with Your exercise of permissions under this License.
|
|
158
|
+
|
|
159
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
160
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
161
|
+
unless required by applicable law (such as deliberate and grossly
|
|
162
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
163
|
+
liable to You for damages, including any direct, indirect, special,
|
|
164
|
+
incidental, or consequential damages of any character arising as a
|
|
165
|
+
result of this License or out of the use or inability to use the
|
|
166
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
167
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
168
|
+
other commercial damages or losses), even if such Contributor
|
|
169
|
+
has been advised of the possibility of such damages.
|
|
170
|
+
|
|
171
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
172
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
173
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
174
|
+
or other liability obligations and/or rights consistent with this
|
|
175
|
+
License. However, in accepting such obligations, You may act only
|
|
176
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
177
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
178
|
+
defend, and hold each Contributor harmless for any liability
|
|
179
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
180
|
+
of your accepting any such warranty or additional liability.
|
|
181
|
+
|
|
182
|
+
END OF TERMS AND CONDITIONS
|
|
183
|
+
|
|
184
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
185
|
+
|
|
186
|
+
To apply the Apache License to your work, attach the following
|
|
187
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
188
|
+
replaced with your own identifying information. (Don't include
|
|
189
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
190
|
+
comment syntax for the file format. We also recommend that a
|
|
191
|
+
file or class name and description of purpose be included on the
|
|
192
|
+
same "printed page" as the copyright notice for easier
|
|
193
|
+
identification within third-party archives.
|
|
194
|
+
|
|
195
|
+
Copyright 2026 Ikailo Inc.
|
|
196
|
+
|
|
197
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
198
|
+
you may not use this file except in compliance with the License.
|
|
199
|
+
You may obtain a copy of the License at
|
|
200
|
+
|
|
201
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
202
|
+
|
|
203
|
+
Unless required by applicable law or agreed to in writing, software
|
|
204
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
205
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
206
|
+
See the License for the specific language governing permissions and
|
|
207
|
+
limitations under the License.
|
|
208
|
+
Project-URL: Repository, https://github.com/Agience/agience-entroptics
|
|
209
|
+
Project-URL: Issues, https://github.com/Agience/agience-entroptics/issues
|
|
210
|
+
Keywords: entropy,optics,aperture
|
|
211
|
+
Classifier: Programming Language :: Python :: 3
|
|
212
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
213
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
214
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
215
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
216
|
+
Classifier: Operating System :: OS Independent
|
|
217
|
+
Classifier: Intended Audience :: Science/Research
|
|
218
|
+
Classifier: Topic :: Scientific/Engineering
|
|
219
|
+
Requires-Python: >=3.10
|
|
220
|
+
Description-Content-Type: text/markdown
|
|
221
|
+
License-File: LICENSE.md
|
|
222
|
+
License-File: NOTICE
|
|
223
|
+
Requires-Dist: numpy>=2.0
|
|
224
|
+
Provides-Extra: torch
|
|
225
|
+
Requires-Dist: torch>=2.0; extra == "torch"
|
|
226
|
+
Provides-Extra: scipy
|
|
227
|
+
Requires-Dist: scipy>=1.10; extra == "scipy"
|
|
228
|
+
Provides-Extra: test
|
|
229
|
+
Requires-Dist: pytest>=8; extra == "test"
|
|
230
|
+
Requires-Dist: scipy>=1.10; extra == "test"
|
|
231
|
+
Provides-Extra: dev
|
|
232
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
233
|
+
Requires-Dist: scipy>=1.10; extra == "dev"
|
|
234
|
+
Requires-Dist: torch>=2.0; extra == "dev"
|
|
235
|
+
Dynamic: license-file
|
|
236
|
+
|
|
237
|
+
# Entroptics
|
|
238
|
+
|
|
239
|
+
[](https://pypi.org/project/entroptics/)
|
|
240
|
+
[](https://pypi.org/project/entroptics/)
|
|
241
|
+
[](https://github.com/Agience/agience-entroptics/blob/main/LICENSE.md)
|
|
242
|
+
[](https://github.com/Agience/agience-entroptics/actions/workflows/ci.yml)
|
|
243
|
+
[](https://github.com/Agience/agience-entroptics/tree/main/research/lean)
|
|
244
|
+
[](https://zenodo.org/badge/latestdoi/1293014088)
|
|
245
|
+
[](https://github.com/sponsors/ikailo)
|
|
246
|
+
|
|
247
|
+
## *The universe, in focus.*
|
|
248
|
+
|
|
249
|
+
**Read any 2-D signal as a finite optical aperture whose resolution is fixed by the signal's own entropy.**
|
|
250
|
+
|
|
251
|
+
Entroptics (entropy + optics) treats a 2-D array `W` of shape `(T, F)`, one **ordered** axis (time / evolution) and one **feature** axis (channels / frequency), as a finite optical aperture. The signal sets its own focus from the entropy of its power marginals. Every quantity Entroptics reports is then a standard optical / wave measurement (étendue, Strehl, OTF, diffraction limit, propagation constant), and the same reads apply to any structured 2-D field: a spectrogram, a waterfall, an embedding stack, a market panel, an image.
|
|
252
|
+
|
|
253
|
+
It is a small, standalone library, **numpy only** at the core (scipy and torch optional), built entirely from geometry and standard theorems. Parameter-free and domain-agnostic.
|
|
254
|
+
|
|
255
|
+
## Install
|
|
256
|
+
|
|
257
|
+
```bash
|
|
258
|
+
pip install -e . # core (numpy only)
|
|
259
|
+
pip install -e ".[torch]" # + GPU / torch tensors
|
|
260
|
+
pip install -e ".[scipy]" # + exact MAD constant
|
|
261
|
+
pip install -e ".[dev]" # + pytest, torch, scipy (to run the tests)
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
Requires Python ≥ 3.10 and numpy ≥ 2.0.
|
|
265
|
+
|
|
266
|
+
## Two objects
|
|
267
|
+
|
|
268
|
+
| | |
|
|
269
|
+
|---|---|
|
|
270
|
+
| **`Aperture`** | The **optics**, information *about* a structure (read-only). The single front door: batch `Aperture(W)` or streaming `Aperture(window=…).update(frame)`. Exposes the per-axis and screen-area reads, the mode spectrum, the diffraction limit, and a streaming dynamical operator for exact decay rates. |
|
|
271
|
+
| **`Screen`** | The **projection**, information *within* the structure (read-only). Folds the signal onto its entropy-matched grid and reads its SVD structure, coherence, and the modes above the noise floor. A denoised view is the `extract` filter — a projection onto those resolved modes. |
|
|
272
|
+
|
|
273
|
+
`ap.screen()` and `Screen(W).aperture()` cross between the two views.
|
|
274
|
+
|
|
275
|
+
## Quickstart
|
|
276
|
+
|
|
277
|
+
### Batch
|
|
278
|
+
|
|
279
|
+
```python
|
|
280
|
+
import numpy as np
|
|
281
|
+
from entroptics import Aperture
|
|
282
|
+
|
|
283
|
+
W = np.random.default_rng(0).standard_normal((256, 64))
|
|
284
|
+
|
|
285
|
+
ap = Aperture(W)
|
|
286
|
+
|
|
287
|
+
o = ap.optics() # the full intrinsic read, as a dict (33 fields)
|
|
288
|
+
ap.phi, ap.magnification # fill fraction and its reciprocal (scale duality)
|
|
289
|
+
ap.etendue, ap.space_bandwidth
|
|
290
|
+
ap.strehl # dominant-mode coherence
|
|
291
|
+
ap.T, ap.F # per-axis AxisRead(H, n, delta, phi, sigma)
|
|
292
|
+
ap.spectral # contrast, attenuation α, phase β, dispersion, resolved_power, dominance
|
|
293
|
+
ap.a_delta, ap.correlation_length, ap.mercer # diffraction limit + certificate
|
|
294
|
+
ap.scale_profile() # structure vs observation window (resolution vs aperture size)
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### The projection
|
|
298
|
+
|
|
299
|
+
```python
|
|
300
|
+
sc = ap.screen()
|
|
301
|
+
sc.K_signal # SVD modes standing above the noise floor
|
|
302
|
+
sc.coherence # ordered-axis structure z-score (deterministic)
|
|
303
|
+
sc.footprints # per-mode (phi_T, phi_F) localization of each resolved mode
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### The filter
|
|
307
|
+
|
|
308
|
+
Pull the resolved signal out of the field — a projection onto its own screen modes.
|
|
309
|
+
|
|
310
|
+
```python
|
|
311
|
+
clean, info = ap.extract() # or: entroptics.extract(W) for the full frame
|
|
312
|
+
info["K_signal"] # resolved modes above the floor
|
|
313
|
+
info["contrast"] # leading singular value over the floor (σ₁ / Φ)
|
|
314
|
+
info["n_kept"], info["n_dropped"] # transient modes kept, persistent (RFI) modes dropped
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
`clean = U · diag(S̃) · Vᴴ` uses the data's own screen modes `U, Vᴴ` and the Gavish–Donoho optimal singular-value shrinkage `S̃` against the derived floor: exact recovery in the noise-free limit, idempotent, with the persistent narrowband (`φ_F ≤ φ_T`) modes dropped.
|
|
318
|
+
|
|
319
|
+
### Streaming, resume, splice
|
|
320
|
+
|
|
321
|
+
Feed frames from the first one and propagate; the exact-rate operator updates online.
|
|
322
|
+
|
|
323
|
+
```python
|
|
324
|
+
ap = Aperture(window=512) # window bounds the optics snapshot
|
|
325
|
+
for frame in signal: # each frame an F-vector (numpy or torch)
|
|
326
|
+
ap.update(frame)
|
|
327
|
+
|
|
328
|
+
ap.rates() # long_range (slowest) & short_range (fastest) decay
|
|
329
|
+
ap.predict(frame) # one-step forecast A·x (A = ap.propagator_full())
|
|
330
|
+
|
|
331
|
+
s = ap.state() # export the full operator state …
|
|
332
|
+
ap2 = Aperture.from_state(s) # … and resume exactly (bit-for-bit)
|
|
333
|
+
|
|
334
|
+
whole = a.splice(b) # a, b: two Aperture streams → the concatenated-stream operator (exact at forgetting=1)
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
## What it reads
|
|
338
|
+
|
|
339
|
+
All reads are intrinsic (derived from `W` alone) and tied to a standard theorem.
|
|
340
|
+
|
|
341
|
+
- **Scale**, `phi` (fill fraction) and `magnification = 1/phi`; per-axis `H_T/H_F`, `n_T/n_F`, `delta_T/delta_F` from the entropy of the power marginals.
|
|
342
|
+
- **Aperture area**, `etendue = phi_F · phi_T` (a bounded 2-D area), `space_bandwidth = n_F · n_T` (resolvable spots).
|
|
343
|
+
- **Coherence**, `strehl` (dominant-mode power fraction), `phi_T/phi_F`, `sigma_T/sigma_F`; `Screen.coherence` (a closed-form z-score against the exact row-permutation null).
|
|
344
|
+
- **Mode spectrum**, `spectral_optics`: contrast, top-share, resolved modes, noise floor from a `null=` provider (see `entroptics.null_providers`) — the derived Marchenko–Pastur / Johnstone default (`mp`, used when `null` is unset) or the deterministic data-derived Tukey fence (pass `null=null_providers.robust`), the propagation constant γ = α + iβ (attenuation α, phase β), dispersion, `resolved_power` (the summed eigenvalue excess above the floor), and `dominance = (λ₁−1)/(F−1)` (F = correlation variables). `attenuation_interval` gives a Weyl-certified interval for α.
|
|
345
|
+
- **Concentration**, `concentration`: `intensity` (σ₁²), `focus` (axial), `resultant` (directional, von Mises–Fisher).
|
|
346
|
+
- **Diffraction limit**, `decay` (the OTF, an FFT-free autocorrelation), `diffraction_limit` (entropy width `a_delta = 1/2^{H(C²)}` + classical Abbe length), `mercer_certificate` (a model-free temporal-vs-spectral cross-check), `rayleigh_shape_factor` (the shape factor `g = xi * a_delta`), `fresnel_number`, `shape_factor` (the Abbe factor `a_delta / phi_F`), `decay_rate` (log-linear fit of a supplied 1-D curve).
|
|
347
|
+
- **N-D fields**, `entroptics.fields`: `slabs(field, plane_axes)` / `over_planes(field, plane_axes, read=, reduce=)` reduce a higher-D field to the 2-D screen **while keeping each plane intact** (the correct reduction for feature reads, which need within-plane correlation); `pool(field, ordered_axis)` flattens sites as samples (the correct reduction for ordered reads).
|
|
348
|
+
- **Dynamics**, `Aperture.rates()`: exact per-mode decay rates `α_k = −log|μ_k|` and frequencies `β_k = arg(μ_k)` from a streaming online-DMD / Koopman operator; splice-able and resumable. `Aperture.propagator_full()` / `predict(x)` expose and apply the full one-step operator `A = P_yx · P_xx⁺`.
|
|
349
|
+
- **Multi-scale**, `scale_profile(W)`: structure as a function of observation window (resolution vs aperture size), `K_signal` / `coherence` / `a_delta` / `phi_T` per window, plus `resolved_window` / `dominant_window` (in ordered-axis cells).
|
|
350
|
+
- **Projection**, `Screen` (`embeddings`, `footprints`, `read`) and `Aperture.tensor()` (a delay-embedded Tucker/HOSVD that exposes within-window fine structure the averaged screen loses).
|
|
351
|
+
- **Filter**, `Aperture.extract()` / `entroptics.extract(W)`: the read-side denoiser — project the field onto its own resolved screen modes with Gavish–Donoho optimal singular-value shrinkage against the derived floor, dropping persistent narrowband (`phi_F <= phi_T`) interference. Returns `(clean, info)` where `clean` is a linear projection of the measured data (it synthesises nothing) and `info` carries `K_signal`, `contrast`, `coherence`, and the kept/dropped modes.
|
|
352
|
+
- **Sweep**, `entroptics.sweep(W)`: fix the aperture to a bounded capacity and sweep it where the coherence gate finds structure (noise-only patches are skipped); returns per-coherent-band reads — column `span`, entropy `width`, and tail decay `tau` — in abstract, dimensionless window samples.
|
|
353
|
+
|
|
354
|
+
## Unwinding a propagation channel
|
|
355
|
+
|
|
356
|
+
`research/applications/cosmology.py` drives Entroptics to invert a burst's interstellar propagation and return it to the source frame. Each transform in the medium's stack carries one free parameter, fixed by **maximizing an entroptics read**:
|
|
357
|
+
|
|
358
|
+
| transform | recovers | read maximized |
|
|
359
|
+
|---|---|---|
|
|
360
|
+
| dispersion `τ(f) = K·DM·f⁻²` | `DM` | leading-mode contrast |
|
|
361
|
+
| Faraday rotation `Δψ = RM·λ²` | `RM` | derotated polarized amplitude |
|
|
362
|
+
| scattering `⊛ e^{−t/τ}` | `τ_scatter` | per-band tail decay rate |
|
|
363
|
+
| instrument / RFI | — | the `φ_F > φ_T` geometric filter |
|
|
364
|
+
|
|
365
|
+
```python
|
|
366
|
+
from cosmology import unwind
|
|
367
|
+
|
|
368
|
+
r = unwind(I, freqs, dt) # intensity → DM + scattering + RFI-cleaned source frame
|
|
369
|
+
r = unwind(I, freqs, dt, Q=Q, U=U) # + Faraday derotation and source-frame polarization
|
|
370
|
+
r.source # dedispersed, derotated, RFI-cleaned burst
|
|
371
|
+
r.dm, r.rm, r.tau_scatter, r.pol_fraction
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
The library supplies the objectives (contrast, polarized amplitude, decay rate) and `unwind` applies the known-physics inverse transforms out of band. Pass `skip={"dispersion"}` for data a stage has already been applied to (e.g. coherently-dedispersed baseband).
|
|
375
|
+
|
|
376
|
+
## The theory in one line
|
|
377
|
+
|
|
378
|
+
Everything hangs off one chain of standard results:
|
|
379
|
+
|
|
380
|
+
> **Wiener–Khinchin** (autocorrelation ↔ power spectrum) provides the lag average → the **Fourier-optics autocorrelation theorem** (OTF = pupil autocorrelation) → **Abbe/Rayleigh** (resolution = 1 / OTF-bandwidth = 1 / correlation length).
|
|
381
|
+
|
|
382
|
+
The entropy width `1/2^{H}` (with `H` the Shannon entropy of the squared decay `C²`) is the noise-robust estimator of that reciprocal correlation length. By **Mercer**, the temporal read (decay entropy) and the spectral read (the stationary correlation operator's eigenspectrum) track each other, a built-in, model-free certificate.
|
|
383
|
+
|
|
384
|
+
## Backends & determinism
|
|
385
|
+
|
|
386
|
+
- **One code path, numpy or torch.** Feed a numpy array → runs on CPU; feed a torch tensor → runs on its device (GPU), staying on-device; torch is imported lazily only when a tensor appears.
|
|
387
|
+
- **Deterministic.** The coherence is a closed-form permutation-null z-score, so results are reproducible and bit-identical across numpy and torch (to floating-point round-off).
|
|
388
|
+
- **Complex-safe** end to end (coherent field vs. incoherent intensity reads are dispatched automatically).
|
|
389
|
+
|
|
390
|
+
## Axis convention
|
|
391
|
+
|
|
392
|
+
Every input `W` has shape `(T, F)`:
|
|
393
|
+
|
|
394
|
+
- axis-0 (rows, `_T`) is the **ordered** / evolution axis, "time" is a *role*, not literal physics;
|
|
395
|
+
- axis-1 (cols, `_F`) is the **feature** / channel axis, "frequency" is likewise a role.
|
|
396
|
+
|
|
397
|
+
Any 2-D array with one ordered axis works.
|
|
398
|
+
|
|
399
|
+
## Tests
|
|
400
|
+
|
|
401
|
+
```bash
|
|
402
|
+
pip install -e ".[dev]"
|
|
403
|
+
pytest
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
The suite (`src/tests/`) pins the full optics read as a golden contract, checks numpy↔torch parity, the mathematical invariants (étendue = φ_F·φ_T, exact decay-rate recovery, PSD autocovariance, axial-vs-directional concentration, the read-side filter's exact projection and idempotence), round-trips (tensor reconstruct, factor pack/unpack), determinism, and degenerate-input robustness.
|
|
407
|
+
|
|
408
|
+
## Formal certification
|
|
409
|
+
|
|
410
|
+
The governing lemmas of the theory ([`research/PAPER.pdf`](https://github.com/Agience/agience-entroptics/blob/main/research/PAPER.pdf)) are **machine-checked in Lean 4 / Mathlib** ([`research/lean/`](https://github.com/Agience/agience-entroptics/tree/main/research/lean), 30 theorems): the fill-fraction and Strehl bounds, positive-semidefiniteness of the biased autocovariance (peak-at-zero-lag OTF), the exact permutation-null mean of the coherence, the Weyl-certified attenuation interval, axial≠directional concentration, and exact decay-rate recovery + additive splicing. `lake build` compiles with **no `sorry`**, resting only on Mathlib's standard axioms.
|
|
411
|
+
|
|
412
|
+
## License
|
|
413
|
+
|
|
414
|
+
Apache 2.0 for the source code (copyright only). Patent rights are reserved, see [`LICENSE.md`](https://github.com/Agience/agience-entroptics/blob/main/LICENSE.md), [`PATENTS.md`](https://github.com/Agience/agience-entroptics/blob/main/PATENTS.md), and [`PLEDGE.md`](https://github.com/Agience/agience-entroptics/blob/main/PLEDGE.md). You are free to read, run, validate, reproduce, cite, and build research on this code and its proofs.
|
|
415
|
+
|
|
416
|
+
## Star history
|
|
417
|
+
|
|
418
|
+
[](https://star-history.com/#Agience/agience-entroptics&Date)
|