Skip to content

Commit b320369

Browse files
committed
Updated post-processing guidance
1 parent a465006 commit b320369

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

RascalC/post_process/auto.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,10 @@ def post_process_auto(file_root: str,
5252
- By default, this function guesses jackknife or mock pipeline and the covariance binning mode by the output directory contents, but you can also specify some or all of these regimes via optional arguments.
5353
- Note that ``skip_s_bins`` and ``skip_l`` are not auto-determined, so by default no bins are be skipped even if they were cut in :func:`RascalC.run_cov`.
5454
55-
Do not run this (or any other post-processing function/script) while the main RascalC computation is running — this may delete the output directory and cause the code to crash.
55+
Now it should be safe to run this (or attempt other post-processing) while the main RascalC computation is still running, as long as you do not put multiple runs into one output directory.
56+
Some extra caution may be needed for two-tracer computations, but they should be good if you ran them with :func:`RascalC.run_cov`.
57+
This is achieved by a default heuristic check for the normal finishing of the main RascalC computation.
58+
With this, inspecting the output of an aborted or timed-out run is harder, by default it will be considered unfinished. But if you are sure that the main computation is not running, you can disable the check via ``check_finished=False``. Doing this once should be sufficient, repeated post-processing attempts should no longer detect the run as unfinished.
5659
5760
Parameters
5861
----------
@@ -140,7 +143,7 @@ def post_process_auto(file_root: str,
140143
(Optional) integer value is used to set manually the number of radial bins, angular bins (not needed in some Legendre modes), jackknife regions (jackknife mode only) and maximum (even) ell (Legendre mode only) respectively. Each parameter which is None (default) is determined automatically.
141144
142145
check_finished : boolean
143-
(Optional) whether to check if the RascalC computation was finished successfully before post-processing to avoid disrupting ongoing runs. It is on by default. You can disable this check, but we advise to do so only if you are sure that the main RascalC computation is not running in the directory due to an interruption and/or time-out and you want to check the quality of this unfinished run's output.
146+
(Optional) whether to check if the RascalC computation was finished successfully before post-processing to avoid disrupting ongoing runs. It is on by default for safety. You can disable this check, but we advise to do so only if you are sure that the main RascalC computation is not running in the directory due to an interruption and/or time-out and you want to check the quality of this unfinished run's output. Doing this once should be sufficient, repeated post-processing attempts should no longer detect the run as unfinished.
144147
145148
dry_run: boolean
146149
(Optional) If True, this will not run actual post-processing, only determine the filename and path (see below).

docs/library/fundamentals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ Post-processing
304304
---------------
305305

306306
A suitable post-processing routine is invoked at the end of the main wrapper function (:func:`RascalC.run_cov`), so in many circumstances you may not need to run it separately.
307-
However, this automated but customizable post-processing routine is useful for timed-out runs, switching the mode, testing different cuts and/or output combinations in cases of insufficient convergence, etc.
307+
However, this automated but customizable post-processing routine is useful for switching the mode, testing different cuts and/or output combinations in cases of insufficient convergence, inspecting aborted or timed-out runs, etc.
308308

309309
.. autofunction:: RascalC.post_process_auto
310310

0 commit comments

Comments
 (0)