Skip to content

Summary Handler

ReaxFF simulation summary (summary.txt) handler.

This module provides a handler for parsing ReaxFF summary.txt files, which report per-iteration thermodynamic and system-level quantities during MD or minimization runs.

Typical use cases include:

  • tracking energy, temperature, pressure, and density versus iteration
  • extracting time-series data for plotting or analysis
  • validating simulation stability and convergence

SummaryHandler

Bases: BaseHandler

Parser for ReaxFF simulation summary files (summary.txt).

This class parses summary.txt outputs and exposes per-iteration simulation summaries as a canonical, numeric time series.

Parsed Data

Summary table One row per iteration, returned by dataframe(), with columns determined by the detected column count:

- 8 columns:
  ["iter", "nmol", "time", "E_pot", "V", "T", "P", "D"]

- 9 columns:
  ["iter", "nmol", "time", "E_pot", "V", "T", "P", "D", "elap_time"]

Metadata Returned by metadata(), containing: ["n_records", "columns", "has_time", "source_file"]

Notes
  • Banner and header lines starting with REAX or Iteration are ignored.
  • Rows are parsed as whitespace-delimited numeric data with no in-file header.
  • Duplicate iteration indices are resolved by keeping the last entry.
  • This handler represents a scalar-per-iteration time-series file.