Merge branch 'develop' into rahul-flex/rotated-box-derivatives

Author: rahul-flex

.github/workflows/run_tests.yml

@@ -3,8 +3,12 @@ name: "tidy3d-frontend-tests"
 on:
   workflow_dispatch:
     inputs:
-      run_tests:
-        description: 'Run test suite'
+      remote_tests:
+        description: 'remote-tests'
+        type: boolean
+        default: true
+      local_tests:
+        description: 'local-tests'
         type: boolean
         default: false
   push:
@@ -14,12 +18,85 @@ on:
       - latest
       - develop
       - 'pre/*'
+    types: ['opened', 'reopened', 'synchronize', 'ready_for_review']
+  pull_request_review:
+    types: [submitted]
 
 jobs:
+  determine-test-scope:
+    runs-on: [ inhouse ] 
+    if: |
+      github.event.pull_request.draft == false ||
+      github.ref == 'refs/heads/develop' ||
+      github.event_name == 'workflow_dispatch'
+    outputs:
+      local_tests: ${{ steps.determine-test-type.outputs.local_tests }}
+      remote_tests: ${{ steps.determine-test-type.outputs.remote_tests }}
+    steps:
+      - name: determine-test-type
+        id: determine-test-type
+        env:
+          DRAFT_STATE: ${{ github.event.pull_request.draft }}
+          EVENT_NAME: ${{ github.event_name }}
+          REVIEW_STATE: ${{ github.event.review.state }}
+          REF: ${{ github.ref }}
+          INPUT_LOCAL: ${{ github.event.inputs.local_tests }}
+          INPUT_REMOTE: ${{ github.event.inputs.remote_tests }}
+        run: |
+          echo "Event: $EVENT_NAME"
+          echo "Draft: $DRAFT_STATE"
+          echo "Review State: $REVIEW_STATE"
+          echo "Git REF: $REF"
+          echo "Input local: $INPUT_FAST"
+          echo "Input remote: $INPUT_FULL"
+
+          remote_tests=false
+          local_tests=false
+          # Workflow_dispatch input override
+          if [[ "$EVENT_NAME" == "workflow_dispatch" ]]; then
+            
+            # Each option is self contained
+            if [[ "$INPUT_REMOTE" == "true" ]]; then
+              remote_tests=true
+            fi
+            
+            if [[ "$INPUT_LOCAL" == "true" ]]; then
+              local_tests=true
+            fi
+          fi
+
+          # If triggered by PR review and approved
+          if [[ "$EVENT_NAME" == "pull_request_review" ]]; then
+            if [[ "$REVIEW_STATE" == "approved" ]]; then
+              local_tests=true
+              remote_tests=true
+            else
+              local_tests=false
+              remote_tests=false
+            fi
+          fi
+
+          # All PRs that have been triggered need local tests
+          if [[ "$EVENT_NAME" == "pull_request" ]]; then
+              local_tests=true
+          fi
+          
+          # If it's a push to develop
+          if [[ "$EVENT_NAME" == "push" && "$REF" == "refs/heads/develop" ]]; then
+            local_tests=true
+            remote_tests=true
+          fi
 
+          echo "local_tests=$local_tests" >> $GITHUB_OUTPUT
+          echo "remote_tests=$remote_tests" >> $GITHUB_OUTPUT
+          echo "local_tests=$local_tests"
+          echo "remote_tests=$remote_tests"
+  
   lint:
+    needs: determine-test-scope
+    if: ( needs.determine-test-scope.outputs.local_tests == 'true' ) || ( needs.determine-test-scope.outputs.remote_tests == 'true' )
     name: Run linting
-    runs-on: ubuntu-latest
+    runs-on: [ inhouse ] 
     steps:
       - uses: actions/checkout@v4
         with:
@@ -32,15 +109,66 @@ jobs:
       - name: Run ruff check
         run: ruff check tidy3d
 
-  test:
-    # Run on internal PRs/pushes OR when manually triggered with run_tests=true
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository || (github.event_name == 'workflow_dispatch' && inputs.run_tests)
+  local-tests:
+    # Run on open PRs OR when manually triggered with local_tests=true
+    needs: determine-test-scope 
+    if: needs.determine-test-scope.outputs.local_tests == 'true'
+    name: Python ${{ matrix.python-version }} - self-hosted-runner 
+    runs-on: [ inhouse ] 
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.13']
+    defaults:
+      run:
+        shell: bash
+    env:  # Set environment variables for the whole job
+      PIP_ONLY_BINARY: gdstk
+      MPLBACKEND: agg
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install project
+      run: |
+        python -m venv ${GITHUB_WORKSPACE}/.venv
+        source ${GITHUB_WORKSPACE}/.venv/bin/activate
+        python --version
+        which python
+        which pip
+        pip list
+        pip install --upgrade pip wheel setuptools
+        pip install gdstk --only-binary gdstk
+        pip install -e ".[dev]"
+
+    - name: Run tests with coverage
+      env:
+        PYTHONUNBUFFERED: "1"
+      run: |
+        source ${GITHUB_WORKSPACE}/.venv/bin/activate
+        pytest --cov=tidy3d -rF --tb=short tests/_test_data/_test_datasets_no_vtk.py
+        pytest --cov=tidy3d -rF --tb=short tests
+        coverage report -m
+        TOTAL_COVERAGE=$(coverage report --format=total)
+        echo "total=$TOTAL_COVERAGE" >> "$GITHUB_ENV"
+        echo "### Total coverage: ${TOTAL_COVERAGE}%"
+
+  remote-tests:
+    # Run tests on a push event OR a workflow dispatch with remote_tests
+    needs: determine-test-scope 
+    if: needs.determine-test-scope.outputs.remote_tests == 'true'
     name: Python ${{ matrix.python-version }} - ${{ matrix.platform }}
     runs-on: ${{ matrix.platform }}
     strategy:
       matrix:
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
-        platform: [ubuntu-latest, windows-latest, macos-latest]
+        platform: [windows-latest, ubuntu-latest, macos-latest]
     defaults:
       run:
         shell: bash
@@ -103,3 +231,29 @@ jobs:
         maxColorRange: 95
         valColorRange: ${{ env.total }}
         style: "for-the-badge"
+  
+  pr-requirements-pass:
+    name: pr-requirements-pass
+    if: ( needs.determine-test-scope.outputs.local_tests == 'true' ) || ( needs.determine-test-scope.outputs.remote_tests == 'true' )
+    needs: [local-tests, remote-tests, lint]
+    runs-on: [ inhouse ]
+    steps:
+      - name: check-passing-remote-tests
+        run: |
+          echo "Remote tests result: ${{ needs.remote-tests.result }}"
+
+          if [[ "${{ needs.lint.result }}" != "success" ]]; then
+            echo "❌ Linting failed or was skipped."
+            exit 1
+          fi
+
+          if [[ "${{ needs.remote-tests.result }}" != "success" ]]; then
+            echo "❌ remote-tests failed or were skipped."
+          fi
+
+          if [[ "${{ needs.local-tests.result }}" != "success" ]]; then
+            echo "❌ local-tests failed or were skipped."
+            exit 1
+          fi
+
+          echo "✅ All required test jobs passed!"

.github/workflows/test_develop_cli.yaml

@@ -2,24 +2,15 @@ name: "test-develop-cli"
 
 on:
   workflow_dispatch:
-  workflow_run:
-    workflows: [ "tidy3d-frontend-tests" ]
-    types: [ completed ]
+  schedule:
+    - cron: '0 2 * * *'  # Runs every day at 2:00 AM UTC
+  push:
+    branches:
+      - develop
+      - latest
 
 jobs:
-  on-success:
-    runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
-    steps:
-      - run: echo 'The triggering workflow passed'
-  on-failure:
-    runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
-    steps:
-      - run: echo 'The triggering workflow failed'
-
   test-dev-commands:
-    needs: [on-success]
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
@@ -29,7 +20,7 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v4
       with:
-        ref: ${{ github.event.workflow_run.head_commit.id }}
+        ref: develop
 
 
     - name: Set up Python

CHANGELOG.md

@@ -7,19 +7,59 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Gradient computation for rotated boxes in Transformed.
+
+### Changed
+- Supplying autograd-traced values to geometric fields (`center`, `size`) of simulations, monitors, and sources now logs a warning and falls back to the static value instead of erroring.
+- Attempting to differentiate server-side field projections now raises a clear error instead of silently failing.
+
+## [2.8.3] - 2025-04-24
+
+### Added
+- Ability to select payment option when submitting jobs from the Python client.
+- Periodic repetition of EME subgrids via `num_reps` or `EMEPeriodicitySweep`.
+- Methods `EMEExplicitGrid.from_structures` and `EMECompositeGrid.from_structure_groups` to place EME cell boundaries at structure bounds.
+- 'ModeSimulation' now supports 'PermittivityMonitor'.
+- Classmethod `from_frequency_range` in `GaussianPulse` for generating a pulse whose amplitude in the frequency_range [fmin, fmax] is maximized, which is particularly useful for running broadband simulations.
+- Differentiable function `td.plugins.autograd.interpolate_spline` for 1D linear, quadratic, and cubic spline interpolation, supporting differentiation with respect to the interpolated values (`y_points`) and optional endpoint derivative constraints.
+- `SteadyEnergyBandMonitor` in the Charge solver.
+- Pretty printing enabled with `rich.print` for the material library, materials, and their variants. In notebooks, this can be accessed using `rich.print` or `display`, or by evaluating the material library, a material, or a variant in a cell.
+
+### Changed
+- Performance enhancement for adjoint gradient calculations by optimizing field interpolation.
+- Auto grid in EME simulations with multiple `freqs` provided uses the largest instead of raising an error.
+- Named mediums now display by name for brevity; materials/variants print concise summaries including references.
+
+### Fixed
+- Fixed `reverse` property of `td.Scene.plot_structures_property()` to also reverse the colorbar.
+
+### Fixed
+- Fixed bug in surface gradient computation where fields, instead of gradients, were being summed in frequency.
+
+## [2.8.2] - 2025-04-09
+
 ### Added
 - `fill` and `fill_structures` argument in `td.Simulation.plot_structures()` and `td.Simulation.plot()` respectively to disable fill and plot outlines of structures only.
 - New subpixel averaging option `ContourPathAveraging` applied to dielectric material boundaries.
 - A property `interior_angle` in `PolySlab` that stores angles formed inside polygon by two adjacent edges.
 - `eps_component` argument in `td.Simulation.plot_eps()` to optionally select a specific permittivity component to plot (eg. `"xx"`).
 - Monitor `AuxFieldTimeMonitor` for aux fields like the free carrier density in `TwoPhotonAbsorption`.
-- Gradient computation for rotated boxes in Transformed.
+- Broadband handling (`num_freqs` argument) to the TFSF source.
+- Ability to define a `WavePort` using only a voltage or current path integral, with the missing quantity inferred via power conservation.
 
 ### Fixed
 - Compatibility with `xarray>=2025.03`.
 - Inaccurate gradient when auto-grabbing permittivities for structures using `td.PolySlab` when using dispersive material models.
 - Fixed scaling for adjoint sources when differentiating with respect to `FieldData` to account for the mesh size of the monitor and thus the created source. This aligns adjoint gradient magnitudes with numerical finite difference gradients for field data.
 - Warn when mode solver pml covers a significant portion of the mode plane.
+- TFSF server errors related to the auxiliary plane wave source that would previously happen on the server are now caught upon simulation creation.
+- Opposite arrow curvature for mode sources and monitors with non-zero bendind radius when plotted in the figure's Y axis.
+
+### Changed
+- `num_freqs` in Gaussian beam type sources limited to 20, which should besufficient for all cases.
+- The `angle_phi` parameter of `ModeSpec` is only limited to multiples of `np.pi / 2` if `angle_rotation` is set to `True`, as other values would currently not work correctly.
+- The `ramp_up_iters` parameter of the `ChargeSolver` was changed back to 1 for efficiency. It can be increased in cases with e.g. high doping when convergence is more difficult.
 
 ## [2.8.1] - 2025-03-20
 
@@ -1561,7 +1601,9 @@ which fields are to be projected is now determined automatically based on the me
 - Job and Batch classes for better simulation handling (eventually to fully replace webapi functions).
 - A large number of small improvements and bug fixes.
 
-[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.8.1...develop
+[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.8.3...develop
+[2.8.3]: https://github.com/flexcompute/tidy3d/compare/v2.8.2...v2.8.3
+[2.8.2]: https://github.com/flexcompute/tidy3d/compare/v2.8.1...v2.8.2
 [2.8.1]: https://github.com/flexcompute/tidy3d/compare/v2.8.0...v2.8.1
 [2.8.0]: https://github.com/flexcompute/tidy3d/compare/v2.7.9...v2.8.0
 [2.7.9]: https://github.com/flexcompute/tidy3d/compare/v2.7.8...v2.7.9

docs/_static/img/gui_overview.png

@@ -106,6 +106,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",  # Add a link to the Python source code for classes, functions etc.
     "sphinx_copybutton",
+    "sphinx_design",
     "sphinx_favicon",
     "sphinx_sitemap",
     "sphinx_tabs.tabs",
@@ -188,6 +189,7 @@
 }
 myst_enable_extensions = [
     "amsmath",
+    "colon_fence",
     "dollarmath",
 ]
 nbsphinx_allow_errors = True  # Continue through Jupyter errors