FXC-4741-move-core-modules-to-common-submodule

Author: marcorudolphflex

.gitmodules

@@ -1,6 +0,0 @@
-[submodule "docs/notebooks"]
-	path = docs/notebooks
-	url = git@github.com:flexcompute/tidy3d-notebooks.git
-[submodule "docs/faq"]
-	path = docs/faq
-	url = https://github.com/flexcompute/tidy3d-faq

CHANGELOG.md

@@ -36,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added deprecation warning for ``TemperatureMonitor`` and ``SteadyPotentialMonitor`` when ``unstructured`` parameter is not explicitly set. The default value of ``unstructured`` will change from ``False`` to ``True`` after the 2.11 release.
 - Added validation to `GaussianDoping` to ensure `ref_con < concentration`, validate `source` face identifier, and warn the user when the box size is not sufficient for the specified transition width.
 - Local caching is now enabled by default (set `td.config.local_cache.enabled=False` to opt out).
+- Reduced computation time of `adaptive_vjp_spacing` for `GeometryGroup` by allowing permittivity based spacing value to be cached.
 
 ### Fixed
 - Fixed intermittent "API key not found" errors in parallel job launches by making configuration directory detection race-safe.
@@ -45,6 +46,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed `CustomMedium` gradient calculation when field coordinates exactly align with boundaries.
 - Fixed adjoint simulation `grid_spec` to align exactly with forward simulation for correct `FieldData` adjoint source power.
 - Fixed redundant logging when `Batch.download()` skips existing files, and added `replace_existing` to `Batch.run()` so overwrite behavior can be controlled directly.
+- Fixed redundant server lookups when loading simulation results.
+- Updated docstrings for `DerivativeInfo` to more accurately reflect dataclass fields.
 
 ## [2.10.2] - 2026-01-21
 

scripts/ensure_imports_from_common.py

@@ -0,0 +1,114 @@
+"""Ensure tidy3d._common modules avoid importing from tidy3d outside tidy3d._common."""
+
+from __future__ import annotations
+
+import argparse
+import ast
+import sys
+from collections.abc import Iterable
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass(frozen=True)
+class ImportViolation:
+    file: str
+    line: int
+    statement: str
+
+
+def parse_args(argv: Iterable[str]) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description=(
+            "Ensure tidy3d._common does not import from tidy3d modules outside tidy3d._common."
+        )
+    )
+    parser.add_argument(
+        "--root",
+        default="tidy3d/_common",
+        help="Root directory to scan (relative to repo root).",
+    )
+    return parser.parse_args(argv)
+
+
+def main(argv: Iterable[str]) -> None:
+    args = parse_args(argv)
+    repo_root = Path.cwd().resolve()
+    root = (repo_root / args.root).resolve()
+    if not root.exists():
+        print(f"No directory found at {root}. Skipping check.")
+        return
+
+    violations: list[ImportViolation] = []
+    for path in sorted(root.rglob("*.py")):
+        violations.extend(_violations_in_file(path, repo_root))
+
+    if violations:
+        print("Invalid tidy3d imports found in tidy3d._common:")
+        for violation in violations:
+            print(f"{violation.file}:{violation.line}: {violation.statement}")
+        raise SystemExit(1)
+
+    print("No invalid tidy3d imports found in tidy3d._common.")
+
+
+def _violations_in_file(path: Path, repo_root: Path) -> list[ImportViolation]:
+    source = path.read_text(encoding="utf-8")
+    try:
+        tree = ast.parse(source)
+    except SyntaxError as exc:
+        raise SystemExit(f"Syntax error parsing {path}: {exc}") from exc
+
+    rel_path = str(path.relative_to(repo_root))
+    violations: list[ImportViolation] = []
+    for node in ast.walk(tree):
+        if isinstance(node, ast.Import):
+            for alias in node.names:
+                name = alias.name
+                if name == "tidy3d" or (
+                    name.startswith("tidy3d.") and not name.startswith("tidy3d._common")
+                ):
+                    violations.append(
+                        ImportViolation(
+                            file=rel_path,
+                            line=node.lineno,
+                            statement=_statement(source, node),
+                        )
+                    )
+        elif isinstance(node, ast.ImportFrom):
+            if node.level:
+                continue
+            module = node.module
+            if not module:
+                continue
+            if module == "tidy3d":
+                for alias in node.names:
+                    if alias.name != "_common":
+                        violations.append(
+                            ImportViolation(
+                                file=rel_path,
+                                line=node.lineno,
+                                statement=_statement(source, node),
+                            )
+                        )
+                continue
+            if module.startswith("tidy3d.") and not module.startswith("tidy3d._common"):
+                violations.append(
+                    ImportViolation(
+                        file=rel_path,
+                        line=node.lineno,
+                        statement=_statement(source, node),
+                    )
+                )
+    return violations
+
+
+def _statement(source: str, node: ast.AST) -> str:
+    segment = ast.get_source_segment(source, node)
+    if segment:
+        return " ".join(segment.strip().splitlines())
+    return node.__class__.__name__
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

tests/config/test_legacy_env.py

@@ -93,11 +93,9 @@ def test_env_vars_follow_profile_switch(
 
 def test_web_core_environment_reexports():
     """Legacy `tidy3d.web.core.environment` exports remain available via config shim."""
-
-    import tidy3d.web as web
+    from tidy3d._common.web.core import environment
     from tidy3d.config import Env as ConfigEnv
 
-    environment = web.core.environment
     assert environment.Env is ConfigEnv
 
     with warnings.catch_warnings(record=True) as caught:

tests/config/test_loader.py

@@ -6,8 +6,8 @@
 from click.testing import CliRunner
 from pydantic import Field
 
+from tidy3d._common.config import loader as config_loader  # import from common as it is patched
 from tidy3d.config import get_manager, reload_config
-from tidy3d.config import loader as config_loader
 from tidy3d.config import registry as config_registry
 from tidy3d.config.legacy import finalize_legacy_migration
 from tidy3d.config.loader import migrate_legacy_config