oasislmf.pytools.join_summary_info.manager

Attributes

Functions

load_summary_info(stack, summaryinfo_file)

Load summary-info data into an array as strings to maintain sigfigs/formatting

run(summaryinfo_file, data_file, output_file)

Join the summary-info file to the given ORD data file based on SummaryId

main([summaryinfo, data, output])

Module Contents

oasislmf.pytools.join_summary_info.manager.logger[source]
oasislmf.pytools.join_summary_info.manager.load_summary_info(stack, summaryinfo_file)[source]

Load summary-info data into an array as strings to maintain sigfigs/formatting

Parameters:
  • stack (ExitStack) – Exit Stack

  • summaryinfo_file (str | os.PathLike) – Path to summary-info csv file

Returns:

Array of strings, indexed by Summary Id headers (List[str]): List of strings for summary info headers to add to data max_summary_id (int): Max Summary ID

Return type:

full_summary_data (ndarray[object])

oasislmf.pytools.join_summary_info.manager.run(summaryinfo_file, data_file, output_file)[source]

Join the summary-info file to the given ORD data file based on SummaryId

Parameters:
  • summaryinfo_file (str | os.PathLike) – Path to summary-info file

  • data_file (str | os.PathLike) – Path to ORD output data file (e.g. SELT, MPLT, AAL, PSEPT)

  • output_file (str | os.PathLike) – Path to combined output file

oasislmf.pytools.join_summary_info.manager.main(summaryinfo=None, data=None, output=None, **kwargs)[source]