Skip to content

About

Common Interface for Analytical and Numerical Electromagnetic Fields

Resources

Stars

18 stars

Watchers

1 watching

Forks

Repository files navigation

ElectromagneticFields.jl

Common Interface for Electromagnetic Fields

Stable Latest License PkgEval Status CI Documentation Coverage DOI

ElectromagneticFields.jl provides a collection of analytical magnetic equilibria and electromagnetic fields. It generates Julia code providing high-level evaluation routines.

Features

Analytical equilibria:

  • simple axisymmetric tokamak equilibrium in cartesian, cylindrical and toroidal coordinates
  • flexible Solov'ev equilibria with and without X-point (including ITER, NSTX and FRC configurations)
  • symmetric quadratic and singular magnetic fields, symmetric Solov'ev equilibria
  • Penning trap
  • Arnold-Beltrami-Childress (ABC) field
  • 3D perturbations (e.g., magnetic islands, electric fields)

References

Development

Git hooks

Two hooks live in .githooks. They are not active in a fresh clone — core.hooksPath is local configuration and does not travel with a push — so enable them once per clone:

git config core.hooksPath .githooks

pre-commit acts on staged .jl files only, and exits immediately when a commit stages none, so a documentation- or workflow-only commit is not slowed down by it:

  • JuliaFormatter --check, honouring this repository's own .JuliaFormatter.toml — blocks the commit. Formatting is mechanical and always fixable.
  • fatou lint, when fatou is installed — advisory only, and deliberately so: its unused-import rule does not follow include, so it flags the load-bearing imports of every module file.
  • using <Package>, which catches a syntax error or a broken include — blocks.

pre-push runs the full test suite with --check-bounds=auto, but only when pushing to main or master; a topic branch is left to CI. It prints nothing for 10–30 minutes, which looks exactly like a network hang and is not one. If you do interrupt it, check for an orphaned Julia process that the killed hook left behind.

Either hook can be bypassed for a single command with --no-verify, for a change you know it does not apply to:

git commit --no-verify
git push --no-verify

The hooks are generated from one shared copy and are byte-identical across the related repositories, so edit them there rather than here — a local edit is silently undone by the next install.

About

Common Interface for Analytical and Numerical Electromagnetic Fields

Resources

Stars

18 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages