Upgrading Existing Setups

Upgrading Existing Setups#

This short note highlights the differences you may notice when moving from earlier versions of Tidy3D to the current configuration manager.

File Locations#

  • Previous releases stored settings in ~/.tidy3d on all platforms. The new manager now prefers the platform-specific paths described in Configuration Guide ⚙️.

  • Your existing ~/.tidy3d/config.toml is still respected. Run tidy3d config migrate if you would like to copy it into the new directory. Append --overwrite to replace any files that already exist in the new location, and --delete-legacy to remove ~/.tidy3d after the copy.

Environment Switching#

  • The Env helper remains available. Calls such as Env.dev.active() now forward to the new manager and produce a DeprecationWarning to encourage the modern API, e.g. config.switch_profile("dev").

Legacy Attributes#

  • Shorthand properties config.logging_level, config.log_suppression, and config.use_local_subpixel still work and set the equivalent fields in config.logging or config.simulation. Each call raises a warning so you can update scripts at your own pace.

Working Safely With Existing Scripts#

  • Prefer the new attribute paths (config.logging.level) in fresh code.

  • When editing older notebooks, import warnings and silence specific deprecations temporarily if needed:

    import warnings
warnings.filterwarnings("ignore", category=DeprecationWarning)

  • After updating your scripts, remove the filter so you notice future changes.

Need Help?#

Reach out through the Tidy3D Discussions board or contact support@flexcompute.com if you hit any issues while upgrading.

Contents