Merge branch 'develop' into pre/2.7

Author: momchil-flex

.github/workflows/run_tests.yml

@@ -3,9 +3,10 @@ name: "tidy3d-frontend-tests"
 on:
   workflow_dispatch:
   push:
-    branches: [ develop ]
+    branches: [ develop, latest ]
   pull_request:
     branches:
+      - latest
       - develop
       - 'pre/*'
 
@@ -143,4 +144,4 @@ jobs:
         poetry run black . --check --diff
         poetry run ruff check tidy3d --fix --exit-non-zero-on-fix
         poetry run pytest -rA tests
-        poetry run pytest -rA tests/test_data/_test_datasets_no_vtk.py
+        poetry run pytest -rA tests/_test_data/_test_datasets_no_vtk.py

.github/workflows/test_develop_cli.yaml

@@ -1,4 +1,4 @@
-name: test-develop-cli
+name: "test-develop-cli"
 
 on:
   workflow_dispatch:
@@ -7,7 +7,6 @@ on:
     types:
       - completed
 
-
 jobs:
   test-dev-commands:
     strategy:

CHANGELOG.md

@@ -5,6 +5,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.6.1] - 2024-03-07
+
 ### Added
 - `Simulation` now accepts `LumpedElementType`, which currently only supports the `LumpedResistor` type. `LumpedPort` together with `LumpedResistor` make up the new `TerminalComponentModeler` in the `smatrix` plugin.
 - Uniaxial medium Lithium niobate to material library.
@@ -15,16 +17,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - `tidy3d.plugins.design.Results` store the `BatchData` for batch runs in the `.batch_data` field.
+- Prompting user to check solver log when loading solver data if warnings were found in the log, or if the simulation diverged or errored.
 
 ### Changed
+- Slightly reorganized `web.run` logging when `verbose=True` to make it clearer.
 
 ### Fixed
 - Fix to 3D surface integration monitors with some surfaces completely outside of the simulation domain which would sometimes still record fields.
 - Better error handling if remote `ModeSolver` creation gives response of `None`.
 - Validates that certain incompatible material types do not have intersecting bounds.
 - Fixed handling of the `frequency` argument in PEC medium.
-
-## [2.6.0] - 2024-01-21
+- Corrected plotting cmap if `val='re'` passed to `SimulationData.plot_field`.
+- Bug when converting point `FieldMonitor` data to scalar amplitude for adjoint source in later jax versions.
+- Handle special case when vertices overlap in `JaxPolySlab` to give 0 grad contribution from edge.
+- Corrected some mistakes in the estimation of the solver data size for each monitor type, which affects the restrictions on the maximum monitor size that can be submitted.
+- Bug in visualizing a slanted cylinder along certain axes in 2D.
+- Bug in `ModeSolver.reduced_simulation_copy` that was causing mode profiles to be all `NaN`.
+- Bug in `Simulation.subsection()` that was causing zero-size dimensions not to be preserved.
+- Bug in `CustomGrid` that was causing an error when using for zero-size dimensions.
+- When downloading gzip-ed solver data, automatically create the parent folder of the `to_file` path if it does not exist.
+
+## [2.6.0] - 2024-02-21
 
 ### Added
 - Automatic subdivision of 2D materials with inhomogeneous substrate/superstrate.
@@ -1119,6 +1132,8 @@ which fields are to be projected is now determined automatically based on the me
 - A large number of small improvements and bug fixes.
 
 [Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.6.0...pre/2.7
+[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.6.1...develop
+[2.6.1]: https://github.com/flexcompute/tidy3d/compare/v2.6.0...v2.6.1
 [2.6.0]: https://github.com/flexcompute/tidy3d/compare/v2.5.2...v2.6.0
 [2.5.2]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...v2.5.2
 [2.5.1]: https://github.com/flexcompute/tidy3d/compare/v2.5.0...v2.5.1

docs/_static/logo.ico

@@ -33,4 +33,9 @@
           {% endif %}
        {%- endfor %}
        {% endif %}
-       {% endblock %}
+       {% endblock %}
+
+
+   .. rubric:: Inherited Common Usage
+
+   .. include:: ../_custom_autosummary/{{ fullname }}.rst

docs/_templates/module.rst

@@ -0,0 +1,5 @@
+.. autosummary::
+  :recursive:
+  :toctree: ../_autosummary/
+
+  tidy3d.components.base.Tidy3dBaseModel.from_file

docs/api/_custom_autosummary/tidy3d.SimulationData.rst

@@ -42,6 +42,7 @@ These are some classes that are used to organize the tidy3d components, but aren
    tidy3d.components.monitor.AbstractFieldProjectionMonitor
    tidy3d.components.lumped_element.LumpedElement
    tidy3d.components.grid.grid_spec.GridSpec1d
+   tidy3d.components.data.sim_data.SimulationData
    tidy3d.components.data.data_array.DataArray
    tidy3d.components.data.monitor_data.MonitorData
    tidy3d.components.data.monitor_data.AbstractFieldProjectionData

docs/api/abstract_models.rst

@@ -64,7 +64,6 @@
 autodoc_default_options = {
     "members": True,
     "member-order": "bysource",
-    "special-members": "__init__",
     "undoc-members": True,
 }
 autodoc_typehints = "none"
@@ -94,6 +93,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",  # Add a link to the Python source code for classes, functions etc.
     "sphinx_copybutton",
+    "sphinx_favicon",
     "sphinx_sitemap",
     "sphinx_tabs.tabs",
     "sphinxemoji.sphinxemoji",
@@ -102,6 +102,12 @@
     "custom-robots",  # In _ext, these need to be at the end of the extensions list
 ]
 extlinks = {}
+favicons = [
+    {
+        "sizes": "16x16",
+        "href": "logo.svg",
+    }
+]
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
@@ -114,7 +120,6 @@
     "css/custom.css",
 ]
 html_extra_path = ["./_static/robots.txt", "./_static/"]
-html_favicon = "_static/logo.ico"
 html_js_files = ["js/custom-download.js"]
 htmlhelp_basename = "tidy3ddoc"
 html_show_sourcelink = True  # Remove 'view source code' from top of page (for html, not python)
@@ -217,6 +222,7 @@
     \usepackage{cmap}
     """
 }
+
 # latex_elements: dict = {
 #     # "preamble": r"\usepackage{bm}\n\usepackage{amssymb}\n\usepackage{esint}",
 #     # The paper size ('letterpaper' or 'a4paper').