diff --git a/b_asic/gui_utils/plot_window.py b/b_asic/gui_utils/plot_window.py index 9d1ec1b68c9577de3670b4f19ae106088426d106..8f4b33493276b786382f29b47f4eeb2ea52ed154 100644 --- a/b_asic/gui_utils/plot_window.py +++ b/b_asic/gui_utils/plot_window.py @@ -197,6 +197,17 @@ class PlotWindow(QDialog): def start_simulation_dialog( sim_results: Dict[str, List[complex]], sfg_name: Optional[str] = None ): + """ + Display the simulation results window. + + Parameters + ---------- + sim_results : dict + Simulation results of the form obtained from :attr:`~b_asic.simulation.Simulation.results`. + sfg_name : str, optional + DESCRIPTION. The default is None. + + """ app = QApplication(sys.argv) win = PlotWindow(sim_result=sim_results, sfg_name=sfg_name) win.exec_() diff --git a/docs_sphinx/gui_utils.rst b/docs_sphinx/gui_utils.rst index 2396b29cd4565df5be5043e05417ced43a893285..50e0d0bc3e3db884ec7d2700e97f910cd5b4c9a8 100644 --- a/docs_sphinx/gui_utils.rst +++ b/docs_sphinx/gui_utils.rst @@ -7,3 +7,11 @@ gui\_utils.about\_window module .. automodule:: b_asic.gui_utils.about_window :members: :undoc-members: + + +gui\_utils.plot\_window module +------------------------------- + +.. automodule:: b_asic.gui_utils.plot_window + :members: + :undoc-members: