Skip to content

Commit

Permalink
add more details in the interrupt examle
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienDoerner committed Sep 5, 2024
1 parent db8beea commit 1730399
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 136 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion doc/pages/interrupting-simulations.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
Interrupting simulations on runtime
------------------------------------------------

.. toctree::
CRPropa simulations can be interrupted on runtime with the `SIGTERM` or `SIGINT` signals.
If the user defines an output for the interruption (called `InterruptAction`) all candidates which are currently in the simulation will be passed to this output.
In the error stream the user will see a message denoting the number of candidates which have not been started yet.
If the simulation was run with a `candidateVector` as source, the indices of the candidates which have not been started yet will be printed or written to the file.
For a simulation with a source interface, a restart with the missing number of candidates will be sufficient to continue the simulation.

.. toctree::
:caption: Using a candidateVector as source
:maxdepth: 0
example_notebooks/interrupting_simulations/interrupt_candidateVector.ipynb

.. toctree::
:caption: Using a source interface
:maxdepth: 0
example_notebooks/interrupting_simulations/interrupt_source.ipynb


0 comments on commit 1730399

Please sign in to comment.