vacspin 0.1.0__tar.gz

vacspin-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vacspin-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: vacspin
+Version: 0.1.0
+Summary: Group-IV colour-centre spin-photon interfaces: strained spin Hamiltonians, cyclicity, transition-resolved Purcell budgets and exact single-shot readout statistics
+Author: Tanvir Mahmud Mahim
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TaN-MM-Org/vacspin
+Project-URL: Issues, https://github.com/TaN-MM-Org/vacspin/issues
+Project-URL: Changelog, https://github.com/TaN-MM-Org/vacspin/blob/main/CHANGELOG.md
+Keywords: quantum,color-center,SnV,SiV,diamond,cavity-QED,Purcell,spin-photon-interface,single-shot-readout
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.22
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Dynamic: license-file
+
+# vacspin
+
+[![tests](https://github.com/TaN-MM-Org/vacspin/actions/workflows/ci.yml/badge.svg)](https://github.com/TaN-MM-Org/vacspin/actions)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+How well can a single trapped spin in diamond talk to light? A
+vacancy colour centre (SiV-, GeV-, SnV-, PbV-) holds one electron
+spin whose optical transitions depend on strain, magnetic field and
+the cavity around it -- and every quantum-network number you care
+about (how many photons before the spin flips, how fast you can read
+it out, how often two nodes entangle) follows from that chain.
+`vacspin` computes the whole chain: the spin Hamiltonian, the optical
+transitions and their cyclicity, the cavity Purcell budget, the exact
+single-shot readout statistics, and the remote-entanglement rate --
+with every physics claim pinned in the test suite to a closed form, a
+published measurement, or two independent code paths.
+
+## Install
+
+```
+pip install vacspin        # NumPy only
+```
+
+For development: clone the repository and `pip install -e .[test]`.
+
+## The chain in one example
+
+```python
+import vacspin as vs
+
+spin = vs.snv_rosenthal2023()                  # cited SnV- parameters
+b = vs.field_on_circle(147.0, 0.125)           # 125 mT at 147 degrees
+f_q = vs.qubit_frequency(spin, b)              # -> 3.64 GHz (measured 3.677)
+
+ci = vs.CavityInterface(
+    q_loaded=500, v_rel=0.68, eta_wg=0.9996,   # your cavity
+    budget=vs.snv_emission(),                  # cited emission budget
+    lambda0=2244.0,                            # measured cyclicity
+    omega_q_hz=f_q * 1e9,
+    xi_pol=vs.xi_pol_overlap(), xi_pos=0.5,
+    t_link=0.99, eta_chip=0.8, eta_det=0.9).require_valid()
+
+out = vs.fidelity(ci.eta, ci.lambda_cav, ci.gamma_cav, tau=50e-9, s=2.0)
+print(ci.f_c, ci.eta, out["fidelity"])         # Purcell ~19, eta ~0.65
+```
+
+`require_valid()` is not decoration: the Purcell formulas assume the
+bad-cavity, weak-coupling, spin-selective regime, and the interface
+refuses -- naming the failed condition -- rather than extrapolating
+outside it.
+
+## What is inside
+
+- **The spin Hamiltonian** (`h_manifold`, `solve`,
+  `qubit_frequency`): the effective Hamiltonian all group-IV centres
+  share (spin-orbit + strain + Zeeman; Rosenthal et al., PRX 13,
+  031022 (2023)), in pure NumPy, with the exact frame rotation from
+  your lab coordinates, the closed-form zero-field splitting, a
+  strain-tuning axis, and the perturbative transverse-field formula
+  held against full diagonalisation.
+- **Transitions and cyclicity** (`transition_table`, `cyclicity`,
+  `rabi_rate`): all sixteen optical transitions with their strengths
+  (which obey an exact sum rule the tests assert), the cyclicity that
+  decides how many photons a spin emits before it flips -- including
+  its exact divergence when the field is aligned with the symmetry
+  axis -- and microwave Rabi rates.
+- **The cavity budget** (`CavityInterface`, `purcell_max`): the
+  transition-resolved Purcell factor, the lifetime-reduction factor,
+  the fraction of decays that reach your detector through the full
+  chain (cavity mode, out-coupling port, link, chip, detector), the
+  cavity-boosted cyclicity (the cavity enhances only the
+  spin-conserving line; its partner is detuned by the qubit
+  frequency), and the coupling rate g with
+  F = 4 g^2 / (kappa gamma) holding as an exact identity.
+- **Single-shot readout** (`fidelity`, `required_efficiency`,
+  `required_window`): exact counting statistics -- the bright record
+  is a Poisson photon stream terminated by the spin flip, evaluated
+  in closed form, no numerical quadrature -- with background counts,
+  off-resonant scattering of the dark spin, and the dark-state
+  switch-on channel, at the optimal integer threshold. The inverse
+  tools answer the questions an experiment actually asks (what
+  efficiency, how long a window) and refuse when the target is
+  unreachable, naming the best achievable value.
+- **Remote entanglement** (`barrett_kok_success`,
+  `entanglement_rate`): the two-photon heralding budget, with its
+  intrinsic factor 1/2 stated as a ceiling no detector removes.
+
+## Cited parameters
+
+No physical number is made up, and none is accepted without a source
+-- the `reference` field of both parameter dataclasses is mandatory.
+
+- `snv_rosenthal2023()` + `snv_emission()`: the SnV- device values of
+  Rosenthal et al., PRX 13, 031022 (2023) with the Thiering-Gali
+  quenching factors, and the emission budget of arXiv:2403.13110 /
+  Goerlitz et al. / Lee et al. (arXiv:2511.05740). Validated against
+  measurement in the tests with no free parameters: the 902.98 GHz
+  splitting, the 3.677 GHz qubit frequency, the cyclicity landscape
+  (2244 near alignment, 8.6 at 53 degrees), the MHz Rabi scale.
+- `siv_hepp2014()`: the unstrained SiV- splittings (50 and 260 GHz)
+  of Hepp et al., PRL 112, 036405 (2014). Strain and orbital
+  quenching are sample-specific and deliberately not shipped; the
+  reference string says so.
+
+For GeV-, PbV-, or your own sample, populate `SpinParameters` and
+`EmissionBudget` from your measurements or the literature; the
+provenance travels with every prediction.
+
+## How it is checked
+
+46 tests (Python 3.9-3.13, run in CI on every push), every claim
+anchored to an exact result, a published measurement, or two
+independent code paths -- never a stored number. Highlights: exact
+Kramers doublets and the closed-form splitting against full
+diagonalisation; the measured SnV- landscape reproduced with no free
+parameters; the exact aligned-field cyclicity divergence; the dipole
+sum rule (total strength exactly 3 per ground state) as an identity;
+the Purcell relation F = 4 g^2/(kappa gamma) as an exact round trip;
+exact Lorentzian and polarisation-overlap limits; the photon budget
+bounded and monotone; the bright-count distribution hitting its
+Poisson and geometric limits at machine precision (the closed-form
+recurrence makes them exact, not approximate); the measured confocal
+operating point (about 4 detected photons at 0.2% efficiency)
+reproduced; the source study's design point (Purcell factor ~19,
+end-to-end efficiency ~0.65, >98% fidelity at the optimal window,
+a >100x speedup over confocal readout) recovered end to end from its
+stated inputs; and inverse-tool round trips and refusals throughout.
+
+## Honest limits
+
+Deliberate scope, designed out with reasons: no photonic device
+design (cavity Q, mode volume and taper transfer are inputs you
+simulate or measure -- the companion study's pipeline shows how);
+the readout model is the two-level bad-cavity treatment, and
+`require_valid()` refuses the strong-coupling regime rather than
+mis-describing it; spin coherence times (T1, T2) are
+sample-dependent measurements, not shipped constants; and the
+switch-on dark channel is treated by a union bound, so the reported
+fidelity is the conservative side of the exact answer.
+
+## Associated study
+
+> T. M. Mahim, M. M. Rahman and A. S. M. Mohsin, "Fast single-shot
+> readout of tin-vacancy spins with an overcoupled diamond nanocavity
+> on thin-film lithium niobate" (submitted to Optics Express, 2026);
+> pipeline: https://github.com/Tanvir-Mahmud-Mahim/snv-tfln-cavity-interface
+
+This package is the general-purpose engine; the paper repository
+holds the device design (FEM/EME/GME photonics) and reproduces the
+specific study. Formalism: Rosenthal et al., PRX 13, 031022 (2023)
+and arXiv:2403.13110; transition-resolved cavity conventions: Lee et
+al., arXiv:2511.05740; heralding: Barrett and Kok, PRA 71, 060310(R)
+(2005).
+
+## Support and governance
+
+Written and maintained by Tanvir Mahmud Mahim (Department of
+Electrical and Electronic Engineering, BRAC University), who reviews
+every change and takes the final decision on scope and releases.
+Design questions are discussed in the open in issues and pull
+requests, and the standing rule of
+[CONTRIBUTING.md](CONTRIBUTING.md) binds the maintainer exactly as it
+binds contributors: a change that touches physics arrives with a
+test, and a constant arrives with its source.
+
+Support runs through the
+[issue tracker](https://github.com/TaN-MM-Org/vacspin/issues). Usage
+questions are welcome alongside bug reports; a docstring that left a
+unit or a sign convention unclear is treated as a documentation bug,
+not user error. While the version is below 1.0 the API may still move
+between minor versions; such changes are called out in the release
+notes.
+
+## License
+
+Apache-2.0.

vacspin-0.1.0/README.md

@@ -0,0 +1,176 @@
+# vacspin
+
+[![tests](https://github.com/TaN-MM-Org/vacspin/actions/workflows/ci.yml/badge.svg)](https://github.com/TaN-MM-Org/vacspin/actions)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+How well can a single trapped spin in diamond talk to light? A
+vacancy colour centre (SiV-, GeV-, SnV-, PbV-) holds one electron
+spin whose optical transitions depend on strain, magnetic field and
+the cavity around it -- and every quantum-network number you care
+about (how many photons before the spin flips, how fast you can read
+it out, how often two nodes entangle) follows from that chain.
+`vacspin` computes the whole chain: the spin Hamiltonian, the optical
+transitions and their cyclicity, the cavity Purcell budget, the exact
+single-shot readout statistics, and the remote-entanglement rate --
+with every physics claim pinned in the test suite to a closed form, a
+published measurement, or two independent code paths.
+
+## Install
+
+```
+pip install vacspin        # NumPy only
+```
+
+For development: clone the repository and `pip install -e .[test]`.
+
+## The chain in one example
+
+```python
+import vacspin as vs
+
+spin = vs.snv_rosenthal2023()                  # cited SnV- parameters
+b = vs.field_on_circle(147.0, 0.125)           # 125 mT at 147 degrees
+f_q = vs.qubit_frequency(spin, b)              # -> 3.64 GHz (measured 3.677)
+
+ci = vs.CavityInterface(
+    q_loaded=500, v_rel=0.68, eta_wg=0.9996,   # your cavity
+    budget=vs.snv_emission(),                  # cited emission budget
+    lambda0=2244.0,                            # measured cyclicity
+    omega_q_hz=f_q * 1e9,
+    xi_pol=vs.xi_pol_overlap(), xi_pos=0.5,
+    t_link=0.99, eta_chip=0.8, eta_det=0.9).require_valid()
+
+out = vs.fidelity(ci.eta, ci.lambda_cav, ci.gamma_cav, tau=50e-9, s=2.0)
+print(ci.f_c, ci.eta, out["fidelity"])         # Purcell ~19, eta ~0.65
+```
+
+`require_valid()` is not decoration: the Purcell formulas assume the
+bad-cavity, weak-coupling, spin-selective regime, and the interface
+refuses -- naming the failed condition -- rather than extrapolating
+outside it.
+
+## What is inside
+
+- **The spin Hamiltonian** (`h_manifold`, `solve`,
+  `qubit_frequency`): the effective Hamiltonian all group-IV centres
+  share (spin-orbit + strain + Zeeman; Rosenthal et al., PRX 13,
+  031022 (2023)), in pure NumPy, with the exact frame rotation from
+  your lab coordinates, the closed-form zero-field splitting, a
+  strain-tuning axis, and the perturbative transverse-field formula
+  held against full diagonalisation.
+- **Transitions and cyclicity** (`transition_table`, `cyclicity`,
+  `rabi_rate`): all sixteen optical transitions with their strengths
+  (which obey an exact sum rule the tests assert), the cyclicity that
+  decides how many photons a spin emits before it flips -- including
+  its exact divergence when the field is aligned with the symmetry
+  axis -- and microwave Rabi rates.
+- **The cavity budget** (`CavityInterface`, `purcell_max`): the
+  transition-resolved Purcell factor, the lifetime-reduction factor,
+  the fraction of decays that reach your detector through the full
+  chain (cavity mode, out-coupling port, link, chip, detector), the
+  cavity-boosted cyclicity (the cavity enhances only the
+  spin-conserving line; its partner is detuned by the qubit
+  frequency), and the coupling rate g with
+  F = 4 g^2 / (kappa gamma) holding as an exact identity.
+- **Single-shot readout** (`fidelity`, `required_efficiency`,
+  `required_window`): exact counting statistics -- the bright record
+  is a Poisson photon stream terminated by the spin flip, evaluated
+  in closed form, no numerical quadrature -- with background counts,
+  off-resonant scattering of the dark spin, and the dark-state
+  switch-on channel, at the optimal integer threshold. The inverse
+  tools answer the questions an experiment actually asks (what
+  efficiency, how long a window) and refuse when the target is
+  unreachable, naming the best achievable value.
+- **Remote entanglement** (`barrett_kok_success`,
+  `entanglement_rate`): the two-photon heralding budget, with its
+  intrinsic factor 1/2 stated as a ceiling no detector removes.
+
+## Cited parameters
+
+No physical number is made up, and none is accepted without a source
+-- the `reference` field of both parameter dataclasses is mandatory.
+
+- `snv_rosenthal2023()` + `snv_emission()`: the SnV- device values of
+  Rosenthal et al., PRX 13, 031022 (2023) with the Thiering-Gali
+  quenching factors, and the emission budget of arXiv:2403.13110 /
+  Goerlitz et al. / Lee et al. (arXiv:2511.05740). Validated against
+  measurement in the tests with no free parameters: the 902.98 GHz
+  splitting, the 3.677 GHz qubit frequency, the cyclicity landscape
+  (2244 near alignment, 8.6 at 53 degrees), the MHz Rabi scale.
+- `siv_hepp2014()`: the unstrained SiV- splittings (50 and 260 GHz)
+  of Hepp et al., PRL 112, 036405 (2014). Strain and orbital
+  quenching are sample-specific and deliberately not shipped; the
+  reference string says so.
+
+For GeV-, PbV-, or your own sample, populate `SpinParameters` and
+`EmissionBudget` from your measurements or the literature; the
+provenance travels with every prediction.
+
+## How it is checked
+
+46 tests (Python 3.9-3.13, run in CI on every push), every claim
+anchored to an exact result, a published measurement, or two
+independent code paths -- never a stored number. Highlights: exact
+Kramers doublets and the closed-form splitting against full
+diagonalisation; the measured SnV- landscape reproduced with no free
+parameters; the exact aligned-field cyclicity divergence; the dipole
+sum rule (total strength exactly 3 per ground state) as an identity;
+the Purcell relation F = 4 g^2/(kappa gamma) as an exact round trip;
+exact Lorentzian and polarisation-overlap limits; the photon budget
+bounded and monotone; the bright-count distribution hitting its
+Poisson and geometric limits at machine precision (the closed-form
+recurrence makes them exact, not approximate); the measured confocal
+operating point (about 4 detected photons at 0.2% efficiency)
+reproduced; the source study's design point (Purcell factor ~19,
+end-to-end efficiency ~0.65, >98% fidelity at the optimal window,
+a >100x speedup over confocal readout) recovered end to end from its
+stated inputs; and inverse-tool round trips and refusals throughout.
+
+## Honest limits
+
+Deliberate scope, designed out with reasons: no photonic device
+design (cavity Q, mode volume and taper transfer are inputs you
+simulate or measure -- the companion study's pipeline shows how);
+the readout model is the two-level bad-cavity treatment, and
+`require_valid()` refuses the strong-coupling regime rather than
+mis-describing it; spin coherence times (T1, T2) are
+sample-dependent measurements, not shipped constants; and the
+switch-on dark channel is treated by a union bound, so the reported
+fidelity is the conservative side of the exact answer.
+
+## Associated study
+
+> T. M. Mahim, M. M. Rahman and A. S. M. Mohsin, "Fast single-shot
+> readout of tin-vacancy spins with an overcoupled diamond nanocavity
+> on thin-film lithium niobate" (submitted to Optics Express, 2026);
+> pipeline: https://github.com/Tanvir-Mahmud-Mahim/snv-tfln-cavity-interface
+
+This package is the general-purpose engine; the paper repository
+holds the device design (FEM/EME/GME photonics) and reproduces the
+specific study. Formalism: Rosenthal et al., PRX 13, 031022 (2023)
+and arXiv:2403.13110; transition-resolved cavity conventions: Lee et
+al., arXiv:2511.05740; heralding: Barrett and Kok, PRA 71, 060310(R)
+(2005).
+
+## Support and governance
+
+Written and maintained by Tanvir Mahmud Mahim (Department of
+Electrical and Electronic Engineering, BRAC University), who reviews
+every change and takes the final decision on scope and releases.
+Design questions are discussed in the open in issues and pull
+requests, and the standing rule of
+[CONTRIBUTING.md](CONTRIBUTING.md) binds the maintainer exactly as it
+binds contributors: a change that touches physics arrives with a
+test, and a constant arrives with its source.
+
+Support runs through the
+[issue tracker](https://github.com/TaN-MM-Org/vacspin/issues). Usage
+questions are welcome alongside bug reports; a docstring that left a
+unit or a sign convention unclear is treated as a documentation bug,
+not user error. While the version is below 1.0 the API may still move
+between minor versions; such changes are called out in the release
+notes.
+
+## License
+
+Apache-2.0.

vacspin-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vacspin"
+version = "0.1.0"
+description = "Group-IV colour-centre spin-photon interfaces: strained spin Hamiltonians, cyclicity, transition-resolved Purcell budgets and exact single-shot readout statistics"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "Apache-2.0"}
+authors = [{name = "Tanvir Mahmud Mahim"}]
+keywords = ["quantum", "color-center", "SnV", "SiV", "diamond",
+            "cavity-QED", "Purcell", "spin-photon-interface",
+            "single-shot-readout"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Topic :: Scientific/Engineering :: Physics",
+]
+dependencies = ["numpy>=1.22"]
+
+[project.optional-dependencies]
+test = ["pytest>=7"]
+
+[project.urls]
+Homepage = "https://github.com/TaN-MM-Org/vacspin"
+Issues = "https://github.com/TaN-MM-Org/vacspin/issues"
+Changelog = "https://github.com/TaN-MM-Org/vacspin/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]

vacspin-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vacspin-0.1.0/src/vacspin/__init__.py

@@ -0,0 +1,47 @@
+"""vacspin: group-IV colour-centre spin-photon interfaces, end to end.
+
+From the strained spin Hamiltonian of a vacancy centre in diamond
+(SiV-, GeV-, SnV-, PbV-), through its optical transitions and
+cyclicity, the transition-resolved Purcell budget of a coupled
+cavity, to exact single-shot readout statistics and remote-
+entanglement rates -- with every physics claim in the test suite
+pinned to a closed form, a measured anchor, or two independent code
+paths.
+
+Methodological basis: T. M. Mahim, M. M. Rahman and A. S. M. Mohsin,
+"Fast single-shot readout of tin-vacancy spins with an overcoupled
+diamond nanocavity on thin-film lithium niobate" (submitted to Optics
+Express, 2026), and the effective-Hamiltonian and readout formalism of
+Rosenthal et al., PRX 13, 031022 (2023) and arXiv:2403.13110.
+"""
+from .params import (EmissionBudget, SpinParameters, siv_hepp2014,
+                     snv_emission, snv_rosenthal2023)
+from .hamiltonian import (GAMMA_GHZ_PER_T, h_manifold, lab_to_spin,
+                          qubit_frequency, qubit_frequency_perpendicular,
+                          solve, zero_field_splitting)
+from .transitions import (cyclicity, field_on_circle, rabi_rate,
+                          transition_strength, transition_table)
+from .cavity import (CavityInterface, lorentzian_suppression,
+                     purcell_max, xi_pol_overlap)
+from .readout import (fidelity, fidelity_threshold1, geometric_pmf,
+                      poisson_pmf, polarization_rate, readout_counts,
+                      required_efficiency, required_window)
+from .remote import barrett_kok_success, entanglement_rate
+
+__version__ = "0.1.0"
+__all__ = [
+    "SpinParameters", "EmissionBudget", "snv_rosenthal2023",
+    "snv_emission", "siv_hepp2014",
+    "GAMMA_GHZ_PER_T", "h_manifold", "lab_to_spin", "solve",
+    "zero_field_splitting", "qubit_frequency",
+    "qubit_frequency_perpendicular",
+    "transition_strength", "transition_table", "cyclicity", "rabi_rate",
+    "field_on_circle",
+    "purcell_max", "lorentzian_suppression", "xi_pol_overlap",
+    "CavityInterface",
+    "polarization_rate", "readout_counts", "fidelity_threshold1",
+    "geometric_pmf", "poisson_pmf", "fidelity", "required_efficiency",
+    "required_window",
+    "barrett_kok_success", "entanglement_rate",
+    "__version__",
+]