cfsem 2.3.1__tar.gz → 2.4.3__tar.gz

cfsem-2.3.1/.github/workflows/CI.yml → cfsem-2.4.3/.github/workflows/release_python.yml

@@ -3,7 +3,7 @@
 #
 #    maturin generate-ci github
 #
-name: CI
+name: release_python
 
 on:
   push:
@@ -15,6 +15,10 @@ permissions:
   contents: read
 
 jobs:
+
+  test:
+    uses: ./.github/workflows/test_python.yml
+
   linux:
     runs-on: ${{ matrix.platform.runner }}
     strategy:
@@ -42,7 +46,7 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out dist --find-interpreter --features=python
           sccache: 'true'
           manylinux: auto
       - name: Upload wheels
@@ -74,7 +78,7 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out dist --find-interpreter --features=python
           sccache: 'true'
           manylinux: musllinux_1_2
       - name: Upload wheels
@@ -103,7 +107,7 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out dist --find-interpreter --features=python
           sccache: 'true'
       - name: Upload wheels
         uses: actions/upload-artifact@v4
@@ -130,7 +134,7 @@ jobs:
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
+          args: --release --out dist --find-interpreter --features=python
           sccache: 'true'
       - name: Upload wheels
         uses: actions/upload-artifact@v4
@@ -157,7 +161,7 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     #if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
-    needs: [linux, musllinux, windows, macos, sdist]
+    needs: [linux, musllinux, windows, macos, sdist, test]
     permissions:
       # Use to sign the release artifacts
       id-token: write

cfsem-2.4.3/.github/workflows/release_rust.yml

@@ -0,0 +1,29 @@
+name: release_rust
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - release
+
+jobs:
+
+  test:
+    uses: ./.github/workflows/test_rust.yml
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Check semver
+        uses: obi1kenobi/cargo-semver-checks-action@v2
+      - name: Publish
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo publish

cfsem-2.4.3/.github/workflows/test_python.yml

@@ -0,0 +1,50 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: test_python
+
+on: 
+  # push: []  # Save time on actions
+  pull_request: []
+  workflow_dispatch:
+    tag: "Manual Run"
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - name: Install Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+  
+    - name: Test
+      run: |
+        # Install with dev deps
+        uv venv
+        source .venv/bin/activate
+
+        uv pip install maturin
+        # uv run --locked maturin develop --features=python
+        uv pip install .[dev]
+
+        # Python lint, test, and coverage
+        uv run --locked ruff check ./cfsem
+        uv run --locked pyright ./cfsem --pythonversion 3.11
+        uv run --locked coverage run --source=./cfsem -m pytest ./test/
+        uv run --locked coverage report
+
+        # Build docs
+        sh build_docs.sh

cfsem-2.4.3/.github/workflows/test_rust.yml

@@ -0,0 +1,29 @@
+name: test_rust
+
+on:
+  pull_request:
+    branches: [ "*" ]
+  push:
+    branches: [ "main", "develop", "release" ]
+  workflow_call:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+    - name: Format
+      run: cargo fmt --check --verbose
+    - name: Lint
+      run: cargo clippy
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose

cfsem-2.3.1/CHANGELOG.md → cfsem-2.4.3/CHANGELOG_PYTHON.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 2.4.3 2025-07-07
+
+### Changed
+
+* Configure linter to be slightly more strict
+* Format and resolve new lints
+
+## 2.4.2 2025-06-16
+
+### Changed
+
+* Include pyo3 extension-module feature to resolve build issues on linux
+
+## 2.4.1 2025-06-16
+
+### Changed
+
+* Update release workflow
+
+## 2.4.0 2025-06-13
+
+### Changed
+
+* Merge with rust library
+* Update type hints for symmetric bindings
+* Synchronize rust and python library versions
+
 ## 2.3.1 2025-03-19
 
 ### Changed

cfsem-2.4.3/CHANGELOG_RUST.md

@@ -0,0 +1,82 @@
+# Changelog
+
+## 2.4.3 2025-07-07
+
+### Changed
+
+* No changes to rust side; version roll for lock-step versioning with python
+
+## 2.4.2 2025-06-16
+
+### Changed
+
+* Include pyo3 extension-module feature to resolve build issues on linux
+
+## 2.4.1 2025-06-16
+
+### Changed
+
+* Update release workflow
+
+## 2.4.0 2025-06-13
+
+### Changed
+
+* Merge library with python bindings by adding `python` feature gate in front of bindings module
+* Synchronize rust and python library versions
+* Update license to MIT only for compatibility with combined Python library
+* Update release workflow to use cargo-semver-checks action directly
+
+## 2.0.0 2025-02-03
+
+### Added
+
+* Add libm dep for reproducible trig functions
+    * Rust std/core defers to libc or other platform-dependent math libraries for trig functions, which can cause platform-dependent results
+    * libm is a pure rust implementation of most functions from MUSL libm, and is platform-independent to the extent that the processor's implementation of floating point math conforms to IEEE-754
+* Add scalar calculations of vector potential, magnetic field, and poloidal flux of a circular filament extracted from vector loop
+    * Scalar calculations now used as the inner function in the vector loops
+    * This produces no performance regression, and some improvements in a few cases, while improving readability by separating physics from array handling
+* Add `mutual_inductance_circular_to_linear` family of functions for calculating mutual inductance between circular filaments and piecewise-linear paths
+* Add `flux_density_circular_filament_cartesian` family of functions for calculating B-field from circular filaments to points in cartesian coordinates
+* Add `cartesian_to_cylindrical` and `cylindrical_to_cartesian` conversion functions
+* Add `decompose_filament` function for converting the start and end points of a filament to the midpoint and length vector
+* Add `body_force_density_linear_filament` and `body_force_density_circular_filament_cartesian` families of functions for calculating JxB force density
+* Add `mesh_filament` module and `mesh_edge_inductance` function for calculating full inductance matrix over a collection of disjoint segments
+    * Same throughput perf as linear filament inductance for a given input geometry, but allocates for the full NxM output matrix
+    * doc(hidden) for now, as the API is likely to change in the near future to avoid reallocating input data
+* Add `point_source` module with dipole field
+* Add (internal) `testing` module with array-handling utilities for tests
+* Add (internal) macros for checking slice lengths
+
+### Changed
+
+* Use `Slice::fill(0.0)` instead of manually zeroing output arrays
+* Use macro for checking array lengths to reduce repeated code
+* !Consolidate function signatures of circular filament calcs to reduce number of args and group args by physical association
+
+# Changelog
+
+## 1.1.0 2024-08-20
+
+### Added
+
+* Add vector potential calcs for linear and circular filaments w/ parallel variants
+* Add parallel variants of circular filament flux and flux density calcs
+* Add tests of serial and parallel variants to make sure they produce the same result
+* Add tests of equivalence between flux/inductance, flux density, and vector potential calcs
+
+### Changed
+
+* Move Biot-Savart calcs to linear filament module and rename appropriately
+  * Leave use-as references to prevent breaking change to API
+* Eliminate small allocations from parallel variant of Biot-Savart to reduce overhead when running with a large number of cores
+  * 40%-100% speedup for small numbers of observation points
+* Defensively zero-out output slices
+* Convert some `#[inline(always)]` directives to plain `#[inline]`
+
+## 1.0.0 2024-07-09
+
+### Added
+
+* Initial release