forked from CRPropa/CRPropa3
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add more details in the interrupt examle
- Loading branch information
1 parent
db8beea
commit 1730399
Showing
3 changed files
with
162 additions
and
136 deletions.
There are no files selected for viewing
166 changes: 84 additions & 82 deletions
166
doc/pages/example_notebooks/interrupting_simulations/interrupt_candidateVector.ipynb
Large diffs are not rendered by default.
Oops, something went wrong.
119 changes: 66 additions & 53 deletions
119
doc/pages/example_notebooks/interrupting_simulations/interrupt_source.ipynb
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|