RadCluster
Graph-based cluster dynamics for irradiated materials
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
campaign.ProgressLog Class Reference
+ Collaboration diagram for campaign.ProgressLog:

Public Member Functions

 __init__ (self, str machine, str run_id, dict entry)
 
 start_heartbeat (self, period_s=30.0, sim=None, ckpt_dir=None)
 
 checkpoint (self)
 
 stop_heartbeat (self)
 
 event (self, kind, **kw)
 
 tick (self, dict row)
 
 render (self, state, extra="")
 

Public Attributes

 jsonl
 
 status
 
 machine
 
 run_id
 
 entry
 
 t0
 
 G
 
 last
 
 n_steps
 
 sim
 
 ckpt_dir
 

Protected Attributes

 _t_step
 
 _stop
 
 _beat
 
 _ckpt_n
 

Detailed Description

Append-only event log plus a rendered status snapshot.

Both are local and gitignored: they update per solver output step, which is
far too often to commit.  What reaches the remote is the per-run record,
pushed once the run ends.

Definition at line 68 of file campaign.py.

Constructor & Destructor Documentation

◆ __init__()

campaign.ProgressLog.__init__ (   self,
str  machine,
str  run_id,
dict  entry 
)

Definition at line 76 of file campaign.py.

Member Function Documentation

◆ checkpoint()

campaign.ProgressLog.checkpoint (   self)

Definition at line 131 of file campaign.py.

◆ event()

campaign.ProgressLog.event (   self,
  kind,
**  kw 
)

Definition at line 178 of file campaign.py.

◆ render()

campaign.ProgressLog.render (   self,
  state,
  extra = "" 
)

Definition at line 204 of file campaign.py.

◆ start_heartbeat()

campaign.ProgressLog.start_heartbeat (   self,
  period_s = 30.0,
  sim = None,
  ckpt_dir = None 
)

Definition at line 102 of file campaign.py.

◆ stop_heartbeat()

campaign.ProgressLog.stop_heartbeat (   self)

Definition at line 173 of file campaign.py.

◆ tick()

campaign.ProgressLog.tick (   self,
dict  row 
)
One C++ solver output step.

Definition at line 192 of file campaign.py.

Member Data Documentation

◆ _beat

campaign.ProgressLog._beat
protected

Definition at line 92 of file campaign.py.

◆ _ckpt_n

campaign.ProgressLog._ckpt_n
protected

Definition at line 103 of file campaign.py.

◆ _stop

campaign.ProgressLog._stop
protected

Definition at line 91 of file campaign.py.

◆ _t_step

campaign.ProgressLog._t_step
protected

Definition at line 90 of file campaign.py.

◆ ckpt_dir

campaign.ProgressLog.ckpt_dir

Definition at line 103 of file campaign.py.

◆ entry

campaign.ProgressLog.entry

Definition at line 85 of file campaign.py.

◆ G

campaign.ProgressLog.G

Definition at line 87 of file campaign.py.

◆ jsonl

campaign.ProgressLog.jsonl

Definition at line 78 of file campaign.py.

◆ last

campaign.ProgressLog.last

Definition at line 88 of file campaign.py.

◆ machine

campaign.ProgressLog.machine

Definition at line 85 of file campaign.py.

◆ n_steps

campaign.ProgressLog.n_steps

Definition at line 89 of file campaign.py.

◆ run_id

campaign.ProgressLog.run_id

Definition at line 85 of file campaign.py.

◆ sim

campaign.ProgressLog.sim

Definition at line 103 of file campaign.py.

◆ status

campaign.ProgressLog.status

Definition at line 84 of file campaign.py.

◆ t0

campaign.ProgressLog.t0

Definition at line 86 of file campaign.py.


The documentation for this class was generated from the following file: