feat(tidy3d): FXC-3294-add-opt-in-local-cache-for-simulation-results

Author: marcorudolphflex

CHANGELOG.md

@@ -26,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Validation for `run_only` field in component modelers to catch duplicate or invalid matrix indices early with clear error messages.
 - Introduced a profile-based configuration manager with TOML persistence and runtime overrides exposed via `tidy3d.config`.
 - Added support of `os.PathLike` objects as paths like `pathlib.Path` alongside `str` paths in all path-related functions.
+- Added configurable local simulation result caching with checksum validation, eviction limits. Can configured with `config.local_cache`.
 
 ### Changed
 - Improved performance of antenna metrics calculation by utilizing cached wave amplitude calculations instead of recomputing wave amplitudes for each port excitation in the `TerminalComponentModelerData`.

docs/index.rst

@@ -168,6 +168,13 @@ This will produce the following plot, which visualizes the electromagnetic field
 
 You can now postprocess simulation data using the same python session, or view the results of this simulation on our web-based `graphical user interface (GUI) <https://tidy3d.simulation.cloud>`_.
 
+.. tip::
+
+   Repeated runs of the same simulation can reuse solver results by enabling the optional
+   local cache: ``td.config.simulation_cache.enabled = True``. The cache location and limits are
+   configurable (see ``~/.tidy3d/config``), entries are checksum-validated, and you can clear
+   all stored artifacts with ``tidy3d.web.cache.clear()``.
+
 .. `TODO: open example in colab <https://github.com/flexcompute/tidy3d>`_
 
 
@@ -262,4 +269,3 @@ Contents
 
 
 
-

tests/config/test_legacy.py

@@ -2,8 +2,6 @@
 
 import importlib
 
-import pytest
-
 from tidy3d.config.__init__ import get_manager, reload_config
 
 
@@ -16,11 +14,9 @@ def test_legacy_logging_level(config_manager):
 
 def test_env_switch(config_manager):
     config_module = importlib.import_module("tidy3d.config.__init__")
-    with pytest.warns(DeprecationWarning, match="tidy3d.config.Env"):
-        config_module.Env.dev.active()
+    config_module.Env.dev.active()
     assert get_manager().profile == "dev"
-    with pytest.warns(DeprecationWarning, match="tidy3d.config.Env"):
-        config_module.Env.set_current(config_module.Env.prod)
+    config_module.Env.set_current(config_module.Env.prod)
     assert get_manager().profile == "prod"
 
 

tests/config/test_loader.py

@@ -6,10 +6,7 @@
 from pydantic import Field
 
 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
 from tidy3d.config.sections import ConfigSection
 from tidy3d.web.cli.app import tidy3d_cli
 
@@ -35,7 +32,7 @@ def test_save_includes_descriptions(config_manager, mock_config_dir):
     manager.save(include_defaults=True)
 
     content = _config_path(mock_config_dir).read_text(encoding="utf-8")
-    assert "Lowest logging level that will be emitted." in content
+    assert "# Web/HTTP configuration." in content
 
 
 def test_preserves_user_comments(config_manager, mock_config_dir):
@@ -44,7 +41,10 @@ def test_preserves_user_comments(config_manager, mock_config_dir):
 
     config_path = _config_path(mock_config_dir)
     text = config_path.read_text(encoding="utf-8")
-    text = text.replace("Lowest logging level that will be emitted.", "user-modified comment")
+    text = text.replace(
+        "Web/HTTP configuration.",
+        "user-modified comment",
+    )
     config_path.write_text(text, encoding="utf-8")
 
     reload_config(profile="default")
@@ -53,7 +53,7 @@ def test_preserves_user_comments(config_manager, mock_config_dir):
 
     updated = config_path.read_text(encoding="utf-8")
     assert "user-modified comment" in updated
-    assert "Lowest logging level that will be emitted." not in updated
+    assert "Web/HTTP configuration." not in updated
 
 
 def test_profile_preserves_comments(config_manager, mock_config_dir):
@@ -118,7 +118,7 @@ class CLIPlugin(ConfigSection):
         assert result.exit_code == 0, result.output
 
         config_text = _config_path(mock_config_dir).read_text(encoding="utf-8")
-        assert "Lowest logging level that will be emitted." in config_text
+        assert "Web/HTTP configuration." in config_text
         assert "[web]" in config_text
         assert "secret" not in config_text
         assert not profiles_dir.exists()
@@ -143,58 +143,8 @@ class CommentPlugin(ConfigSection):
         manager = get_manager()
         manager.save(include_defaults=True)
         content = _config_path(mock_config_dir).read_text(encoding="utf-8")
+        assert "Comment plugin configuration." in content
         assert "Plugin knob description." in content
     finally:
         config_registry._SECTIONS.pop("plugins.comment_test", None)
         reload_config(profile="default")
-
-
-def test_finalize_legacy_migration_promotes_flat_file(tmp_path):
-    canonical_dir = tmp_path / "canonical"
-    canonical_dir.mkdir()
-    legacy_file = canonical_dir / "config"
-    legacy_file.write_text('apikey = "legacy-key"\n', encoding="utf-8")
-    extra_file = canonical_dir / "extra.txt"
-    extra_file.write_text("keep", encoding="utf-8")
-
-    finalize_legacy_migration(canonical_dir)
-
-    config_toml = canonical_dir / "config.toml"
-    assert config_toml.exists()
-    content = config_toml.read_text(encoding="utf-8")
-    assert "[web]" in content
-    assert "[logging]" in content
-    assert "Lowest logging level that will be emitted." in content
-    assert "legacy-key" in content
-    assert not legacy_file.exists()
-    assert extra_file.exists()
-    assert extra_file.read_text(encoding="utf-8") == "keep"
-
-
-def test_migrate_legacy_config_promotes_structured_config(tmp_path, monkeypatch):
-    legacy_dir = tmp_path / "legacy"
-    legacy_dir.mkdir()
-    legacy_file = legacy_dir / "config"
-    legacy_file.write_text('apikey = "legacy-key"\n', encoding="utf-8")
-    (legacy_dir / "extra.txt").write_text("keep", encoding="utf-8")
-
-    canonical_dir = tmp_path / "canonical"
-
-    monkeypatch.setattr(config_loader, "legacy_config_directory", lambda: legacy_dir)
-    monkeypatch.setattr(config_loader, "canonical_config_directory", lambda: canonical_dir)
-
-    destination = migrate_legacy_config()
-
-    assert destination == canonical_dir
-    config_toml = canonical_dir / "config.toml"
-    assert config_toml.exists()
-    content = config_toml.read_text(encoding="utf-8")
-    assert "[web]" in content
-    assert "[logging]" in content
-    assert "Lowest logging level that will be emitted." in content
-    assert "legacy-key" in content
-    assert not (canonical_dir / "config").exists()
-    extra_file = canonical_dir / "extra.txt"
-    assert extra_file.exists()
-    assert extra_file.read_text(encoding="utf-8") == "keep"
-    assert legacy_dir.exists()

tests/config/test_manager.py

@@ -28,19 +28,12 @@ def test_runtime_isolated_per_profile(config_manager):
     assert config_manager.get_section("web").timeout == 45
 
 
-def test_runtime_overrides_env(monkeypatch, config_manager):
+def test_environment_variable_precedence(monkeypatch, config_manager):
     monkeypatch.setenv("TIDY3D_LOGGING__LEVEL", "WARNING")
     config_manager.switch_profile(config_manager.profile)
     config_manager.update_section("logging", level="DEBUG")
     logging_section = config_manager.get_section("logging")
-    # runtime change should override the environment variable
-    assert logging_section.level == "DEBUG"
-
-
-def test_env_applies_without_runtime_override(monkeypatch, config_manager):
-    monkeypatch.setenv("TIDY3D_LOGGING__LEVEL", "WARNING")
-    config_manager.switch_profile(config_manager.profile)
-    logging_section = config_manager.get_section("logging")
+    # env var should still take precedence
     assert logging_section.level == "WARNING"
 
 

tests/test_components/autograd/test_autograd.py

@@ -661,7 +661,7 @@ def plot_sim(sim: td.Simulation, plot_eps: bool = True) -> None:
 # args = [("polyslab", "mode")]
 
 
-def get_functions(structure_key: str, monitor_key: str) -> typing.Callable:
+def get_functions(structure_key: str, monitor_key: str) -> dict[str, typing.Callable]:
     if structure_key == ALL_KEY:
         structure_keys = structure_keys_
     else: