phoxla 0.1.0a0__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.
phoxla-0.1.0a0/LICENSE ADDED
@@ -0,0 +1,173 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+
135
+ 6. Trademarks. This License does not grant permission to use the trade
136
+ names, trademarks, service marks, or product names of the Licensor,
137
+ except as required for reasonable and customary use in describing the
138
+ origin of the Work and reproducing the content of the NOTICE file.
139
+
140
+ 7. Disclaimer of Warranty. Unless required by applicable law or
141
+ agreed to in writing, Licensor provides the Work (and each
142
+ Contributor provides its Contributions) on an "AS IS" BASIS,
143
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
144
+ implied, including, without limitation, any warranties or conditions
145
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
146
+ PARTICULAR PURPOSE. You are solely responsible for determining the
147
+ appropriateness of using or redistributing the Work and assume any
148
+ risks associated with Your exercise of permissions under this License.
149
+
150
+ 8. Limitation of Liability. In no event and under no legal theory,
151
+ whether in tort (including negligence), contract, or otherwise,
152
+ unless required by applicable law (such as deliberate and grossly
153
+ negligent acts) or agreed to in writing, shall any Contributor be
154
+ liable to You for damages, including any direct, indirect, special,
155
+ incidental, or consequential damages of any character arising as a
156
+ result of this License or out of the use or inability to use the
157
+ Work (including but not limited to damages for loss of goodwill,
158
+ work stoppage, computer failure or malfunction, or any and all
159
+ other commercial damages or losses), even if such Contributor
160
+ has been advised of the possibility of such damages.
161
+
162
+ 9. Accepting Warranty or Additional Liability. While redistributing
163
+ the Work or Derivative Works thereof, You may choose to offer,
164
+ and charge a fee for, acceptance of support, warranty, indemnity,
165
+ or other liability obligations and/or rights consistent with this
166
+ License. However, in accepting such obligations, You may act only
167
+ on Your own behalf and on Your sole responsibility, not on behalf
168
+ of any other Contributor, and only if You agree to indemnify,
169
+ defend, and hold each Contributor harmless for any liability
170
+ incurred by, or claims asserted against, such Contributor by reason
171
+ of your accepting any such warranty or additional liability.
172
+
173
+ END OF TERMS AND CONDITIONS
@@ -0,0 +1,63 @@
1
+ Metadata-Version: 2.4
2
+ Name: phoxla
3
+ Version: 0.1.0a0
4
+ Summary: Differentiable photonic design and simulation on XLA accelerators
5
+ Author: PHOXLA Maintainers
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/yspkm/phoxla
8
+ Project-URL: Repository, https://github.com/yspkm/phoxla
9
+ Project-URL: Issues, https://github.com/yspkm/phoxla/issues
10
+ Keywords: photonics,jax,flax,xla,inverse-design,differentiable-simulation
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Topic :: Scientific/Engineering
16
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
17
+ Requires-Python: >=3.11
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ Dynamic: license-file
21
+
22
+ # PHOXLA
23
+
24
+ > PHOXLA ("FOX-luh") - Differentiable photonic design and simulation on XLA accelerators.
25
+
26
+ PHOXLA is a framework blueprint for building modern photonic inverse-design systems with JAX/Flax.
27
+ The goal is to treat differentiable physics as a first-class deep learning component, so photonic simulation modules can be plugged into end-to-end trainable workflows.
28
+
29
+ ## Vision
30
+
31
+ - XLA-native photonic simulation and optimization (GPU/TPU first, CPU compatible)
32
+ - Differentiable physics modules usable as model layers/loss terms
33
+ - Inverse design pipelines integrated with standard deep learning tooling
34
+ - Extensible interoperability with JAX-based solvers (including FDTDX-style workflows)
35
+
36
+ ## Current Status
37
+
38
+ This repository is an initial blueprint and governance scaffold.
39
+ Core simulation and training modules will be added incrementally.
40
+
41
+ ## Planned Package Layout
42
+
43
+ - `src/phoxla/sim`: differentiable photonic simulation core
44
+ - `src/phoxla/nn`: NN-facing modules and differentiable operators
45
+ - `src/phoxla/inv`: inverse design workflows and optimizers
46
+ - `src/phoxla/integrations/fdtdx`: interoperability layer
47
+
48
+ ## Repository Bootstrap
49
+
50
+ See:
51
+
52
+ - `docs/REPO_LAUNCH_GUIDE.md`
53
+ - `docs/REPO_ABOUT_AND_TOPICS.md`
54
+ - `docs/PACKAGE_NAMESPACE_PLAN.md`
55
+ - `docs/PYPI_CLAIM_PLAYBOOK.md`
56
+ - `docs/NAMESPACE_PRIORITY.md`
57
+ - `docs/ARCHITECTURE_BLUEPRINT.md`
58
+ - `docs/COMMIT_MESSAGE_GUIDE.md`
59
+ - `ROADMAP.md`
60
+
61
+ ## License
62
+
63
+ Apache-2.0 (`LICENSE`)
@@ -0,0 +1,42 @@
1
+ # PHOXLA
2
+
3
+ > PHOXLA ("FOX-luh") - Differentiable photonic design and simulation on XLA accelerators.
4
+
5
+ PHOXLA is a framework blueprint for building modern photonic inverse-design systems with JAX/Flax.
6
+ The goal is to treat differentiable physics as a first-class deep learning component, so photonic simulation modules can be plugged into end-to-end trainable workflows.
7
+
8
+ ## Vision
9
+
10
+ - XLA-native photonic simulation and optimization (GPU/TPU first, CPU compatible)
11
+ - Differentiable physics modules usable as model layers/loss terms
12
+ - Inverse design pipelines integrated with standard deep learning tooling
13
+ - Extensible interoperability with JAX-based solvers (including FDTDX-style workflows)
14
+
15
+ ## Current Status
16
+
17
+ This repository is an initial blueprint and governance scaffold.
18
+ Core simulation and training modules will be added incrementally.
19
+
20
+ ## Planned Package Layout
21
+
22
+ - `src/phoxla/sim`: differentiable photonic simulation core
23
+ - `src/phoxla/nn`: NN-facing modules and differentiable operators
24
+ - `src/phoxla/inv`: inverse design workflows and optimizers
25
+ - `src/phoxla/integrations/fdtdx`: interoperability layer
26
+
27
+ ## Repository Bootstrap
28
+
29
+ See:
30
+
31
+ - `docs/REPO_LAUNCH_GUIDE.md`
32
+ - `docs/REPO_ABOUT_AND_TOPICS.md`
33
+ - `docs/PACKAGE_NAMESPACE_PLAN.md`
34
+ - `docs/PYPI_CLAIM_PLAYBOOK.md`
35
+ - `docs/NAMESPACE_PRIORITY.md`
36
+ - `docs/ARCHITECTURE_BLUEPRINT.md`
37
+ - `docs/COMMIT_MESSAGE_GUIDE.md`
38
+ - `ROADMAP.md`
39
+
40
+ ## License
41
+
42
+ Apache-2.0 (`LICENSE`)
@@ -0,0 +1,35 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "phoxla"
7
+ version = "0.1.0a0"
8
+ description = "Differentiable photonic design and simulation on XLA accelerators"
9
+ readme = "README.md"
10
+ requires-python = ">=3.11"
11
+ license = "Apache-2.0"
12
+ authors = [
13
+ { name = "PHOXLA Maintainers" }
14
+ ]
15
+ keywords = ["photonics", "jax", "flax", "xla", "inverse-design", "differentiable-simulation"]
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Science/Research",
19
+ "Programming Language :: Python :: 3",
20
+ "Programming Language :: Python :: 3.11",
21
+ "Topic :: Scientific/Engineering",
22
+ "Topic :: Scientific/Engineering :: Artificial Intelligence"
23
+ ]
24
+ dependencies = []
25
+
26
+ [project.urls]
27
+ Homepage = "https://github.com/yspkm/phoxla"
28
+ Repository = "https://github.com/yspkm/phoxla"
29
+ Issues = "https://github.com/yspkm/phoxla/issues"
30
+
31
+ [tool.setuptools]
32
+ package-dir = {"" = "src"}
33
+
34
+ [tool.setuptools.packages.find]
35
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,4 @@
1
+ """PHOXLA package root."""
2
+
3
+ __all__ = ["__version__"]
4
+ __version__ = "0.1.0a0"
@@ -0,0 +1,63 @@
1
+ Metadata-Version: 2.4
2
+ Name: phoxla
3
+ Version: 0.1.0a0
4
+ Summary: Differentiable photonic design and simulation on XLA accelerators
5
+ Author: PHOXLA Maintainers
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/yspkm/phoxla
8
+ Project-URL: Repository, https://github.com/yspkm/phoxla
9
+ Project-URL: Issues, https://github.com/yspkm/phoxla/issues
10
+ Keywords: photonics,jax,flax,xla,inverse-design,differentiable-simulation
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Topic :: Scientific/Engineering
16
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
17
+ Requires-Python: >=3.11
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ Dynamic: license-file
21
+
22
+ # PHOXLA
23
+
24
+ > PHOXLA ("FOX-luh") - Differentiable photonic design and simulation on XLA accelerators.
25
+
26
+ PHOXLA is a framework blueprint for building modern photonic inverse-design systems with JAX/Flax.
27
+ The goal is to treat differentiable physics as a first-class deep learning component, so photonic simulation modules can be plugged into end-to-end trainable workflows.
28
+
29
+ ## Vision
30
+
31
+ - XLA-native photonic simulation and optimization (GPU/TPU first, CPU compatible)
32
+ - Differentiable physics modules usable as model layers/loss terms
33
+ - Inverse design pipelines integrated with standard deep learning tooling
34
+ - Extensible interoperability with JAX-based solvers (including FDTDX-style workflows)
35
+
36
+ ## Current Status
37
+
38
+ This repository is an initial blueprint and governance scaffold.
39
+ Core simulation and training modules will be added incrementally.
40
+
41
+ ## Planned Package Layout
42
+
43
+ - `src/phoxla/sim`: differentiable photonic simulation core
44
+ - `src/phoxla/nn`: NN-facing modules and differentiable operators
45
+ - `src/phoxla/inv`: inverse design workflows and optimizers
46
+ - `src/phoxla/integrations/fdtdx`: interoperability layer
47
+
48
+ ## Repository Bootstrap
49
+
50
+ See:
51
+
52
+ - `docs/REPO_LAUNCH_GUIDE.md`
53
+ - `docs/REPO_ABOUT_AND_TOPICS.md`
54
+ - `docs/PACKAGE_NAMESPACE_PLAN.md`
55
+ - `docs/PYPI_CLAIM_PLAYBOOK.md`
56
+ - `docs/NAMESPACE_PRIORITY.md`
57
+ - `docs/ARCHITECTURE_BLUEPRINT.md`
58
+ - `docs/COMMIT_MESSAGE_GUIDE.md`
59
+ - `ROADMAP.md`
60
+
61
+ ## License
62
+
63
+ Apache-2.0 (`LICENSE`)
@@ -0,0 +1,8 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/phoxla/__init__.py
5
+ src/phoxla.egg-info/PKG-INFO
6
+ src/phoxla.egg-info/SOURCES.txt
7
+ src/phoxla.egg-info/dependency_links.txt
8
+ src/phoxla.egg-info/top_level.txt
@@ -0,0 +1 @@
1
+ phoxla