reports.py

aviary.interface.reports.mission_report(prob, **kwargs)

Creates a basic mission summary report that is placed in the “reports” folder

Parameters:

prob (AviaryProblem) – The AviaryProblem used to generate this report

aviary.interface.reports.register_custom_reports()

Registers Aviary reports with OpenMDAO, so they are automatically generated and added to the same reports folder as other default reports

aviary.interface.reports.run_status(prob)

Creates a JSON file that containts high level overview of the run

Parameters:

prob (AviaryProblem) – The AviaryProblem used to generate this report

aviary.interface.reports.subsystem_report(prob, **kwargs)

Loops through all subsystem builders in the AviaryProblem calls their write_report method. All generated report files are placed in the “reports/subsystem_reports” folder

Parameters:

prob (AviaryProblem) – The AviaryProblem used to generate this report

aviary.interface.reports.timeseries_csv(prob, **kwargs)

Generates a CSV file containing timeseries data for variables from an Aviary mission.

This function extracts timeseries data from the provided problem object, processes the data to unify units across different phases of the mission, and then outputs the result to a CSV file. The ‘time’ variable is moved to the beginning of the dataset so it’s always the leftmost column. Duplicate consecutive rows are eliminated.

Parameters:

• prob (AviaryProblem) – The AviaryProblem used to generate this report

• kwargs (dict) – Additional keyword arguments (unused)

• directory. (The output CSV file is named 'mission_timeseries_data.csv' and is saved in the reports)

• units. (The first row of the CSV file contains headers with variable names and)

• step. (Each subsequent row represents the mission outputs at a different time)