Skip to content

Commit

Permalink
Updated checkpointing best practices
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrockwell2 committed Jul 1, 2024
1 parent 7821695 commit 0926010
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/howto_guides/Checkpointing-Best-Practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,14 @@ If the Trick Memory Manager **"knows"** about all of the allocations that compri
There are certain things that simply cannot be checkpointed like file-pointers, and network connections. Perhaps there are other things as well. For these situations, Trick provides four special job classes: ```"checkpoint"```, ```"post_checkpoint"```, ```“preload_checkpoint”```, and ```“restart”``` (described below).

<a id=dumping-a-checkpoint></a>
### What Happens When You Dump a Checkpoint (Under Construction)
### What Happens When You Dump a Checkpoint

A checkpoint of a simulation is usually initiated from the Input Processor. That is, via:

1. The input file, or
2. The variable server.

```trick.checkpoint( <time> )``` is called from Python. This Python function is bound to the corresponding C++ function. At a simulation frame boundary (so that data is time-homogeneous), three things happen:
```trick.checkpoint( <time> )``` is called from Python. This Python function is bound to the corresponding C++ function. At a simulation frame boundary (so that data is time-homogeneous), the simulation freezes and then three things happen:

1. The ```"checkpoint"``` jobs in the S_define file are executed. These job-classes allow you to prepare your sim to be checkpointed. Perhaps you want to transform simulation state data into a different form for checkpointing. This is up to you.

Expand All @@ -109,7 +109,7 @@ A checkpoint of a simulation is usually initiated from the Input Processor. That
<a id=loading-a-checkpoint></a>
### What Happens When You Load a Checkpoint.
Trick.load_checkpoint() is called from Python.
At a simulation frame boundary, three things happen:
At a simulation frame boundary, the simulation freezes and then three things happen:

1. The ```“preload_checkpoint”``` jobs are called. These job-classes allow you to prepare your sim for a checkpoint-restore, in whatever way you see fit.

Expand Down

0 comments on commit 0926010

Please sign in to comment.