wolfhece.report.simplesimgpu

Create a report on a simple simulation from wolfgpu

Module Contents

class wolfhece.report.simplesimgpu.SimpleSimGPU_Report(sim: wolfgpu.simple_simulation.SimpleSimulation | pathlib.Path | str, **kwargs)

_summary

_doc = None

_summary_versions()

Find the versions of the simulation, wolfhece and the wolfgpu package

_summary_spatial_extent()

Return the summary of the spatial extent of the simulation

_summary_number_of_cells()

Return the summary of the number of cells in the simulation

_summary_time_evolution()

Return the summary of the time evolution of the simulation

_summary_boundary_conditions()

Return the summary of the boundary conditions of the simulation

_summary_infiltration()

Return the summary of the infiltration conditions of the simulation

_figure_infiltration()

Add the infiltration image to the PDF report

_summary_bathymetry()

Return the summary of the bathymetry of the simulation

_summary_initial_conditions()

Return the summary of the initial conditions of the simulation

_figure_histogram_waterdepth()

Add the histogram of bathymetry to the PDF report

_figure_histogram_manning()

Add the histogram of bathymetry to the PDF report

_summary_bridge()

Return the summary of the bridge conditions of the simulation

_summary_warnings()

Return the summary of the warnings of the simulation

_summary_errors()

Return the summary of the errors of the simulation

_figure_model_extent()

Get the bathymetry figure for the PDF report

summary()

Create a dictionnary with the summary of the simulation

_layout()

Set the layout of the PDF report.

Each group has a rectangle of 9cm width and 2.5 cm height.

Title rect is 16 cm width and 1.5 cm height. Version rect is 16 cm width and 1 cm height. Logo is at the top-right corner of the page (2 cm width x 3 cm height).

create_report()

Create the PDF report for the Simple Simulation GPU

save_report(output_path: pathlib.Path | str = None)

Save the report to a PDF file

property pdf_path

Return the PDF document

class wolfhece.report.simplesimgpu.SimpleSimGPU_Report_wx(sim: wolfgpu.simple_simulation.SimpleSimulation | pathlib.Path | str, show: bool = False, **kwargs)

Bases: wolfhece.report.pdf.PDFViewer

A sized frame.

Controls added to its content pane will automatically be added to the panes sizer.

_report

on_close(event)

Handle the close event of the frame

class wolfhece.report.simplesimgpu.SimpleSimGPU_Reports_wx(dir_or_sims: list[wolfgpu.simple_simulation.SimpleSimulation | pathlib.Path | str] | pathlib.Path, show: bool = True, **kwargs)

List of Simple Simulations GPU

class wolfhece.report.simplesimgpu.SimpleSimGPU_Report_Compare(sims: list[wolfgpu.simple_simulation.SimpleSimulation | pathlib.Path | str] | pathlib.Path, **kwargs)

Compare Multiple Simple Simulations GPU

_sims: list[wolfgpu.simple_simulation.SimpleSimulation]

_infos = []

_report = None

_summary_versions()

Find the versions of the simulation, wolfhece and the wolfgpu package

_summary_array_shapes()

Return the summary of the array shapes of the simulations

_summary_array_data()

Return the summary of the array data of the simulations

_summary_resolution()

Return the summary of the resolution of the simulations

_summary_boundary_conditions()

Return the summary of the boundary conditions of the simulations

summary()

Create a summary of the simulations

_html_table_compare(key: str, text: list)

Create an HTML table to compare the simulations

One line for each parameter to compare. One column for each simulation. The first column is the parameter name. The first row is the simulation name.

_layout()

Set the layout of the PDF report for the comparison.

create_report()

Create the PDF report for the comparison

save_report(output_path: pathlib.Path | str = None)

Save the report to a PDF file

property pdf_path

Return the PDF document

class wolfhece.report.simplesimgpu.SimpleSimGPU_Report_Compare_wx(sims: list[wolfgpu.simple_simulation.SimpleSimulation | pathlib.Path | str], **kwargs)

Bases: wolfhece.report.pdf.PDFViewer

A sized frame.

Controls added to its content pane will automatically be added to the panes sizer.

_report

on_close(event)

Handle the close event to clean up resources