PyMieSimX 0.1.0__tar.gz

pymiesimx-0.1.0/.coveragerc

@@ -0,0 +1,25 @@
+[run]
+source = PyMieSimX
+branch = True
+relative_files = True
+parallel = True
+omit =
+    **/__init__.py
+    PyMieSimX/**/__main__.py
+
+[report]
+skip_covered = True
+show_missing = True
+precision = 2
+
+[html]
+directory = htmlcov
+
+[xml]
+output = coverage.xml
+
+[paths]
+source =
+    PyMieSimX
+    /home/runner/work/PyMieSimX/PyMieSimX/PyMieSimX
+    /github/workspace/PyMieSimX

pymiesimx-0.1.0/.flake8

@@ -0,0 +1,11 @@
+[flake8]
+max-line-length = 300
+exclude =
+    .git
+    docs/build
+    docs/source/gallery
+    development
+
+count = true
+per-file-ignores =
+    __init__.py: F403, F401

pymiesimx-0.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# Specify reviewers for pull requests
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: "master"
+    schedule:
+      interval: "monthly"
+      day: "sunday"
+      time: "09:00"

pymiesimx-0.1.0/.github/workflows/deploy_PyPi.yml

@@ -0,0 +1,19 @@
+name: Deploy to PyPI
+
+on:
+  push:
+    branches: ["master"]
+    tags: ["*"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: read
+
+jobs:
+  PyPI:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_pure_package_to_PyPi.yml@master
+    with:
+      python-version: "3.11"
+    secrets:
+      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

pymiesimx-0.1.0/.github/workflows/deploy_anaconda.yml

@@ -0,0 +1,21 @@
+name: Deploy Conda Packages
+
+on:
+  push:
+    branches: [ "master" ]
+    tags: '*'
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+    contents: write
+
+jobs:
+  linux:
+    uses: MartinPdeS/MPSActions/.github/workflows/publish_compiled_package_to_anaconda.yml@master
+    with:
+      python_versions: '["3.11", "3.12", "3.13"]'
+      apt_package: ""
+      os_list: '["ubuntu-latest", "macos-latest", "windows-latest"]'
+    secrets:
+      ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }}

pymiesimx-0.1.0/.github/workflows/deploy_coverage.yml

@@ -0,0 +1,51 @@
+name: Deploy GUI coverage
+
+on:
+  push:
+    branches: ["master"]
+    tags: ["*"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  coverage:
+    name: Run GUI tests and publish coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install package and test dependencies
+        run: |
+          python -m pip install --upgrade pip wheel build
+          python -m pip install -e ".[testing]"
+
+      - name: Run GUI tests with coverage
+        run: |
+          coverage erase
+          python -m pytest \
+            --import-mode=importlib \
+            --cov=PyMieSimX \
+            --cov-config=.coveragerc \
+            --cov-report=term-missing \
+            --cov-report=xml:coverage.xml \
+            tests/gui \
+            --config-file=pytest.ini
+
+      - name: Post coverage comment
+        if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MINIMUM_GREEN: 90
+          MINIMUM_ORANGE: 50
+          COVERAGE_PATH: .

pymiesimx-0.1.0/.github/workflows/quality.yml

@@ -0,0 +1,30 @@
+name: Quality and GUI tests
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: read
+
+jobs:
+  python-quality:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package and quality tools
+        run: python -m pip install --upgrade pip && python -m pip install -e ".[testing,dev]"
+      - name: Ruff
+        run: python -m ruff check PyMieSimX tests
+      - name: Mypy
+        run: python -m mypy PyMieSimX/gui/parsing.py PyMieSimX/gui/schemas.py
+      - name: GUI tests
+        run: python -m pytest

pymiesimx-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+build/
+dist/
+.coverage
+htmlcov/
+.DS_Store

pymiesimx-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-yaml
+      - id: check-toml
+      - id: detect-private-key
+      - id: check-json
+      - id: check-case-conflict
+
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2
+    hooks:
+      - id: ruff
+        args: [--output-format, concise]

pymiesimx-0.1.0/Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.11-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1
+
+WORKDIR /app
+COPY . .
+
+RUN python -m pip install --upgrade pip \
+    && python -m pip install --no-cache-dir .
+
+CMD ["sh", "-c", "exec gunicorn PyMieSimX.gui.interface:app --bind 0.0.0.0:${PORT:-8050} --workers 1 --threads 2 --timeout 3600"]

pymiesimx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Martin Poinsinet de Sivry-Houle
+
+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.

pymiesimx-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: PyMieSimX
+Version: 0.1.0
+Summary: Graphical Dash interface for PyMieSim.
+Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2020 Martin Poinsinet de Sivry-Houle
+        
+        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.
+        
+Project-URL: Repository, https://github.com/MartinPdeS/PyMieSimX
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: PyMieSim>=5.1.2
+Requires-Dist: dash>=4.1.0
+Requires-Dist: gunicorn>=23.0.0
+Requires-Dist: numpy>=2.0
+Requires-Dist: pandas>=2.2
+Requires-Dist: plotly<7,>=5.24
+Provides-Extra: testing
+Requires-Dist: pytest>=8.0; extra == "testing"
+Requires-Dist: pytest-cov>=5.0; extra == "testing"
+Requires-Dist: coverage>=7.0; extra == "testing"
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: mypy==1.15.0; extra == "dev"
+Requires-Dist: ruff==0.11.2; extra == "dev"
+Dynamic: license-file
+
+PyMieSimX
+=========
+
+PyMieSimX is the standalone graphical interface for `PyMieSim
+<https://github.com/MartinPdeS/PyMieSim>`_. It provides a Dash application for
+configuring optical setups, running parameter sweeps, exploring individual
+particles, and exporting results.
+
+Installation
+------------
+
+Install the GUI and its PyMieSim dependency with::
+
+    pip install PyMieSimX
+
+Launch the dashboard with::
+
+    pymiesimx
+
+Use ``pymiesimx --help`` to see the available host, port, browser, and debug
+options.
+
+Development
+-----------
+
+Install an editable checkout with::
+
+    pip install -e .
+
+The GUI source lives in ``PyMieSimX/gui``. Scientific calculations are provided
+by the installed ``PyMieSim`` package rather than duplicated here.
+
+Testing and automation
+----------------------
+
+Run the GUI test suite with::
+
+    pip install -e ".[testing]"
+    python -m pytest
+
+GitHub Actions includes quality checks, GUI tests, PyPI publishing, Conda
+recipe publishing, and coverage deployment. The Conda recipe is in
+``meta.yaml`` and the container entry point is defined in ``Dockerfile``.

pymiesimx-0.1.0/PyMieSimX/__init__.py

@@ -0,0 +1,5 @@
+"""Dash graphical interface for PyMieSim."""
+
+from PyMieSimX.gui.interface import OpticalSetupGUI, create_dash_app
+
+__all__ = ["OpticalSetupGUI", "create_dash_app"]

pymiesimx-0.1.0/PyMieSimX/__main__.py

@@ -0,0 +1,35 @@
+"""Entry point for launching the PyMieSimX dashboard."""
+
+import argparse
+import logging
+
+from PyMieSimX.gui.interface import OpticalSetupGUI
+
+
+def _build_argument_parser() -> argparse.ArgumentParser:
+    """Create the CLI parser for the dashboard launcher."""
+    parser = argparse.ArgumentParser(description="Launch the PyMieSimX dashboard.")
+    parser.add_argument("--host", default="0.0.0.0", help="Host interface for the Dash server.")
+    parser.add_argument("--port", default="8050", help="Port for the Dash server.")
+    parser.add_argument("--debug", action="store_true", help="Enable Dash debug mode and verbose debug logging.")
+    parser.add_argument("--no-browser", action="store_true", help="Start the server without opening a browser window.")
+    return parser
+
+
+def main(argv: list[str] | None = None) -> None:
+    """Launch the PyMieSimX dashboard from a console entry point."""
+    args = _build_argument_parser().parse_args(argv)
+    logging.basicConfig(
+        level=logging.DEBUG if args.debug else logging.INFO,
+        format="%(asctime)s | %(levelname)s | %(name)s | %(message)s",
+    )
+    OpticalSetupGUI().run(
+        host=args.host,
+        port=args.port,
+        open_browser=not args.no_browser,
+        debug=args.debug,
+    )
+
+
+if __name__ == "__main__":
+    main()

pymiesimx-0.1.0/PyMieSimX/gui/__init__.py

@@ -0,0 +1,5 @@
+"""Dash dashboard for configuring and running PyMieSim experiment sets."""
+
+from PyMieSimX.gui.interface import OpticalSetupGUI, create_dash_app
+
+__all__ = ["OpticalSetupGUI", "create_dash_app"]

pymiesimx-0.1.0/PyMieSimX/gui/assets/card-state.js

@@ -0,0 +1,41 @@
+(function () {
+  "use strict";
+
+  const storagePrefix = "pymiesim-card-state:";
+
+  function restoreCard(card) {
+    if (!card.id || !card.matches("details.workflow-card")) {
+      return;
+    }
+
+    const savedState = window.sessionStorage.getItem(storagePrefix + card.id);
+    if (savedState === "open") {
+      card.open = true;
+    } else if (savedState === "closed") {
+      card.open = false;
+    }
+
+    if (!card.dataset.statePersistenceBound) {
+      card.addEventListener("toggle", function () {
+        window.sessionStorage.setItem(storagePrefix + card.id, card.open ? "open" : "closed");
+      });
+      card.dataset.statePersistenceBound = "true";
+    }
+  }
+
+  function scan(root) {
+    if (root instanceof HTMLElement) {
+      restoreCard(root);
+      root.querySelectorAll("details.workflow-card").forEach(restoreCard);
+    }
+  }
+
+  document.addEventListener("DOMContentLoaded", function () {
+    scan(document.body);
+    new MutationObserver(function (mutations) {
+      mutations.forEach(function (mutation) {
+        mutation.addedNodes.forEach(scan);
+      });
+    }).observe(document.body, { childList: true, subtree: true });
+  });
+})();