pathsim-fusion 0.1.0__tar.gz

pathsim_fusion-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # ruff version is read from the `lint` extra in pyproject.toml
+      - name: ruff check
+        uses: astral-sh/ruff-action@v3
+        with:
+          version-file: pyproject.toml
+          args: check
+
+      - name: ruff format
+        uses: astral-sh/ruff-action@v3
+        with:
+          version-file: pyproject.toml
+          args: format --check
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history so setuptools-scm can derive the version
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: pip install -e ".[test]" mypy
+
+      - name: mypy
+        run: mypy src/pathsim_fusion
+
+      - name: pytest
+        run: pytest tests/ -v --tb=short

pathsim_fusion-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write  # trusted publishing — no API token needed
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # full history so setuptools-scm derives the release version
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

pathsim_fusion-0.1.0/.gitignore

@@ -0,0 +1,85 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Notebooks (except documentation notebooks)
+*.ipynb
+!docs/**/*.ipynb
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.pypirc
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+test_reports/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# Environment
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Shell
+*.bat
+
+# IDEs
+.vscode/
+.idea/
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Claude
+.claude
+
+# setuptools-scm generated version file
+_version.py

pathsim_fusion-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 PathSim
+
+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.

pathsim_fusion-0.1.0/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: pathsim-fusion
+Version: 0.1.0
+Summary: Fusion fuel cycle and balance-of-plant blocks for PathSim
+Author: PathSim Contributors
+License: MIT
+Project-URL: Homepage, https://pathsim.org
+Project-URL: Documentation, https://docs.pathsim.org/fusion
+Project-URL: Repository, https://github.com/pathsim/pathsim-fusion
+Project-URL: Issues, https://github.com/pathsim/pathsim-fusion/issues
+Keywords: simulation,pathsim,block diagram,fusion,tritium,fuel cycle,balance of plant
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pathsim>=0.23
+Requires-Dist: numpy>=1.15
+Requires-Dist: scipy>=1.2
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff==0.17.3; extra == "lint"
+Dynamic: license-file
+
+<p align="center">
+  <strong>Fusion fuel cycle and balance-of-plant blocks for PathSim</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/pathsim-fusion/"><img src="https://img.shields.io/pypi/v/pathsim-fusion" alt="PyPI"></a>
+  <img src="https://img.shields.io/github/license/pathsim/pathsim-fusion" alt="License">
+</p>
+
+<p align="center">
+  <a href="https://pathsim.org">Homepage</a> &bull;
+  <a href="https://docs.pathsim.org/fusion">Documentation</a> &bull;
+  <a href="https://github.com/pathsim/pathsim-fusion">GitHub</a>
+</p>
+
+---
+
+PathSim-Fusion extends the [PathSim](https://github.com/pathsim/pathsim)
+simulation framework with specialized blocks. All blocks follow the standard
+PathSim block interface and can be connected into simulation diagrams.
+
+## Blocks
+
+| Block | Description | Key Parameters |
+|-------|-------------|----------------|
+| `IonisationChamber` | Flow-through tritium ionisation chamber (signal = ε(c)·c, flux passes through) | `detection_efficiency`, `detection_threshold` |
+| `Bubbler4` | Four-vial tritium sampling bubbler (soluble + insoluble chains, catalytic conversion, scheduled vial replacement) | `conversion_efficiency`, `vial_efficiency`, `replacement_times` |
+| `GLC` | Counter-current bubble-column gas–liquid contactor for tritium extraction from LiPb (Malara 1995, on `BVP1D`) | `P_in`, `L`, `D`, `T`, `BCs` |
+
+## Install
+
+```bash
+pip install pathsim-fusion
+```
+
+## Quick Example
+
+```python
+from pathsim import Simulation, Connection
+from pathsim.blocks import Constant, Source, Scope
+from pathsim_fusion import IonisationChamber
+
+flux = Source(lambda t: 1e-3 * float(t > 1))  # tritium flux, step at t = 1
+flow = Constant(0.5)  # carrier gas flow rate
+ic = IonisationChamber(detection_efficiency=0.9)
+sco = Scope(labels=["flux", "signal"])
+
+sim = Simulation(
+    blocks=[flux, flow, ic, sco],
+    connections=[
+        Connection(flux, ic["flux_in"], sco[0]),
+        Connection(flow, ic["flow_rate"]),
+        Connection(ic["signal"], sco[1]),
+    ],
+    dt=0.01,
+)
+sim.run(5)
+sco.plot()
+```
+
+## Development
+
+```bash
+pip install -e ".[test,lint]" mypy
+ruff check .                # lint
+ruff format .               # format
+mypy src/pathsim_fusion    # type check
+pytest tests/ -v            # run tests
+```
+
+## License
+
+MIT

pathsim_fusion-0.1.0/README.md

@@ -0,0 +1,73 @@
+<p align="center">
+  <strong>Fusion fuel cycle and balance-of-plant blocks for PathSim</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/pathsim-fusion/"><img src="https://img.shields.io/pypi/v/pathsim-fusion" alt="PyPI"></a>
+  <img src="https://img.shields.io/github/license/pathsim/pathsim-fusion" alt="License">
+</p>
+
+<p align="center">
+  <a href="https://pathsim.org">Homepage</a> &bull;
+  <a href="https://docs.pathsim.org/fusion">Documentation</a> &bull;
+  <a href="https://github.com/pathsim/pathsim-fusion">GitHub</a>
+</p>
+
+---
+
+PathSim-Fusion extends the [PathSim](https://github.com/pathsim/pathsim)
+simulation framework with specialized blocks. All blocks follow the standard
+PathSim block interface and can be connected into simulation diagrams.
+
+## Blocks
+
+| Block | Description | Key Parameters |
+|-------|-------------|----------------|
+| `IonisationChamber` | Flow-through tritium ionisation chamber (signal = ε(c)·c, flux passes through) | `detection_efficiency`, `detection_threshold` |
+| `Bubbler4` | Four-vial tritium sampling bubbler (soluble + insoluble chains, catalytic conversion, scheduled vial replacement) | `conversion_efficiency`, `vial_efficiency`, `replacement_times` |
+| `GLC` | Counter-current bubble-column gas–liquid contactor for tritium extraction from LiPb (Malara 1995, on `BVP1D`) | `P_in`, `L`, `D`, `T`, `BCs` |
+
+## Install
+
+```bash
+pip install pathsim-fusion
+```
+
+## Quick Example
+
+```python
+from pathsim import Simulation, Connection
+from pathsim.blocks import Constant, Source, Scope
+from pathsim_fusion import IonisationChamber
+
+flux = Source(lambda t: 1e-3 * float(t > 1))  # tritium flux, step at t = 1
+flow = Constant(0.5)  # carrier gas flow rate
+ic = IonisationChamber(detection_efficiency=0.9)
+sco = Scope(labels=["flux", "signal"])
+
+sim = Simulation(
+    blocks=[flux, flow, ic, sco],
+    connections=[
+        Connection(flux, ic["flux_in"], sco[0]),
+        Connection(flow, ic["flow_rate"]),
+        Connection(ic["signal"], sco[1]),
+    ],
+    dt=0.01,
+)
+sim.run(5)
+sco.plot()
+```
+
+## Development
+
+```bash
+pip install -e ".[test,lint]" mypy
+ruff check .                # lint
+ruff format .               # format
+mypy src/pathsim_fusion    # type check
+pytest tests/ -v            # run tests
+```
+
+## License
+
+MIT

pathsim_fusion-0.1.0/docs/source/examples/linear_feedback.ipynb

@@ -0,0 +1,213 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0",
+   "metadata": {},
+   "source": "# Linear Feedback System\n\nSimulation of a simple linear feedback system with step response.\n\nYou can also find this example as a single file in the [GitHub repository](https://github.com/milanofthe/pathsim/blob/master/examples/example_feedback.py)."
+  },
+  {
+   "cell_type": "raw",
+   "id": "1",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    ".. image:: figures/figures_g/linear_feedback_blockdiagram_g.png\n",
+    "   :width: 700\n",
+    "   :align: center\n",
+    "   :alt: block diagram of linear feedback system"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "id": "2",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "The block diagramm above can be translated to a netlist by using the blocks and the connection class provided by PathSim. First lets import the :class:`.Simulation` and :class:`.Connection` classes and the required blocks from the block library:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "# Apply PathSim docs matplotlib style for consistent, theme-friendly figures\n",
+    "plt.style.use(\"../pathsim_docs.mplstyle\")\n",
+    "\n",
+    "from pathsim import Connection, Simulation\n",
+    "from pathsim.blocks import Adder, Amplifier, Integrator, Scope, Source"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4",
+   "metadata": {},
+   "source": [
+    "Then lets define the system parameters such as the initial value `x0` of the integrator, the linear feedback gain `a` and the time dependend source function `s(t)`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# System parameters\n",
+    "a, x0 = -1, 2\n",
+    "\n",
+    "# Delay for step function\n",
+    "tau = 3\n",
+    "\n",
+    "\n",
+    "# Step function\n",
+    "def s(t):\n",
+    "    return int(t > tau)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6",
+   "metadata": {},
+   "source": [
+    "Now we can construct the system by instantiating the blocks we need with their corresponding prameters and collect them together in a list:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Blocks that define the system\n",
+    "Src = Source(s)\n",
+    "Int = Integrator(x0)\n",
+    "Amp = Amplifier(a)\n",
+    "Add = Adder()\n",
+    "Sco = Scope(labels=[\"step\", \"response\"])\n",
+    "\n",
+    "blocks = [Src, Int, Amp, Add, Sco]"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "id": "8",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "Afterwards, the connections between the blocks can be defined. The first argument of the :class:`.Connection` class is the source block and its port (``Src[0]`` would be port ``0`` of the instance of the :class:`.Source` block, which is also the default port)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# The connections between the blocks\n",
+    "connections = [\n",
+    "    Connection(Src, Add[0], Sco[0]),\n",
+    "    Connection(Amp, Add[1]),\n",
+    "    Connection(Add, Int),\n",
+    "    Connection(Int, Amp, Sco[1]),\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "id": "10",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "Finally we can instantiate the ``Simulation`` with the blocks, connections and some additional parameters such as the timestep. In this case, no special ODE solver is specified, so PathSim uses the default :class:`.SSPRK22` integrator which is a fixed step 2nd order explicit Runge-Kutta method. A good starting point. Then we can run the simulation for some duration which is set as ``4*tau`` in this example."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "11",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Initialize simulation with the blocks, connections, timestep\n",
+    "Sim = Simulation(blocks, connections, dt=0.01, log=True)\n",
+    "\n",
+    "# Run the simulation for some time\n",
+    "Sim.run(4 * tau)"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "id": "12",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "Due to the object oriented and decentralized nature of PathSim, the :class:`.Scope` block holds the recorded time series data from the simulation internally. It can be accessed by its ``read`` method"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "13",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Read the data from the scope\n",
+    "time, [data_step, data_response] = Sco.read()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "14",
+   "metadata": {},
+   "source": [
+    "or plotted directly in an external matplotlib window using the `plot` method"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "15",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Plot the results from the scope\n",
+    "fig, ax = Sco.plot()\n",
+    "plt.show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python [conda env:base] *",
+   "language": "python",
+   "name": "conda-base-py"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

pathsim_fusion-0.1.0/docs/source/pathsim_docs.mplstyle

@@ -0,0 +1,74 @@
+# PathSim documentation matplotlib style
+# Optimized for light/dark mode compatibility with transparent backgrounds
+
+# Figure
+figure.figsize: 8, 4
+figure.dpi: 300
+figure.facecolor: none
+figure.edgecolor: none
+savefig.facecolor: none
+savefig.edgecolor: none
+savefig.transparent: True
+savefig.bbox: tight
+savefig.pad_inches: 0.1
+
+# Axes
+axes.facecolor: none
+axes.edgecolor: "#7F7F7F"
+axes.linewidth: 1.8
+axes.grid: False
+axes.axisbelow: True
+axes.labelsize: 11
+axes.titlesize: 12
+axes.labelcolor: "#7F7F7F"
+axes.titleweight: bold
+axes.spines.top: False
+axes.spines.right: False
+
+# Grid
+grid.color: "#7F7F7F"
+grid.linestyle: --
+grid.linewidth: 0.8
+grid.alpha: 0.6
+
+# Lines
+lines.linewidth: 2.0
+lines.markersize: 8
+lines.markeredgewidth: 1.5
+lines.antialiased: True
+
+# Patches (for bars, etc.)
+patch.linewidth: 1.0
+patch.facecolor: 4C72B0
+patch.edgecolor: none
+patch.antialiased: True
+
+# Font
+font.family: sans-serif
+font.sans-serif: DejaVu Sans, Arial, Helvetica, sans-serif
+font.size: 10
+text.color: "#7F7F7F"
+
+# Legend
+legend.frameon: False
+legend.framealpha: 0.0
+legend.fancybox: False
+legend.facecolor: none
+legend.edgecolor: none
+legend.fontsize: 10
+legend.loc: best
+
+# Ticks
+xtick.labelsize: 10
+ytick.labelsize: 10
+xtick.color: "#7F7F7F"
+ytick.color: "#7F7F7F"
+xtick.direction: out
+ytick.direction: out
+xtick.major.width: 1.8
+ytick.major.width: 1.8
+xtick.minor.width: 1.2
+ytick.minor.width: 1.2
+
+# Color cycle - colors that work well with grey text
+axes.prop_cycle: cycler('color', ['e41a1c', '377eb8', '4daf4a', '984ea3', 'ff7f00'])

pathsim_fusion-0.1.0/environment.yml

@@ -0,0 +1,27 @@
+# Development environment for pathsim-fusion.
+#
+#   conda env create -f environment.yml
+#   conda activate pathsim-fusion
+#
+# Update after changing dependencies:
+#
+#   conda env update -f environment.yml --prune
+#
+# pathsim itself comes from PyPI via the package's own dependencies. To develop
+# against a local checkout of core instead, run afterwards:
+#
+#   pip install -e ../pathsim
+
+name: pathsim-fusion
+channels:
+  - conda-forge
+dependencies:
+  - python=3.12
+  - pip
+  - numpy
+  - scipy
+  - matplotlib
+  - ipykernel
+  - mypy
+  - pip:
+      - -e .[test,lint]