swmmx Documentation

Time Helpers

Time helpers separate expected reporting times from actual output periods. Pre-run helpers come from model options; run-time helpers require a completed m.run() or m.runs().

FunctionUse
m.time.vector()Expected report timestamps as a pandas DataFrame/index before a run.
m.time.count()Expected pre-run report-period count.
m.time.vector_run()Actual timestamps inferred from the completed .out file.
m.time.count_run()Actual post-run period count.
frame = m.time.vector()
expected_steps = m.time.count()

m.run()
actual_frame = m.time.vector_run()
actual_steps = m.time.count_run()