From ec553c1b988f714ff1d39efaa81867a244f2bb1d Mon Sep 17 00:00:00 2001
From: Oscar Gustafsson <oscar.gustafsson@gmail.com>
Date: Fri, 24 Feb 2023 09:50:35 +0100
Subject: [PATCH] Add plot window to documentation. Closes #178
---
b_asic/gui_utils/plot_window.py | 11 +++++++++++
docs_sphinx/gui_utils.rst | 8 ++++++++
2 files changed, 19 insertions(+)
diff --git a/b_asic/gui_utils/plot_window.py b/b_asic/gui_utils/plot_window.py
index 9d1ec1b6..8f4b3349 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 2396b29c..50e0d0bc 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:
--
GitLab