diff options
Diffstat (limited to 'code/frontEnd')
-rw-r--r-- | code/frontEnd/Application.rst | 8 | ||||
-rw-r--r-- | code/frontEnd/DockArea.rst | 4 | ||||
-rw-r--r-- | code/frontEnd/ProjectExplorer.rst | 9 | ||||
-rw-r--r-- | code/frontEnd/TerminalUI.rst | 25 | ||||
-rw-r--r-- | code/frontEnd/Workspace.rst | 11 |
5 files changed, 55 insertions, 2 deletions
diff --git a/code/frontEnd/Application.rst b/code/frontEnd/Application.rst index 4eb41d17..46516da4 100644 --- a/code/frontEnd/Application.rst +++ b/code/frontEnd/Application.rst @@ -1,5 +1,11 @@ Application Component -===================== +======================= + +.. note:: + + Source : ``/src/frontEnd/Application.py`` + +It contains all the methods responsible for navigation of top and left navbar icons .. automodule:: frontEnd.Application :members: diff --git a/code/frontEnd/DockArea.rst b/code/frontEnd/DockArea.rst index 31fdd742..b450860c 100644 --- a/code/frontEnd/DockArea.rst +++ b/code/frontEnd/DockArea.rst @@ -1,5 +1,9 @@ Dock Area Component =================== +.. note:: + + Source : ``/src/frontEnd/DockArea.py`` + .. automodule:: frontEnd.DockArea :members: diff --git a/code/frontEnd/ProjectExplorer.rst b/code/frontEnd/ProjectExplorer.rst index 33dec0c0..5d69a676 100644 --- a/code/frontEnd/ProjectExplorer.rst +++ b/code/frontEnd/ProjectExplorer.rst @@ -1,5 +1,14 @@ Project Explorer Component ========================== +.. image:: ../_static/projectExplorer.png + :alt: Screenshot of the Welcome page + :align: left + :scale: 80% + +.. note:: + + Source : ``/src/frontEnd/projectExplorer.py`` + .. automodule:: frontEnd.ProjectExplorer :members: diff --git a/code/frontEnd/TerminalUI.rst b/code/frontEnd/TerminalUI.rst new file mode 100644 index 00000000..5fb472b1 --- /dev/null +++ b/code/frontEnd/TerminalUI.rst @@ -0,0 +1,25 @@ +TerminalUI Component +==================== + +The TerminalUI component provides a graphical interface for monitoring and controlling ngspice simulations within eSim. It features a progress bar, a simulation log console, and buttons for toggling light/dark mode, cancelling, and re-running simulations. + +.. image:: ../_static/TerminalUI.png + :alt: Terminal UI + :align: center + :scale: 60% + +**Features:** +- Displays real-time simulation logs and progress. +- Allows users to cancel or redo simulations. +- Supports toggling between light and dark modes for better visibility. +- Integrates with ngspice using PyQt5's QProcess for process management. + +**Usage:** +The TerminalUI is automatically launched during simulation runs. Users can interact with the simulation process using the provided buttons and view logs in the console area. + +.. note:: + + Source : ``src/frontEnd/TerminalUi.py`` + +.. automodule:: frontEnd.TerminalUi + :members:
\ No newline at end of file diff --git a/code/frontEnd/Workspace.rst b/code/frontEnd/Workspace.rst index 8722c745..8c3c2efb 100644 --- a/code/frontEnd/Workspace.rst +++ b/code/frontEnd/Workspace.rst @@ -1,5 +1,14 @@ Workspace Component =================== +.. image:: ../_static/workspace.png + :alt: Workspace + :align: left + :scale: 80% + +.. note:: + + Source : ``/src/frontEnd/Workspace.py`` + .. automodule:: frontEnd.Workspace - :members: + :members: |