sciwidgets 0.1.2__py3-none-any.whl

sciwidgets/params/toggle.py

@@ -0,0 +1,116 @@
+"""Boolean parameter widget backed by a checkbox with an optional state label."""
+
+from __future__ import annotations
+
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QGridLayout, QWidget, QCheckBox, QStackedWidget
+
+from ..labels import MathLabel
+from .base import ParameterWidgetBase
+
+
+class ParameterToggle(ParameterWidgetBase[bool]):
+    """Parameter widget with a checkbox and an optional state-dependent label."""
+
+    def __init__(
+            self,
+            text: str,
+            label_on: str | None = None,
+            label_off: str | None = None,
+            checked: bool = True,
+            parent: QWidget | None = None,
+    ) -> None:
+        """Initialize the toggle widget.
+
+        Args:
+            text: Checkbox text.
+            label_on: Label shown when the checkbox is checked. ``None`` shows
+                nothing in that state.
+            label_off: Label shown when the checkbox is unchecked. ``None``
+                shows nothing in that state.
+            checked: Initial checked state.
+            parent: Optional parent widget.
+        """
+
+        super().__init__(parent)
+
+        self._check = QCheckBox(text, self)
+        self._check.setChecked(checked)
+        self._stack: QStackedWidget | None = None
+        if label_on is not None or label_off is not None:
+            self._stack = QStackedWidget(self)
+            align = Qt.AlignRight | Qt.AlignVCenter
+            for lbl in (label_off, label_on):  # index 0 = off, 1 = on
+                self._stack.addWidget(
+                    MathLabel(lbl, alignment=align, fix_size=True) if lbl is not None else QWidget()
+                )
+            self._stack.setCurrentIndex(int(checked))
+
+        self._check.toggled.connect(self._sync_label)
+        self._check.clicked.connect(self._on_clicked)
+
+        self._make_layout()
+
+    def _make_layout(self) -> None:
+        """Create the grid: [name spacer | checkbox | stretch | label | value spacer]."""
+
+        gl = QGridLayout(self)
+        gl.setSpacing(0)
+        gl.setContentsMargins(0, 0, 0, 0)
+        gl.addWidget(self._check, 0, 1)
+        if self._stack is not None:
+            gl.addWidget(self._stack, 0, 3, Qt.AlignRight | Qt.AlignVCenter)
+        gl.setColumnStretch(2, 1)
+        self._gl = gl
+        self._update_layout()
+
+    def _update_layout(self) -> None:
+        """Indent the checkbox by half the shared name width of sibling widgets."""
+        self._gl.setColumnMinimumWidth(0, self._effective_name_width() // 2)
+
+    def _sync_label(self, state: bool) -> None:
+        """Show the label for the current state (any change)."""
+        if self._stack is not None:
+            self._stack.setCurrentIndex(int(state))
+
+    def _on_clicked(self, state: bool) -> None:
+        """Emit the new value after a user click."""
+        self.valueChanged.emit(state)
+
+    def get_value(self) -> bool:
+        """Return whether the checkbox is checked.
+
+        Returns:
+            Current checked state.
+        """
+
+        return self._check.isChecked()
+
+    def _validate_value(self, value: bool) -> bool:
+        """Validate a value before applying it.
+
+        Args:
+            value: Proposed checked state.
+
+        Returns:
+            Validated checked state.
+
+        Raises:
+            TypeError: If ``value`` is not a bool.
+        """
+
+        if not isinstance(value, bool):
+            raise TypeError("'value' must be a bool")
+        return value
+
+    def _apply_value(self, value: bool) -> None:
+        """Apply a validated value to the checkbox.
+
+        The label follows automatically through the ``toggled`` signal.
+
+        Args:
+            value: Checked state to apply.
+        """
+
+        self._check.setChecked(value)
+

sciwidgets/style.py

@@ -0,0 +1,175 @@
+"""Qt style and style-sheet fragments that sciwidgets widgets rely on.
+
+The parameter widgets depend on these for behaviour and appearance (click-to-
+position sliders, disabled slider grooves, the red frame on invalid numeric
+input, value-label colors). Apps should call::
+
+    app.setStyle(SciStyle())
+    app.setStyleSheet(widget_style_sheet(app) + app_specific_sheet)
+"""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from PySide6.QtCore import Qt
+from PySide6.QtGui import QColor, QPen
+from PySide6.QtWidgets import (
+    QApplication,
+    QLineEdit,
+    QProxyStyle,
+    QStyle,
+    QStyleFactory,
+    QStyleOptionSlider,
+)
+
+__all__ = ["SciStyle", "sci_style_sheet", "apply_sci_style"]
+
+
+class SciStyle(QProxyStyle):
+    """Fusion-based proxy style required by the sciwidgets widgets."""
+
+    def __init__(self):
+        """Initialize the proxy style with Fusion as the base style."""
+
+        base = QStyleFactory.create("Fusion")
+        super().__init__(base)
+
+    def styleHint(self, hint, option=None, widget=None, returnData=None):
+        """Return a Qt style hint for the requested control.
+
+        Args:
+            hint: Requested style-hint identifier.
+            option: Optional style option associated with the request.
+            widget: Optional widget associated with the request.
+            returnData: Optional return-data holder supplied by Qt.
+
+        Returns:
+            Style-hint value for the requested control.
+        """
+
+        if hint == QStyle.SH_Slider_AbsoluteSetButtons:
+            return Qt.LeftButton.value
+        if hint == QStyle.SH_Slider_PageSetButtons:
+            return 0
+        return super().styleHint(hint, option, widget, returnData)
+
+    def drawComplexControl(self, control, option, painter, widget=None):
+        """Draw a customized Qt complex control.
+
+        Args:
+            control: Complex-control type to draw.
+            option: Style option describing the control state.
+            painter: Painter used for rendering.
+            widget: Optional widget being drawn.
+        """
+
+        if control == QStyle.CC_Slider and isinstance(option, QStyleOptionSlider):
+            if not (option.state & QStyle.State_Enabled):
+                requested = option.subControls
+                if requested == QStyle.SC_None:
+                    requested = (
+                        QStyle.SC_SliderGroove
+                        | QStyle.SC_SliderHandle
+                        | QStyle.SC_SliderTickmarks
+                    )
+
+                if requested & QStyle.SC_SliderGroove:
+                    groove_rect = self.subControlRect(
+                        QStyle.CC_Slider,
+                        option,
+                        QStyle.SC_SliderGroove,
+                        widget,
+                    )
+
+                    painter.save()
+                    painter.setPen(QPen(QColor("#b3b3b3"), 1))
+                    painter.setBrush(QColor("#cccccc"))
+                    r = groove_rect.adjusted(1, 2, -1, -1)
+                    painter.drawRoundedRect(r, 1, 1)
+                    painter.restore()
+
+                fg = requested & (QStyle.SC_SliderTickmarks | QStyle.SC_SliderHandle)
+                if fg:
+                    opt_fg = QStyleOptionSlider(option)
+                    opt_fg.subControls = fg
+                    super().drawComplexControl(control, opt_fg, painter, widget)
+
+                return
+
+            return super().drawComplexControl(control, option, painter, widget)
+
+        return super().drawComplexControl(control, option, painter, widget)
+
+    def drawPrimitive(self, element, option, painter, widget=None):
+        """Draw a customized Qt primitive element.
+
+        Args:
+            element: Primitive-element type to draw.
+            option: Style option describing the primitive state.
+            painter: Painter used for rendering.
+            widget: Optional widget being drawn.
+        """
+
+        super().drawPrimitive(element, option, painter, widget)
+
+        if element == QStyle.PE_PanelLineEdit and isinstance(widget, QLineEdit):
+            if (option.state & QStyle.State_Enabled) and bool(widget.property("invalid")):
+                painter.save()
+                try:
+                    pen = QPen(QColor("#d32f2f"))
+                    pen.setWidth(3)
+                    pen.setCapStyle(Qt.RoundCap)
+                    pen.setJoinStyle(Qt.RoundJoin)
+                    painter.setPen(pen)
+                    painter.setBrush(Qt.NoBrush)
+                    r = option.rect.adjusted(1, 1, -1, -1)
+                    painter.drawRect(r)
+                finally:
+                    painter.restore()
+
+def _font_rule(selector: str, size: int, family: str, color: Optional[str] = None) -> str:
+    """Build a font (and optional color) rule for one selector."""
+    rule = f"{selector}{{font-size: {size}pt; font-family: {family};"
+    if color is None:
+        return rule + "}"
+    c = QColor(color)
+    disabled = QColor(color)
+    disabled.setAlpha(50)
+    return (
+        rule + f"color: {c.name()};}}"
+        f"{selector}:disabled{{color: {disabled.name(QColor.HexArgb)};}}"
+    )
+
+
+def sci_style_sheet(app: QApplication) -> str:
+    """Return the style-sheet rules the sciwidgets widgets expect.
+
+    Sizes are relative to the application's current font, so call this after
+    the app font is set.
+
+    Args:
+        app: Running application whose font is used as the base.
+
+    Returns:
+        Style-sheet text to include in the app's own style sheet.
+    """
+    f = app.font()
+    fs, fm = f.pointSize(), f.family()
+    return (
+        _font_rule("QLabel#slider_value", fs + 1, fm, "blue")
+        + _font_rule("QLabel#slider_range", fs - 1, fm, "black")
+        + _font_rule("QLineEdit", fs + 1, fm, "blue")
+        + _font_rule("QSpinBox", fs + 1, fm, "blue")
+    )
+
+def apply_sci_style(app: QApplication, extra_style_sheet: str = "") -> None:
+    """Set SciStyle and the sciwidgets style sheet on ``app``.
+
+    Args:
+        app: Application to style.
+        extra_style_sheet: App-specific rules appended after the
+            sciwidgets rules.
+    """
+    app.setStyle(SciStyle())
+    app.setStyleSheet(sci_style_sheet(app) + extra_style_sheet)

sciwidgets-0.1.2.dist-info/METADATA

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: sciwidgets
+Version: 0.1.2
+Summary: PySide6 widgets for scientific desktop apps: math labels, sliders, parameter inputs and dialogs
+Author-email: Vahid Anari <vahid.anari8@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/vahid-anari/sciwidgets
+Project-URL: Repository, https://github.com/vahid-anari/sciwidgets
+Project-URL: Issues, https://github.com/vahid-anari/sciwidgets/issues
+Keywords: pyside6,qt,gui,widgets,scientific,slider,range-slider,latex,matplotlib,dialogs
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PySide6<7,>=6.5
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: numpy>=1.24
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# sciwidgets
+
+PySide6 widgets for scientific desktop apps: math labels rendered with
+LaTeX/mathtext, dialogs, and parameter inputs such as sliders, range sliders
+and validated number fields.
+
+![Sliders demo](https://raw.githubusercontent.com/vahid-anari/sciwidgets/main/docs/images/sliders_demo.png)
+
+Right-click menu, Set Value and Edit Configuration:
+
+![Slider interaction](https://raw.githubusercontent.com/vahid-anari/sciwidgets/main/docs/images/sliders_demo.gif)
+
+The widgets were written for the
+[Maxwell Bloch Solver](https://github.com/vahid-anari/maxwell-bloch-solver)
+and moved into this package so other apps can share them.
+
+## Features
+
+- **Math labels**: `MathLabel` renders LaTeX through Matplotlib and scales
+  cleanly as SVG. It uses your system LaTeX when installed and falls back to
+  Matplotlib's mathtext otherwise.
+- **Sliders**: integer, float, array, range and multi-variable sliders with
+  LaTeX names and units, optional range labels, a default-value marker and a
+  right-click menu (save/reset default, set value, ±inf, edit range and format).
+- **Scientific number format**: `"{:.3S}"` displays values as `1.23×10⁴`.
+- **Validated input**: `NumericLineEdit` checks numbers and limits while typing
+  and marks invalid input with a red frame.
+- **Parameter widgets**: line edit, combo box and toggle sharing one interface
+  with the sliders (`get_value` / `set_value`, `get_config` / `set_config`) and
+  name/value columns that line up across a panel.
+- **Dialogs**: information, warning, error, question, rich-text and About
+  dialogs.
+
+## Components
+
+| Import | Contents |
+|--------|----------|
+| `sciwidgets.labels` | `MathLabel` (LaTeX/mathtext label), `set_latex_enabled` |
+| `sciwidgets.params` | `FloatSlider`, `IntSlider`, `ArraySlider`, `FloatRangeSlider`, `IntRangeSlider`, `MultiVariableSlider`, `ParameterLineEdit`, `ParameterComboBox`, `ParameterToggle`, `NumericLineEdit`, `SliderFeature` |
+| `sciwidgets.dialogs` | `show_information`, `show_warning`, `show_critical`, `show_rich_information`, `show_about_dialog`, `ask_question`, `AskResult` |
+| `sciwidgets.style` | `SciStyle`, `apply_sci_style`, `sci_style_sheet` |
+| `sciwidgets.formatting` | `pretty_sci_text`, `value_to_text` and other format helpers |
+
+## Install
+
+```bash
+pip install sciwidgets
+```
+
+Requires Python 3.10+, PySide6 6.5+, Matplotlib and NumPy (installed
+automatically). A LaTeX installation is optional.
+
+For development, from the repo root:
+
+```bash
+pip install -e .
+```
+
+## Quick start
+
+```python
+import sys
+
+from PySide6.QtWidgets import QApplication, QVBoxLayout, QWidget
+
+from sciwidgets.params import FloatRangeSlider, FloatSlider
+from sciwidgets.style import apply_sci_style
+
+app = QApplication(sys.argv)
+apply_sci_style(app)  # required, see "Style" below
+
+win = QWidget()
+layout = QVBoxLayout(win)
+
+t1 = FloatSlider(
+    label="T_1", unit=r"\mathrm{ms}",
+    min_val=0.1, max_val=10.0, init_val=1.0, val_fmt="{:.2f}",
+    min_limit=0.0, min_limit_inclusive=False,
+)
+band = FloatRangeSlider(
+    label=r"\nu", unit=r"\mathrm{GHz}",
+    min_val=6.60, max_val=6.75, init_vals=(6.65, 6.70), val_fmt="{:.3f}",
+)
+layout.addWidget(t1)
+layout.addWidget(band)
+
+t1.valueChanged.connect(lambda v: print("T1 =", v))
+band.valueChanged.connect(lambda v: print("band =", v["range"]))
+
+win.show()
+sys.exit(app.exec())
+```
+
+Labels and units are written in LaTeX math mode, without the `$` signs.
+
+## Style
+
+The widgets rely on `SciStyle`, a Fusion-based Qt style, for part of their
+behaviour: clicking a slider groove moves the handle there, disabled sliders
+get a flat groove, and invalid numeric input gets a red frame. Apply it once
+at startup:
+
+```python
+from sciwidgets.style import apply_sci_style
+
+apply_sci_style(app, my_app_style_sheet)  # your own rules are appended
+```
+
+## Signals
+
+`valueChanged`, `defaultChanged` and `configChanged` are emitted **only for
+user actions** (dragging, typing, the context menu, dialogs). Setting values
+from code with `set_value`, `set_config` and similar methods is silent, so
+loading saved parameters never triggers your handlers. Read the new state
+with `get_value()` / `get_config()` after setting it.
+
+## Demos
+
+Each subpackage has a runnable demo:
+
+```bash
+python -m sciwidgets.labels
+python -m sciwidgets.dialogs
+python -m sciwidgets.params
+python -m sciwidgets.params.sliders
+```
+
+## Versions
+
+Releases are Git tags following [semantic versioning](https://semver.org).
+Pin an exact tag in your app's requirements, as in the install line above,
+and move to a newer tag when you are ready to test it.
+
+## License
+
+MIT License. See [LICENSE](https://github.com/vahid-anari/sciwidgets/blob/main/LICENSE).
+
+## Author
+
+Vahid Anari ·
+[GitHub](https://github.com/vahid-anari) ·
+[LinkedIn](https://www.linkedin.com/in/vahid-anari/)

sciwidgets-0.1.2.dist-info/RECORD

@@ -0,0 +1,30 @@
+sciwidgets/__init__.py,sha256=r-K30aP-g6CZlFJ-EqYPHT3gS9g4ZVHggSqw-3RBwDk,217
+sciwidgets/formatting.py,sha256=E_CNrkSIEuSgFbkv8TvAULTWwJOXCraiI-ccMN7eV1E,4820
+sciwidgets/style.py,sha256=_yy7ORDvKqF0_-_tBVi2vL0YX1HU_ohEjlE1jeGr0Uo,6236
+sciwidgets/dialogs/__init__.py,sha256=FpBxh_Kj6LdxvIRHppqxoKSDwnrwRxxf3yWJKfvrfUs,567
+sciwidgets/dialogs/__main__.py,sha256=gvw2FNCkYlaYZ_KYPQ9ExbwTHFm46U7UiJ56HsMSZss,4157
+sciwidgets/dialogs/message_dialogs.py,sha256=lSy_7ZPI5eoVs9QF-EZA_hLJ3if4rAePs_q2aX-eWJ0,16097
+sciwidgets/labels/__init__.py,sha256=zPM_aK-eUApoqx4jvE65Y8UVEDNEf7nlEoK5ntydj1A,98
+sciwidgets/labels/__main__.py,sha256=bMGjYBNuspuNpKGwCvMevtuoN0uM_PnNBli1VskpIDA,4488
+sciwidgets/labels/math_label.py,sha256=NGty2sIaEqoKIHVyrga77YevnymUV_WplXF4pqnEIKw,17608
+sciwidgets/params/__init__.py,sha256=q6s6l2MnIgBToTvThmra-ejIYB1BCY04MughQDTh7-c,525
+sciwidgets/params/__main__.py,sha256=gHGRn5z_RnvzFnvOHefBSeWZ-zOy7G3sQM52hVidDcg,2742
+sciwidgets/params/base.py,sha256=HVdCmdHIbKGdy1TpIIl6RuXd16z3YI88oiNkPGCwa8A,6814
+sciwidgets/params/combo_box.py,sha256=GfSHLVdCt3XomHbjGUqacv7JD3AutjSGlZDnaPim9lo,3182
+sciwidgets/params/line_edit.py,sha256=ZZ0qatP6xLPk1hJmHZ9dlo16s-SjVazhiWAFhLWuztk,4638
+sciwidgets/params/numeric_line_edit.py,sha256=dpPafUljI0ESqam0kxyb8EMfEn_qnv1m6_QLjBBP30o,24363
+sciwidgets/params/toggle.py,sha256=RKvBiO9TO053N3PPDCLNeiJX6pGRZ9Aufndoxef2YQg,3733
+sciwidgets/params/sliders/__init__.py,sha256=qjhW36zgKRP8JSQZTK3C8YtR5Yj0VfvBXXQlH11J4L0,775
+sciwidgets/params/sliders/__main__.py,sha256=xXnqhP9EqBuTM1gRy7UXVnzu7xG-NRUbg-YPIsD_F68,7804
+sciwidgets/params/sliders/_defaults.py,sha256=DSn2yMLA05WuE9R8KVqdL87b-776HZdgMpuXmr_24hU,990
+sciwidgets/params/sliders/_dialogs.py,sha256=YKtMvZiXBUau6S3qlOMf3Ie0bvnN0tE8LgfKTPHMygw,5428
+sciwidgets/params/sliders/_right_click_overlay.py,sha256=rHx-DYlthY4huckcRJl1i_9_JpRX1ZLqmknpfJvEiXk,3610
+sciwidgets/params/sliders/base.py,sha256=GqCNdKb6dlSv0CbcvB_lzhA5DcXVRJhH0kR_FOwPZgc,20735
+sciwidgets/params/sliders/multi.py,sha256=cARyUSvn3aRU2qzQJb0RK2NYyMrzXGAoYkiInOObnOo,25931
+sciwidgets/params/sliders/range.py,sha256=e1QPm0t8t3eTYb0GoGfA6qoRQ1U5ljiR6pGzZnDdlYo,66384
+sciwidgets/params/sliders/single.py,sha256=ONzXXqevDD5t1caiK-i4sYEnB_GnvbVIt50PP8hI7lQ,71905
+sciwidgets-0.1.2.dist-info/licenses/LICENSE,sha256=NxE8TJTE_jzmey7jXXehVFF3x5IiTnmgaYA5qrrfj60,1067
+sciwidgets-0.1.2.dist-info/METADATA,sha256=KHv175m02N4bfDhvVROjIQ6oEf-XOqczYByr5Dyu_IM,6094
+sciwidgets-0.1.2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+sciwidgets-0.1.2.dist-info/top_level.txt,sha256=6WV5UP6JbqXIKH-mBiWnQPKT_dfPO3haUSug8fKl0-4,11
+sciwidgets-0.1.2.dist-info/RECORD,,

sciwidgets-0.1.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sciwidgets-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vahid Anari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sciwidgets-0.1.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+sciwidgets