New Grid API

CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+New Features
+
+- Restructures the grid classes to allow for new grids in different coordinate systems besides flux coordinates. The old grid classes are aliased to the new grids of type ``AbstractGridFlux`` and are backwards compatable with the new API. ``Curve`` objects now expect a compute grid of type ``AbstractGridCurve``, and ``FourierRZToroidalSurface`` objects now expect a compute grid of type ``AbstractGridToroidalSurface``.
+
 Performance Improvements
 
 - Speeds up the ``"qr"`` trust-region subproblem and Newton-step solves in the least-squares optimizers by reusing the Jacobian QR factorization across the Levenberg-Marquardt parameter sweep. On ``jax >= 0.10.0`` this uses ``qr_multiply`` to additionally avoid forming ``Q`` explicitly; on older versions a fallback preserves the same results.
@@ -13,6 +17,10 @@ Bug Fixes
 - Fixes ``VMECIO.save`` metadata for current-density variables and corrects the
   asymmetric ``currvmns`` magnetic-axis extrapolation.
 
+Deprecations
+
+- ``Curve`` and ``FourierRZToroidalSurface`` objects now expect grids of type ``AbstractGridCurve`` and ``AbstractGridToroidalSurface``, respectively. Their support for grids of type ``AbstractGridFlux`` is deprecated and will be removed in a future release.
+
 
 v0.17.2
 -------
@@ -61,7 +69,6 @@ Bug Fixes
 - Fixes incorrect units in the documentation of some curvature variables.
 
 
-
 v0.17.0
 -------
 
@@ -129,8 +136,6 @@ New Features
   - Coil objectives accept pytree inputs for `target`, `bounds`, and `weight`.
   - Able to set weights to zero, excluding certain coils from the objective.
 
-
-
 Bug Fixes
 
 - Fixes straight field line equilibrium conversion, see #1880
@@ -188,6 +193,7 @@ Backend
 - Significant changes to how DESC handles static attributes during JIT compilation. Going forward if any class/object has attributes that should be treated as static by `jax.jit`, these should be declared at the class level like `_static_attrs = ["foo", "bar"]`. Generally, non-arraylike attributes such as functions, strings etc should be marked static, as well as any attributes used for control flow. Previously this was done automatically, but in a way that caused a lot of performance bugs and unnecessary recompilation. These changes have been implemented for all classes in the `desc` repository, but if you have custom objectives or other local objects that subclass from `desc` you may need to add this yourself. JAX error messages usually do a good job of alerting you to things that need to be static, and feel free to open an issue with `desc` if you have any questions.
 - No longer closes over the field in ``desc.magnetic_fields._core.field_line_integrate``, which can dramatically reduce compile times when the field being traced has large size attributes (for example, when using a ``desc.magnetic_fields._core.SplineMagneticField`` object).
 
+
 v0.14.2
 -------
 
@@ -297,7 +303,6 @@ Breaking Changes
 - Adds support for Python 3.13 and removes support for 3.9 since new JAX versions require minimum Python 3.10.
 
 
-
 v0.13.0
 -------
 
@@ -322,14 +327,14 @@ New Features
 - Add ``desc.coils.initialize_modular_coils`` and ``desc.coils.initialize_saddle_coils`` for creating an initial guess for stage 2 optimization.
 - Adds ``rotate_zeta`` function to ``desc.compat`` to rotate an ``Equilibrium`` around Z axis.
 
-
 Bug Fixes
 
 - Fixes bug that occurs when taking the gradient of ``root`` and ``root_scalar`` with newer versions of JAX (>=0.4.34) and unpins the JAX version.
 - Changes ``FixLambdaGauge`` constraint to now enforce zero flux surface average for lambda, instead of enforcing lambda(rho,0,0)=0 as it was incorrectly doing before.
 - Fixes bug in ``softmin/softmax`` implementation.
 - Fixes bug that occured when using ``ProximalProjection`` with a scalar optimization algorithm.
 
+
 v0.12.3
 -------
 
@@ -358,8 +363,6 @@ Deprecations
 - ``deriv_mode="looped"`` in ``ObjectiveFunction`` is deprecated and will be removed in a future version in favored of ``deriv_mode="batched"`` with ``jac_chunk_size=1``,
 
 
-
-
 v0.12.2
 -------
 
@@ -535,6 +538,7 @@ Breaking Changes
 to avoid confusion with the common shorthand for `Equilibrium`.
 - Minimum Python version is now 3.9
 
+
 v0.10.4
 -------