Wave 5.2A MMT Equation Diagnostic Report

Build the Wave 5.2A MMT equation diagnostic report.

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.format_float(value)[source]

Format one float for stable CSV or Markdown output.

Parameters:

value (float)

Return type:

str

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.write_csv(output_path, row_list)[source]

Write dictionaries to CSV.

Parameters:
  • output_path (Path)

  • row_list (list[dict[str, Any]])

Return type:

None

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.build_curve_rows(angle_rad, rte_rad)[source]

Build point-wise MMT demonstration curve rows.

Parameters:
  • angle_rad (ndarray)

  • rte_rad (ndarray)

Return type:

list[dict[str, Any]]

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.compute_harmonic_rows(rte_rad, maximum_harmonic=None)[source]

Compute harmonic amplitude rows for the MMT demonstration curve.

Parameters:
  • rte_rad (ndarray)

  • maximum_harmonic (int | None)

Return type:

list[dict[str, Any]]

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.build_report_lines(run_id, summary_dictionary, harmonic_row_list, output_directory)[source]

Build the Wave 5.2A diagnostic Markdown report.

Parameters:
  • run_id (str)

  • summary_dictionary (dict[str, Any])

  • harmonic_row_list (list[dict[str, Any]])

  • output_directory (Path)

Return type:

list[str]

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.parse_arguments()[source]

Parse command-line arguments.

Return type:

Namespace

scripts.reports.analysis.build_wave4a_mmt_equation_diagnostic_report.main()[source]

Build the Wave 5.2A MMT diagnostic report.

Return type:

None