yani 0.4.0__tar.gz

yani-0.4.0/.gitignore

@@ -0,0 +1,3 @@
+dist/
+site/
+__pycache__/

yani-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jonathan Shimwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yani-0.4.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: yani
+Version: 0.4.0
+Summary: Yet Another Nuclide Inventory: transmutation and activation without transport
+Project-URL: Homepage, https://github.com/fusion-neutronics/yani
+Project-URL: Documentation, https://fusion-neutronics.github.io/yani/
+Project-URL: Repository, https://github.com/fusion-neutronics/yani
+Project-URL: Issues, https://github.com/fusion-neutronics/yani/issues
+License-Expression: MIT
+License-File: LICENSE
+Keywords: activation,fusion,inventory,neutronics,nuclear,transmutation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Requires-Dist: yani-core==0.4.0
+Description-Content-Type: text/markdown
+
+# yani
+
+**Y**et **A**nother **N**uclide **I**nventory: transmutation and activation
+without transport. A material, an irradiation schedule and a neutron spectrum
+in; inventories, activities, decay heat and decay photon spectra out. No
+geometry, no transport, no Monte Carlo.
+
+[Documentation](https://fusion-neutronics.github.io/yani/) |
+[PyPI](https://pypi.org/project/yani/)
+
+```bash
+pip install yani
+```
+
+```python
+import yani
+
+yani.cross_section_data = "endf-b8.1"
+chain = "transmutation-endf-b8.1-sfr.arrow"
+yani.transmutation_decay_data = chain
+yani.transmutation_reactions = chain
+yani.transmutation_fission_yields = chain
+
+steel = yani.materials.pnnl.material("Steel, Stainless 316", volume=1000.0)
+spectrum = yani.NeutronSource(
+    energy=yani.sources.Histogram([1e-5, 1e5, 1e6, 1.5e7], [1e12, 1e13, 1e14])
+)
+schedule = yani.PulseSchedule([
+    yani.Pulse(rate=1.11e14, duration=(1, "a"), source=spectrum),
+    yani.Cooldown(duration=(1, "d")),
+])
+
+final = steel.transmute(schedule=schedule)[-1]
+print(final.activity(), "Bq")
+print(final.decay_heat(), "W")
+```
+
+## What it solves
+
+The nuclide inventory under irradiation is the Bateman equations with reaction
+terms, `dN/dt = A N`, solved as a matrix exponential `N(t) = exp(A t) N(0)` by
+CRAM at order 48. The solver is Rust; the wheel needs no compiler and no
+external toolchain.
+
+## What this repository contains
+
+Documentation, packaging and release automation. The code lives in the
+`yani-core` wheel this package depends on, which provides the `yani` module
+itself, its type stubs and its docstrings. `pip install yani` pulls it in.
+
+That arrangement is why there is no Python here: one source of truth for the
+API, and no re-export layer that can drift from it.
+
+## Relationship to yamc
+
+[yamc](https://github.com/fusion-neutronics/yamc) is a superset: everything here
+plus neutron and photon transport, geometry, tallies and transport-coupled
+transmutation. The two are **alternatives, not companions**. Installing both
+puts two extension modules in one process, so `yamc.Material` and
+`yani.Material` are distinct types and the nuclear-data configuration exists
+twice.
+
+Pick yani when you already have a spectrum. Pick yamc when the spectrum should
+come from a transport solve.
+
+## License
+
+MIT.

yani-0.4.0/README.md

@@ -0,0 +1,68 @@
+# yani
+
+**Y**et **A**nother **N**uclide **I**nventory: transmutation and activation
+without transport. A material, an irradiation schedule and a neutron spectrum
+in; inventories, activities, decay heat and decay photon spectra out. No
+geometry, no transport, no Monte Carlo.
+
+[Documentation](https://fusion-neutronics.github.io/yani/) |
+[PyPI](https://pypi.org/project/yani/)
+
+```bash
+pip install yani
+```
+
+```python
+import yani
+
+yani.cross_section_data = "endf-b8.1"
+chain = "transmutation-endf-b8.1-sfr.arrow"
+yani.transmutation_decay_data = chain
+yani.transmutation_reactions = chain
+yani.transmutation_fission_yields = chain
+
+steel = yani.materials.pnnl.material("Steel, Stainless 316", volume=1000.0)
+spectrum = yani.NeutronSource(
+    energy=yani.sources.Histogram([1e-5, 1e5, 1e6, 1.5e7], [1e12, 1e13, 1e14])
+)
+schedule = yani.PulseSchedule([
+    yani.Pulse(rate=1.11e14, duration=(1, "a"), source=spectrum),
+    yani.Cooldown(duration=(1, "d")),
+])
+
+final = steel.transmute(schedule=schedule)[-1]
+print(final.activity(), "Bq")
+print(final.decay_heat(), "W")
+```
+
+## What it solves
+
+The nuclide inventory under irradiation is the Bateman equations with reaction
+terms, `dN/dt = A N`, solved as a matrix exponential `N(t) = exp(A t) N(0)` by
+CRAM at order 48. The solver is Rust; the wheel needs no compiler and no
+external toolchain.
+
+## What this repository contains
+
+Documentation, packaging and release automation. The code lives in the
+`yani-core` wheel this package depends on, which provides the `yani` module
+itself, its type stubs and its docstrings. `pip install yani` pulls it in.
+
+That arrangement is why there is no Python here: one source of truth for the
+API, and no re-export layer that can drift from it.
+
+## Relationship to yamc
+
+[yamc](https://github.com/fusion-neutronics/yamc) is a superset: everything here
+plus neutron and photon transport, geometry, tallies and transport-coupled
+transmutation. The two are **alternatives, not companions**. Installing both
+puts two extension modules in one process, so `yamc.Material` and
+`yani.Material` are distinct types and the nuclear-data configuration exists
+twice.
+
+Pick yani when you already have a spectrum. Pick yamc when the spectrum should
+come from a transport solve.
+
+## License
+
+MIT.

yani-0.4.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "yani"
+# Kept in lockstep with yani-core: CI rewrites both this and the pin below from
+# the release tag, and refuses to publish if that version is not on PyPI yet.
+version = "0.4.0"
+description = "Yet Another Nuclide Inventory: transmutation and activation without transport"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["nuclear", "transmutation", "activation", "inventory", "fusion", "neutronics"]
+classifiers = [
+    "Programming Language :: Rust",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+
+# The whole distribution. `yani-core` is the compiled wheel and it provides the
+# `yani` module itself, so this package deliberately ships no code: nothing to
+# re-export, nothing to keep in sync, and no second copy of the type stubs.
+# (`pip install pillow` giving `import PIL` is the same arrangement inverted.)
+#
+# The pin is exact. A range would let `pip install yani==0.4.0` resolve to a
+# core wheel whose API does not match the docs published for 0.4.0.
+dependencies = ["yani-core==0.4.0"]
+
+[project.urls]
+Homepage = "https://github.com/fusion-neutronics/yani"
+Documentation = "https://fusion-neutronics.github.io/yani/"
+Repository = "https://github.com/fusion-neutronics/yani"
+Issues = "https://github.com/fusion-neutronics/yani/issues"
+
+# Hatchling expects to find a package to build; there is none, and that is the
+# point. Declaring an empty file set makes the metadata-only wheel explicit
+# rather than a build error.
+[tool.hatch.build.targets.wheel]
+bypass-selection = true
+
+[tool.hatch.build.targets.sdist]
+include = ["README.md", "LICENSE", "pyproject.toml"]