simsopt icon indicating copy to clipboard operation
simsopt copied to clipboard

Added SPEC and VMEC high-level descriptions

Open smiet opened this issue 8 months ago • 1 comments

Added documentation on how simsopt interfaces with the MHD codes SPEC and VMEC.

smiet avatar May 08 '25 08:05 smiet

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.98%. Comparing base (f0f0ec4) to head (d399e87). Report is 19 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #508      +/-   ##
==========================================
- Coverage   92.25%   91.98%   -0.28%     
==========================================
  Files          82       82              
  Lines       16015    16015              
==========================================
- Hits        14775    14731      -44     
- Misses       1240     1284      +44     
Flag Coverage Δ
unittests 91.98% <ø> (-0.28%) :arrow_down:

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.

codecov[bot] avatar May 08 '25 09:05 codecov[bot]

@mishapadidar Just addressed all your points. Thanks for your time!

smiet avatar May 09 '25 15:05 smiet

The generated doc is at https://simsopt.readthedocs.io/fixit_spec_documentation/mhd.html @smiet The document needs a revision. Please fix the VMEC and SPEC links so they are not explicit. Additionally check "simsopt.geo.SurfaceRZFourier`", which is hard to catch. Instead of saying "f90wrapped code is not re-entrant.", I'd say "f90wrap generates singleton classes". Please go through the docs one more time and fix small typos.

mbkumar avatar May 09 '25 16:05 mbkumar

@mbkumar Should have addressed your issues now, sorry first time working with the .rst format.

smiet avatar May 13 '25 15:05 smiet