cfsem 2.0.4__tar.gz

cfsem-2.0.4/.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.'cfg(any(target_arch = "x86", target_arch = "x86_64"))']
+rustflags = ["-Ctarget-feature=+fma"]

cfsem-2.0.4/.github/workflows/CI.yml

@@ -0,0 +1,119 @@
+# This file is autogenerated by maturin v1.3.0
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: CI
+
+on:
+  push:
+    branches:
+      - release
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [x86_64, x86, aarch64, armv7, s390x, ppc64le]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        target: [x64, x86]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: ${{ matrix.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  macos:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        target: [x86_64, aarch64]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v3
+        with:
+          name: wheels
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    #if: "startsWith(github.ref, 'refs/tags/')"
+    needs: [linux, windows, macos, sdist]
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: wheels
+      - name: Publish to PyPI
+        uses: PyO3/maturin-action@v1
+        env:
+          MATURIN_PYPI_TOKEN: ${{ secrets.MATURIN_PASSWORD }}
+        with:
+          command: upload
+          args: --non-interactive --skip-existing *

cfsem-2.0.4/.github/workflows/actions.yml

@@ -0,0 +1,64 @@
+# 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: build_and_test
+
+on: 
+  # push: []  # Save time on actions
+  pull_request: []
+  workflow_dispatch:
+    tag: "Manual Run"
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Setup
+      run: |
+
+        # Base setup
+        sudo apt update
+        sudo apt install build-essential
+
+        # Install Rust & Cargo
+        curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+        rustup component add clippy
+
+        # Set up pip and a virtualenv (s.t. maturin can run)
+        python -m pip install --upgrade pip
+        python -m venv ./env
+        source ./env/bin/activate
+
+        # Install with dev deps
+        pip install maturin
+        maturin develop
+        pip install .[dev]
+  
+    - name: Test
+      run: |
+        source ./env/bin/activate
+
+        # Python lint, test, and coverage
+        ruff check ./cfsem
+        pyright ./cfsem --pythonversion 3.11
+        coverage run --source=./cfsem -m pytest ./test/
+        coverage report
+
+        # Rust format and lint
+
+        cargo fmt --check
+        cargo clippy
+
+        # Build docs
+
+        sh build_docs.sh

cfsem-2.0.4/.gitignore

@@ -0,0 +1,81 @@
+/target
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+.pytest_cache/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+.venv/
+env/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+include/
+man/
+venv/
+*.egg-info/
+.installed.cfg
+*.egg
+*.ruff_cache
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+pip-selfcheck.json
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Rope
+.ropeproject
+
+# Django stuff:
+*.log
+*.pot
+
+.DS_Store
+
+# Sphinx documentation
+docs/_build/
+
+# PyCharm
+.idea/
+
+# VSCode
+.vscode/
+
+# Pyenv
+.python-version
+
+target
+
+# Documentation site generated by mkdocs.
+site
+
+examples/*.png
+docs/python/example_outputs/*.png

cfsem-2.0.4/.readthedocs.yml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    rust: "1.70"
+  jobs:
+    pre_build:  # Generate plots for docs
+      - MPLBACKEND="Agg" sh build_docs.sh
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

cfsem-2.0.4/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+## 2.0.4 2024-07-10
+
+### Changed
+
+* Use `cfsem` rust dep from crates.io
+* Update docs and license for open-souce release
+
+## 2.0.3 2024-07-09
+
+### Changed
+
+* Support python 3.12
+
+## 2.0.2 2024-07-02
+
+### Changed
+
+* Update filament_coil function to use np.meshgrid instead of nested comprehension
+* Update test of filament_coil to check against previous version of calc
+* Move filamentization tests to their own test file
+* Update nalgebra dep
+* Update ruff dep
+
+## 2.0.1 2024-06-18
+
+### Changed
+
+* Improve docstrings
+* Test building docs in CI
+* Update length checks in `inductance_piecewise_linear_filaments` to allow use when first and second path do not have the same number of segments
+
+## 2.0.0 2024-05-10
+
+### Changed
+
+* (!) Transpose filament_helix_path() array inputs and outputs to eliminate some unnecessary copies
+* (!) Transpose array inputs to piecewise linear inductance methods to eliminate some unnecessary copies
+* Remove dep on scipy for release (now dev only)
+* Add more parametrized cases to tests for filament_helix_path
+* Use cubic interpolation method for boundary flux in distributed inductance calc
+* Update flux_density_biot_savart rust function to mutate an input slice instead of allocating locally
+* Parametrize tests of flux_density_biot_savart over parallel and serial implementations
+* Add optional parallel flag to flux_density_biot_savart python bindings
+* Roll forward rust deps on numpy and pyo3
+* Run linting, tests, and coverage directly and remove dep on pre-commit
+
+### Added
+
+* Add `mesh` module in rust library
+* Add rust implementation of filament_helix_path()
+* Add rotate_filaments_about_path() via rust bindings
+* Add CHANGELOG.md
+* Add MU_0 from handcalc to eliminate scipy dep
+* Add _filament_helix_path_py to test functions
+  * Integrated error over the length of a filament makes this not very useful for testing against new calc
+* Add flux_density_biot_savart_par in rust library
+* Add nalgebra and rayon to rust deps

cfsem-2.0.4/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Contributions consistent with the goals and anti-goals of the package are welcome.
+
+Please make an issue ticket to discuss changes before investing significant time into a branch.