sciwidgets 0.1.2__tar.gz

sciwidgets-0.1.2/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,142 @@
+# 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/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sciwidgets"
+version = "0.1.2"
+description = "PySide6 widgets for scientific desktop apps: math labels, sliders, parameter inputs and dialogs"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Vahid Anari", email = "vahid.anari8@gmail.com" }]
+keywords = [
+    "pyside6", "qt", "gui", "widgets", "scientific",
+    "slider", "range-slider", "latex", "matplotlib", "dialogs",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: User Interfaces",
+]
+dependencies = [
+    "PySide6>=6.5,<7",
+    "matplotlib>=3.7",
+    "numpy>=1.24",
+]
+
+[project.optional-dependencies]
+dev = ["build", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/vahid-anari/sciwidgets"
+Repository = "https://github.com/vahid-anari/sciwidgets"
+Issues = "https://github.com/vahid-anari/sciwidgets/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"*" = ["*.svg", "*.png"]

sciwidgets-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sciwidgets-0.1.2/src/sciwidgets/__init__.py

@@ -0,0 +1,8 @@
+"""PySide6 widgets for scientific desktop apps."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("sciwidgets")
+except PackageNotFoundError:
+    __version__ = "0+unknown"

sciwidgets-0.1.2/src/sciwidgets/dialogs/__init__.py

@@ -0,0 +1,31 @@
+from .message_dialogs import (
+    AboutDialog,
+    AskDialog,
+    AskResult,
+    DialogIcon,
+    InfoDialog,
+    MessageDialog,
+    TitledDialogBase,
+    ask_question,
+    show_about_dialog,
+    show_critical,
+    show_information,
+    show_rich_information,
+    show_warning,
+)
+
+__all__ = [
+    "AboutDialog",
+    "AskDialog",
+    "AskResult",
+    "DialogIcon",
+    "InfoDialog",
+    "MessageDialog",
+    "TitledDialogBase",
+    "ask_question",
+    "show_about_dialog",
+    "show_critical",
+    "show_information",
+    "show_rich_information",
+    "show_warning",
+]

sciwidgets-0.1.2/src/sciwidgets/dialogs/__main__.py

@@ -0,0 +1,128 @@
+"""Demo for the dialogs subpackage: ``python -m sciwidgets.dialogs``."""
+
+import sys
+
+from PySide6.QtWidgets import (
+    QApplication, QHBoxLayout, QPushButton, QStyle, QVBoxLayout, QWidget,
+)
+
+from sciwidgets.dialogs.message_dialogs import (
+    ask_question,
+    show_about_dialog,
+    show_critical,
+    show_information,
+    show_rich_information,
+    show_warning,
+)
+
+
+def _demo_main() -> int:
+    """Run a window with one button per dialog helper.
+
+    Returns:
+        int: Qt application exit code.
+    """
+    app = QApplication(sys.argv)
+    win = QWidget()
+    win.setWindowTitle("Dialogs demo")
+
+    # --- Questions --------------------------------------------------------
+    def ask_save() -> None:
+        r = ask_question(
+            "Unsaved Changes",
+            "Do you want to save your changes before closing?",
+            "Your modifications will be lost if you close without saving.",
+            yes_btn_label="Save", no_btn_label="Don't Save", parent=win,
+        )
+        print("ask (save):", r)
+
+    def ask_yes_no() -> None:
+        r = ask_question(
+            "Continue", "Do you want to continue?",
+            "Yes continues the operation.\nNo stops without changes.",
+            no_btn_label="No", parent=win,
+        )
+        print("ask (yes/no):", r)
+
+    def ask_two_buttons() -> None:
+        r = ask_question(
+            "Delete File", "Do you want to delete this file?",
+            "This action cannot be undone.",
+            yes_btn_label="Delete", parent=win,
+        )
+        print("ask (two buttons):", r)
+
+    # --- Messages ---------------------------------------------------------
+    def info() -> None:
+        show_information(
+            "Data Information", "The data file was loaded successfully.",
+            "128 rows were read and validated.\nNo missing values were found.",
+            parent=win,
+        )
+
+    def warning() -> None:
+        show_warning(
+            "Overwrite File", "A file with this name already exists.",
+            "Saving now will replace the existing file.", parent=win,
+        )
+
+    def critical() -> None:
+        show_critical(
+            "Load Error", "The selected file could not be opened.",
+            "Check that the file exists and that you can read it.", parent=win,
+        )
+
+    def rich_info() -> None:
+        show_rich_information(
+            "Notes",
+            "<b>Rich information dialog</b><br><br>"
+            "Useful for longer help text, with selectable text, a copy "
+            "button, and links: "
+            '<a href="https://doc.qt.io/qtforpython-6/">Qt for Python docs</a>',
+            parent=win,
+        )
+
+    # --- About ------------------------------------------------------------
+    about_html = (
+        "A demo application for <b>sciwidgets</b>.<br><br>"
+        "<b>Version:</b> 0.1.0<br>"
+        '<b>Docs:</b> <a href="https://doc.qt.io/qtforpython-6/">Qt for Python</a>'
+    )
+
+    def about_default() -> None:
+        # No app icon is set in this demo, so the information icon is used.
+        show_about_dialog("About Demo", about_html, parent=win)
+
+    def about_custom_icon() -> None:
+        icon = win.style().standardIcon(QStyle.SP_ComputerIcon)
+        show_about_dialog("About Demo", about_html, parent=win, icon=icon)
+
+    # --- Layout -----------------------------------------------------------
+    columns = [
+        [("Ask: Save / Don't Save / Cancel", ask_save),
+         ("Ask: Yes / No / Cancel", ask_yes_no),
+         ("Ask: Delete / Cancel", ask_two_buttons)],
+        [("Information", info),
+         ("Warning", warning),
+         ("Critical", critical),
+         ("Rich information", rich_info)],
+        [("About (default icon)", about_default),
+         ("About (custom icon)", about_custom_icon)],
+    ]
+
+    row = QHBoxLayout(win)
+    for buttons in columns:
+        col = QVBoxLayout()
+        for text, slot in buttons:
+            btn = QPushButton(text)
+            btn.clicked.connect(slot)
+            col.addWidget(btn)
+        col.addStretch(1)
+        row.addLayout(col)
+
+    win.show()
+    return app.exec()
+
+
+if __name__ == "__main__":
+    raise SystemExit(_demo_main())