Current voxels branch

[akaptano]

Hello! I am attempting to get my old current voxels branch (corresponding to this paper) merged into main. I have updated it with the current version of main, fixed a number of issues, and will continue to get the code coverage and documentation improved. Will reach out when this is ready for a look through. Thanks!

[codecov[bot]]

Codecov Report

:x: Patch coverage is 98.21628% with 16 lines in your changes missing coverage. Please review. :white_check_mark: Project coverage is 92.96%. Comparing base (8bd454c) to head (38e22f5). :warning: Report is 10 commits behind head on master.

Files with missing lines	Patch %	Lines
src/simsopt/field/magneticfieldclasses.py	85.71%	9 Missing :warning:
.../simsopt/util/permanent_magnet_helper_functions.py	96.29%	4 Missing :warning:
src/simsopt/geo/current_voxels_grid.py	99.66%	2 Missing :warning:
src/simsopt/solve/current_voxels_optimization.py	99.24%	1 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #559      +/-   ##
==========================================
+ Coverage   92.56%   92.96%   +0.39%     
==========================================
  Files          83       85       +2     
  Lines       16229    17132     +903     
==========================================
+ Hits        15023    15927     +904     
+ Misses       1206     1205       -1     

Flag	Coverage Δ
unittests	92.96% <98.21%> (+0.39%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.