DESC icon indicating copy to clipboard operation
DESC copied to clipboard

Add comments about recommeded resolutions to docstrings

Open f0uriest opened this issue 4 months ago • 2 comments

  • [ ] @dpanici can you check that the recommendations for coils seem reasonable? Also if there are other MagneticField classes that we can give recommendations for
  • [ ] @ddudt @rahulgaur104 can you add some recommendations/comments for the OmnigenousField and Omnigenity objectives
  • [ ] @unalmis @rahulgaur104 can you add some recommendations/comments for the bounce integral and stability objectives (waiting on #1919 )

Resolves #1885

f0uriest avatar Sep 05 '25 20:09 f0uriest

Memory benchmark result

|               Test Name                |      %Δ      |    Master (MB)     |      PR (MB)       |    Δ (MB)    |    Time PR (s)     |  Time Master (s)   |
| -------------------------------------- | ------------ | ------------------ | ------------------ | ------------ | ------------------ | ------------------ |
  test_objective_jac_w7x                 |    3.24 %    |     3.891e+03      |     4.017e+03      |    125.95    |       35.14        |       31.23        |
  test_proximal_jac_w7x_with_eq_update   |   -0.52 %    |     6.829e+03      |     6.793e+03      |    -35.29    |       156.75       |       157.68       |
  test_proximal_freeb_jac                |   -0.16 %    |     1.323e+04      |     1.321e+04      |    -21.71    |       76.50        |       77.21        |
  test_proximal_freeb_jac_blocked        |   -0.50 %    |     7.647e+03      |     7.609e+03      |    -37.99    |       67.07        |       67.26        |
  test_proximal_freeb_jac_batched        |   -0.14 %    |     7.570e+03      |     7.559e+03      |    -10.29    |       67.98        |       69.27        |
  test_proximal_jac_ripple               |    0.23 %    |     7.578e+03      |     7.595e+03      |    17.19     |       68.98        |       69.40        |
  test_proximal_jac_ripple_spline        |    2.65 %    |     3.496e+03      |     3.588e+03      |    92.48     |       70.71        |       71.19        |
  test_eq_solve                          |    2.04 %    |     2.001e+03      |     2.041e+03      |    40.72     |       123.64       |       123.25       |

For the memory plots, go to the summary of Memory Benchmarks workflow and download the artifact.

github-actions[bot] avatar Sep 05 '25 20:09 github-actions[bot]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 95.81%. Comparing base (739598c) to head (0b2fafe). :warning: Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1898   +/-   ##
=======================================
  Coverage   95.81%   95.81%           
=======================================
  Files         100      100           
  Lines       27535    27535           
=======================================
  Hits        26383    26383           
  Misses       1152     1152           
Files with missing lines Coverage Δ
desc/coils.py 97.96% <ø> (ø)
desc/equilibrium/equilibrium.py 95.47% <ø> (ø)
desc/objectives/_free_boundary.py 96.52% <ø> (ø)

... and 2 files with indirect coverage changes

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Sep 05 '25 20:09 codecov[bot]