plopm.core.plopm module#

Command-line entry point and top-level workflow coordination for plopm.

plopm supports three output workflows for OPM Flow simulation results:

  • One-dimensional plots and CSV files can be generated from summary vectors, tabulated functions, grid-cell sensors, layers, histograms, and distances.

  • Two-dimensional PNG figures and GIF animations can be generated for selected grid slices, with optional aggregation, masking, differences, wells, and faults.

  • VTK time series can be generated by combining OPM grid geometry with selected INIT and UNRST properties.

This module parses and validates command-line arguments, builds the runtime configuration, selects the appropriate workflow, and reports the generated files. Data reading, numerical processing, plotting, and file generation are implemented in the utility modules.

main(argv=None)[source]#

Run the plopm command-line workflow.

The function parses and validates CLI arguments, builds the shared configuration, and dispatches VTK export, one-dimensional plotting, or two-dimensional map generation. It reports the generated files after the selected workflow completes.

Parameters:
argvlist[str], optional

Arguments to parse instead of sys.argv[1:]. This is primarily used by tests and programmatic callers.

Parameters:

argv (list[str] | None)

Return type:

None