Configuration API#

The objects and helpers below expose the public configuration interface.

Manager and Helpers#

tidy3d.config.ConfigManager

High-level orchestrator for tidy3d configuration.

tidy3d.config.get_manager()

Return the underlying configuration manager instance.

tidy3d.config.reload_config(*[, profile])

Recreate the global configuration manager (primarily for tests).

Legacy Compatibility#

tidy3d.config.LegacyConfigWrapper

Provide attribute-level compatibility with the legacy config module.

tidy3d.config.Environment

alias of LegacyEnvironment

tidy3d.config.EnvironmentConfig

alias of LegacyEnvironmentConfig

Registration Utilities#

tidy3d.config.register_section(name)

Decorator to register a configuration section schema.

tidy3d.config.register_plugin(name)

Decorator to register a plugin configuration schema.

tidy3d.config.register_handler(name)

Decorator to register a handler for a configuration section.

tidy3d.config.get_sections()

Return registered section schemas.

tidy3d.config.get_handlers()

Return registered configuration handlers.