Use src-layout package structure (#16)

## 3.2.0 - 2025-08-07

### Changed

* Use src-layout package structure

Author: jlogan-cfs

.github/workflows/actions.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - release
       - main
-  pull_request: []
+  pull_request:
   workflow_dispatch:
     tag: "Manual Run"
 
@@ -34,7 +34,7 @@ jobs:
         uv pip install .[dev]
 
         # Lint and test
-        uv run --locked ruff check ./device_inductance
-        uv run --locked pyright ./device_inductance
-        MPLBACKEND="AGG" uv run --locked coverage run --source=./device_inductance -m pytest ./test --verbose
+        uv run --locked ruff check ./src/device_inductance
+        uv run --locked pyright ./src/device_inductance
+        MPLBACKEND="AGG" uv run --locked coverage run --source=./src/device_inductance -m pytest ./test
         uv run --locked coverage report

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.2.0 - 2025-08-07
+
+### Changed
+
+* Use src-layout package structure
+
 ## 3.1.0 - 2025-07-11
 
 ### Added

docs/api/components.md

@@ -5,5 +5,7 @@
 ::: device_inductance.circuits
 
 ::: device_inductance.structures
+    options:
+      show_submodules: true
 
 ::: device_inductance.sensors

docs/api/local.md

@@ -0,0 +1,3 @@
+# Local Field Solve
+
+::: device_inductance.local

docs/api/utils.md

@@ -1,3 +1,5 @@
 # Utility Functions
 
+::: device_inductance.grid
+
 ::: device_inductance.utils

docs/index.md

@@ -158,7 +158,7 @@ Anti-Goals
 
 Licensed under either of
 
-* Apache License, Version 2.0, ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
-* MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)
+* Apache License, Version 2.0, ([LICENSE-APACHE](https://github.com/cfs-energy/device_inductance/blob/release/LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([LICENSE-MIT](https://github.com/cfs-energy/device_inductance/blob/release/LICENSE-MIT) or http://opensource.org/licenses/MIT)
 
 at your option.

mkdocs.yml

@@ -29,6 +29,7 @@ nav:
     - "Device": api/device.md
     - "Components": api/components.md
     - "Model Reduction": api/model_reduction.md
+    - "Local Field Solve": api/local.md
     - "Boundary Tracing": api/contour.md
     - "Utility Functions": api/utils.md
 
@@ -56,5 +57,5 @@ extra_css:
   - stylesheets/extra.css
 
 watch:
-  - device_inductance
+  - src/device_inductance
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "device_inductance"
-version = "3.1.0"
+version = "3.2.0"
 description = "Tokamak core inductance matrices and flux tables"
 authors = [{ name = "Commonwealth Fusion Systems", email = "jlogan@cfs.energy" }]
 requires-python = ">=3.10, <3.14"
@@ -31,10 +31,10 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
-    "pytest==8.3.5",
-    "coverage==7.8.0",
-    "ruff==0.11.8",
-    "pyright==1.1.402",
+    "pytest==8.4.1",
+    "coverage==7.10.2",
+    "ruff==0.12.7",
+    "pyright==1.1.403",
     "mktestdocs==0.2.4",
     "mkdocs>=1.6.0",
     "mkdocs-material>=9.6.12",
@@ -46,9 +46,6 @@ dev = [
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools]
-packages = ["device_inductance"]
-
 [tool.setuptools.package-data]
 device_inductance = ['py.typed']
 

device_inductance/__init__.py src/device_inductance/__init__.pydevice_inductance/__init__.py renamed to src/device_inductance/__init__.py

@@ -49,7 +49,7 @@ def load_default_ods() -> ODS:
                   """)
 
     # NOTE: This should be rewritten to use importlib once omas supports loading raw text
-    ods_filename = Path(__file__).parent / "../examples/OS_SPARC_Device_Description.json"
+    ods_filename = Path(__file__).parent / "../../examples/OS_SPARC_Device_Description.json"
     with open(ods_filename) as f:
         ods = load_omas_json(f)