summaryrefslogtreecommitdiff
path: root/code/frontEnd/TerminalUI.rst
diff options
context:
space:
mode:
Diffstat (limited to 'code/frontEnd/TerminalUI.rst')
-rw-r--r--code/frontEnd/TerminalUI.rst25
1 files changed, 25 insertions, 0 deletions
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