magpylib_jax¶
JAX-native, end-to-end differentiable magnetic field computation with Magpylib-compatible APIs.
magpylib_jax is organized around three goals:
keep the high-level Magpylib user model familiar,
provide analytical field kernels that remain differentiable through JAX,
make correctness and performance observable through parity tests, benchmarks, and profiling artifacts.
Start here¶
New user: Quickstart
Looking for the mathematical model: Equation Models
Looking for implementation details: Architecture and Source Map
Looking for examples: Examples
Looking for validation guarantees: Testing and Validation
Looking for performance guidance: Performance
User Guide
- Overview
- Quickstart
- Equation Models
- Field conventions
- Common reduction pattern
- Dipole model
- $$ \mathbf{H}(\mathbf{r}) = \frac{1}{4\pi} \left( \frac{3(\mathbf{m}\cdot\mathbf{r})\mathbf{r}}{\lVert \mathbf{r} \rVert^5}
- Sphere with uniform polarization
- Current line and polyline models
- Circular loop model
- Cuboid, triangle, tetrahedron, and mesh models
- Triangle
- Tetrahedron
- Triangular mesh
- TriangleSheet and TriangleStrip
- Cylinder and CylinderSegment models
- Cylinder
- CylinderSegment
- Derivation strategy in code
- Where to read the implementation
- Numerics
- Architecture and Source Map
- Examples
- Testing and Validation
- Performance
- Parity Strategy
- Parity Checklist
- Changelog
- API Reference
- Roadmap