Merge pull request #743 from MESAHub/chore/update_figures

auto-updating figures
MESAHub · Oct 23, 2024 · 5ce4f75 · 5ce4f75
2 parents 9b2017c + 79d1c8a
commit 5ce4f75
Show file tree

Hide file tree

Showing 19 changed files with 3,750 additions and 3,732 deletions.
diff --git a/docs/source/developing/release.rst b/docs/source/developing/release.rst
@@ -14,7 +14,7 @@ Prior to generating a release
 -----------------------------
 
 - Update the ZAMS model file by running the work directory found in ``data/star_data/zams_models/create_z2m2_y28``. This may take up to an hour or so. This will generate the file ``data/star_data/zams_models/zams_z2m2_y28.data``. Use the ZAMS model plotting script to verify that the HR diagram and central compositions look reasonable, and commit the new data file.
-
+- Update figures in the docs by running the ``update_docs_figures`` script in the ``star/test_suite/`` folder. These figures should be checked to make sure they look reasonable. Currently not all test suite problems autogenerate figures. Pay special attention if the model numbers in the filenames of saved figures have changed (script will print an ERROR message) -- this indicates some commit to MESA has slightly changed the results of these problems, and currently the README.rst file needs to be manually updated with the new image filename and the test as to be re-run (e.g. ``./each_test_run -u 13``). A new release should not be made if one of the figures degrade in quality.
 
 Removing files
 --------------

diff --git a/star/test_suite/1.3M_ms_high_Z/README.rst b/star/test_suite/1.3M_ms_high_Z/README.rst
@@ -47,4 +47,4 @@ The Python script used to create the figures above:
 
 Last-Updated: 27May2021 (MESA ebecc10) by fxt
 
-Last-Run: 26Jul2024 (MESA afd04d7d) by pmocz on C916PXT6XW in 159 seconds using 8 threads.
+Last-Run: 22Oct2024 (MESA 9b2017ca) by pmocz on C916PXT6XW in 234 seconds using 8 threads.
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,7 @@ Prior to generating a release @@
     -----------------------------
     - Update the ZAMS model file by running the work directory found in ``data/star_data/zams_models/create_z2m2_y28``. This may take up to an hour or so. This will generate the file ``data/star_data/zams_models/zams_z2m2_y28.data``. Use the ZAMS model plotting script to verify that the HR diagram and central compositions look reasonable, and commit the new data file.
+    - Update figures in the docs by running the ``update_docs_figures`` script in the ``star/test_suite/`` folder. These figures should be checked to make sure they look reasonable. Currently not all test suite problems autogenerate figures. Pay special attention if the model numbers in the filenames of saved figures have changed (script will print an ERROR message) -- this indicates some commit to MESA has slightly changed the results of these problems, and currently the README.rst file needs to be manually updated with the new image filename and the test as to be re-run (e.g. ``./each_test_run -u 13``). A new release should not be made if one of the figures degrade in quality.
     Removing files
     --------------
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,4 +47,4 @@ The Python script used to create the figures above:

		Last-Updated: 27May2021 (MESA ebecc10) by fxt

		Last-Run: 26Jul2024 (MESA afd04d7d) by pmocz on C916PXT6XW in 159 seconds using 8 threads.
		Last-Run: 22Oct2024 (MESA 9b2017ca) by pmocz on C916PXT6XW in 234 seconds using 8 threads.