Interactive Plotter

.gitignore

@@ -8,6 +8,7 @@ docs/jupyter_execute/
 docs/jupyter_cache/
 notebooks/examples/data/*.fits
 notebooks/examples/output/*
+src/dysh/plot/.dev
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

docs/source/design/index.rst

@@ -9,3 +9,4 @@ Stuff about the overall design
 
    sdfits_loaders
    structure
+   plotter/index

docs/source/design/plotter/dev_status.rst

@@ -0,0 +1,34 @@
+*****************
+Design and Status
+*****************
+
+The plotter is based off of `PyQt` with `PyQtGraph`.
+
+Plot Types
+==========
+Each type of plot will be defined by its own plot class with a specific `PyQtGraph` widget.
+
+`SingleSpectrum`
+--------------
+
+A `SingleSpectrum` plot will display a single frquency-vs-intensity `spectrum` object.
+
+Waterfall
+---------
+
+This plot type has not been implemented.
+
+Selection Areas
+===============
+
+Different plot types may require different types of selection.
+
+Single-Point selection
+----------------------
+
+On spectra, users may one to be able to click on individual points to create a selection. This feature has not been implemented yet.
+
+Rectangular Region of Interest (ROI)
+------------------------------------
+
+A selection object on the plot is defined as a rectangular  Region of Interest (ROI).

docs/source/design/plotter/index.rst

@@ -0,0 +1,11 @@
+***********************
+The Interactive Plotter
+***********************
+
+Stuff about the interactive plotter
+
+.. toctree::
+   :maxdepth: 2
+
+   renderer
+   dev_status

docs/source/design/plotter/renderer.rst

@@ -0,0 +1,31 @@
+*******************
+Choosing a Renderer
+*******************
+
+There are several different situations in which one might use the plotter, and it must render and be interactive in all of them.
+
+.. mermaid::
+
+    flowchart TD
+        A[Detect Renderer] --> B[Script]
+        A[Detect Renderer] --> C[iPython]
+        A[Detect Renderer] --> D[Notebook]
+
+        B --> E[SpectrumSelectApp]
+        C --> |new thread| E[SpectrumSelectApp]
+        D --> F[SingleSpectrum]
+
+Scripting
+=========
+
+If a user wants the interactive plotter to appear during or after a script execution, it must appear as a pop-up window.
+
+iPython
+=======
+
+The plotter must appear when called during an iPython session, and it must stay open and respond while new commands are entered.
+
+Notebooks
+=========
+
+The plotter must render beneath a notebook cell when it is called. The plot need only update when the cell is re-run.

docs/source/index.rst

@@ -17,6 +17,7 @@ Contents
    whatsnew/0.3.rst
    background/index
    getting_started/index
+   design/index
    examples/index
    modules/index
    for_beta_testers/index

pyproject.toml

@@ -58,7 +58,15 @@ nb = [
   "jupyter",
   "jupyterlab",
 ]
-all = ["dysh[dev,nb]"]
+gui = [
+  "pyqt5",
+  "pyqt5-qt5==5.15.14 ; platform_system != \"Windows\"",
+  "pyqt5-qt5==5.15.2 ; platform_system == \"Windows\"",
+  "pyqtgraph",
+  "qt_material",
+  "screeninfo",
+]
+all = ["dysh[dev,nb,gui]"]
 
 [project.urls]
 Documentation = "https://github.com/GreenBankObservatory/dysh#readme"
@@ -188,7 +196,7 @@ filterwarnings = [
 
 [tool.pip-tools]
 src_files = ["pyproject.toml"]
-extra = ["nb", "dev"]
+extra = ["nb", "dev", "gui"]
 resolver = "backtracking"
 output_file= "requirements.txt"
 no_strip_extras = true