All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2.4.1 - 2023-9-20#


  • ModeSolverData.pol_fraction and ModeSolverData.pol_fraction_waveguide properties to compute polarization fraction of modes using two different definitions.

  • ModeSolverData.to_dataframe() and ModeSolverData.modes_info for a convenient summary of various modal properties of the computed modes.

  • Loss upper bound estimation in PoleResidue material model.


  • Output task URL before and after simulation run and make URLs blue underline formatting.

  • Support to load and save compressed HDF5 files (.hdf5.gz) directly from Tidy3dBaseModel.

  • Line numbers no longer printed in webapi log output.

  • Empty list returned if the folder cannot be queried in web.get_tasks().


  • Filtering based on ModeSpec.filter_pol now uses the user-exposed ModeSolverData.pol_fraction property. This also fixes the previous internal handling which was not taking the nonuniform grid, as well as and the propagation axis direction for modes in angled waveguides. In practice, the results should be similar in most cases.

  • Bug with truly anisotropic JaxCustomMedium in adjoint plugin.

  • Bug in adjoint plugin when JaxBox is less than 1 grid cell thick.

  • Bug in adjoint plugin where JaxSimulation.structures did not accept structures containing td.PolySlab.

2.4.0 - 2023-9-11#


  • Configuration option config.log_suppression can be used to control the suppression of log messages.

  • web.abort() and Job.abort() methods allowing user to abort running tasks without deleting them. If a task is aborted, it cannot be restarted later, a new one needs to be created and submitted.

  • FastDispersionFitter for fast fitting of material dispersion data.

  • Simulation.monitors_data_size property mapping monitor name to its data size in bytes.

  • Source with arbitrary user-specified time dependence through CustomSourceTime.

  • Interface for specifying material heat and charge perturbation models. Specifically, non-dispersive and dispersive mediums with heat and/or charge perturbation models can be defined through classes PerturbationMedium and PerturbationPoleResidue, where perturbations to each parameter is specified using class ParameterPerturbation. A convenience function Simulation.perturbed_mediums_copy is added to class Simulation which applies heat and/or charge fields to mediums containing perturbation models.

  • Added hlim and vlim kwargs to Simulation.plot() and Simulation.plot_eps() for setting horizontal and veritcal plot limits.

  • Added support for chi3 nonlinearity via NonlinearSusceptibility class.

  • Spatial downsampling allowed in PermittivityMonitor through the interval_space argument.

  • ClipOperation geometry type allows the construction of complex geometries through boolean operations.

  • Operations on geometry (+, |, *, &, -, ^) will create the appropriate ClipOperation or GeometryGroup.

  • Geometry.from_shapely to extrude shapely primitives into Tidy3D geometry.

  • Geometry.from_gds to extrude GDS cells into geometry groups with support for holes.

  • components.geometry.utils.traverse_geometry used internally to traverse geometry trees.

  • components.geometry.utils.flatten_groups used internally to validate large geometry trees.


  • Add width and height options to Simulation.plot_3d().

  • sim_with_source(), sim_with_monitor(), and sim_with_mode_solver_monitor() methods allowing the ModeSolver to create a copy of its Simulation with an added ModeSource, ModeMonitor, or ModeSolverMonitor, respectively.

  • nyquist_step also taking the frequency range of frequency-domain monitors into account.

  • Added option to allow DC component in GaussianPulse spectrum, by setting remove_dc_component=False in GaussianPulse.

  • Jax installation from pip install "tidy3d[jax]" handled same way on windows as other OS if python >= 3.9.

  • colocate introduced as an argument to ModeSolver and a Field in ModeSolverMonitor, set to True by default.

  • FieldTimeMonitor-s and FieldMonitor-s that have colocate=True return fields colocated to the grid boundaries rather than centers. This matches better user expectations for example when the simulation has a symmetry (explicitly defined, or implicit) w.r.t. a given axis. When colocating to centers, fields would be dl / 2 away from that symmetry plane, and components that are expected to go to zero do not (of course, they still do if interpolated to the symmetry plane). Another convenient use case is that it is easier to place a 2D monitor exactly on a grid boundary in the automatically generated grid, by simply passing an override structure with the monitor geometry.

  • In these monitors, colocate is now set to True by default. This is to avoid a lot of potential confusion coming from returning non-colocated fields by default, when colocated fields need to be used when computing quantities that depend on more than one field component, like flux or field intensity.

  • Field colocation for computations like flux, Poynting, and modal overlap also happen to cell boundaries rather than centers. The effect on final results should be close to imperceptible as verified by a large number of backend tests and our online examples. Any difference can be at most on the scale of the difference that can be observed when slightly modifying the grid resolution.

  • GeometryGroup accepts other GeometryGroup instances as group elements.

  • FDTD and mode solver tasks always upload hdf5.gz file instead of hdf5 or json.

  • web.download_json() will download simulation.hdf5.gz and unzip it, then load the json from the hdf5 file.

  • SimulationTask.get_simulation_hdf5() will download simulation.hdf5.gz and unzip it to hdf5 file.

  • The width of Tidy3D logging output is changed to 80 characters.

  • Upgrades to pydantic==2.* with pydantic.v1 imports.

  • Uses ruff for linting instead of pylint.

  • Added lower bound validator to freqs in mode solver.

  • Added lower bound validator to group_index_step in ModeSpec.

  • ComponentModeler.freqs now a FreqArray, so it can be initialized from numpy, list or tuple.


  • Handles TIDY3D_ENV properly when set to prod.

  • Redundant phase compensation for shifted source in smatrix plugin.

  • Bug in angled mode solver with negative angle_theta.

  • Properly include JaxSimulation.input_structures in JaxSimulationData.plot_field().

  • Numerically stable sigmoid function in radius of curvature constraint.

  • Spatial monitor downsampling when the monitor is crossing a symmetry plane or Bloch boundary conditions.

  • Cast JaxDataArray.__abs__ output to jnp.array, reducing conversions needed in objective functions.

  • Correct color and zorder for line segments when plotting 2D geometries.

  • Bug in Simulation.eps_bounds that was always setting the lower bound to 1.

  • Extended lower limit of frequency range for Graphene to zero.

  • Improved warnings for Medium2D.

  • Improved mode solver handling of 1D problem to avoid singular matrix issue.

  • Set colocate=False automatically in output FieldMonitor objects in adjoint plugin, warning instead of erroring for backwards compatibility.

  • Validation for ModeSpec.group_index_step working incorrectly if the value was set to 1.

2.3.3 - 2023-07-28#




  • Adjoint plugin import failures after jax.numpy.DeviceArray -> jax.Array in jax 0.4.14.

  • Fixed definition of shapely box bounds in Geometry.intersections_2dbox()

2.3.2 - 2023-7-21#



  • Surface integration monitor validator changed to error only if all integration surfaces are outside of the simulation domain.

  • Inverse design convenience utilities in plugins.adjoint.utils for image filtering (ConicFilter), projection (BinaryProjector), and radius of curvature penalization (RadiusPenalty).


  • Properly handle sign flip in ModeMonitor outputs with direction="-" in adjoint plugin.

  • Bug in CustomMedium.grids, which was giving incorrect grid boundaries at edges.

  • Out of date endpoint in migrate option of webapi.

2.3.1 - 2023-7-14#


  • Support for differentiating with respect to JaxMedium.conductivity.

  • Validating that every surface (unless excluded in exclude_surfaces) of a 3D SurfaceIntegrationMonitor (flux monitor or field projection monitor) is not completely outside the simulation domain.


  • Source validation happens before simulation upload and raises an error if no source is present.

  • Warning instead of error if structure out of simulation bounds.

  • Internal refactor of ComponentModeler to simplify logic.

  • (Changed effective 2.3.0) Backward-direction mode amplitudes from ModeMonitors have a flipped sign compared to previous versions. Previously, the amplitudes were computed directly through the dot product amp = (mode, field), while, since 2.3.0, we use amp = (mode, field) / (mode, mode) instead. The modes are already normalized to unit directed flux, such that (mode, mode) = 1 for forward modes, and (mode, mode) = -1 for backward modes (the dot product of a mode with itself is equal to the flux through the mode plane). Therefore, the change in the amp formula is equivalent to a sign change for backward modes. This makes their interpretation more intuitive, since the amplitude is now 1 if the recorded field and a mode match exactly. A -1 amplitude means that the fields match exactly except for a pi phase shift. This interpretation is also now independent of forward/backward direction.


  • Point-like objects correctly appear as single points using plt.scatter.

  • Cleaner display of ArrayLike in docs.

  • ArrayLike validation properly fails with None or nan contents.

  • Apply finite grid correction to the fields when calculating the Poynting vector from 2D monitors.

  • JaxCustomMedium properly handles complex-valued permittivity.

2.3.0 - 2023-6-30#


  • Specification of spatial permittivity distribution of dispersive material using user-supplied data through CustomPoleResidue, CustomSellmeier, CustomLorentz, CustomDebye, and CustomDrude components.

  • CustomAnisotropicMedium where each component can take user-supplied data to define spatial permittivity distribution of non-dispersive or dispersive material.

  • Coords.spatial_interp to interpolate spatial data avoiding pitfalls of xarray.interp in directions where there is a single data point.

  • All medium types accept allow_gain which is False by default, but allows the medium to be active if True.

  • Causality validation in PoleResidue model.

  • Group index calculation added to mode monitors and available through ModeData.n_group.

  • Support for JaxGeometryGroup in adjoint plugin.

  • Support for gradients w.r.t. FieldMonitor data from output_monitors in adjoint plugin.

  • estimate_cost() method for Job and Batch.

  • s3utils.get_s3_sts_token accepts extra query parameters.

  • plugins.mode.web to control the server-side mode solver.

  • Support for JaxDataArray.interp, allowing differentiable linear interpolation.

  • Support for JaxSimulationData.get_intensity(), allowing intensity distribution to be differentiated in adjoint plugin.

  • Support for JaxFieldData.flux to compute differentiable flux value from FieldData.

  • All custom medium types accept subpixel which is False by default, but applies subpixel averaging of the permittivity on the interfaces of the structure (including exterior boundary and intersection interfaces with other structures) if True and simulation’s subpixel is also True.


  • Add Medium2D to full simulation in tests.

  • DispersionFitter and StableDispersionFitter unified in a single DispersionFitter interface.

  • StableDispersionFitter deprecated, with stable fitter now being run instead through

  • Removed validator from CustomFieldSource that ensured data spanned the source geometry. Now the current values are extrapolated outside of the supplied data ranges.

  • CustomMedium now take fields permittivity and conductivity. eps_dataset will be deprecated in v3.0.

  • Moved CustomMedium._interp to Coords.spatial_interp to be used by custom current sources.

  • Adjoint simulations no longer contain unused gradient permittivity monitors, reducing processing time.

  • Batch prints total estimated cost if verbose=True.

  • Unified config and authentication.

  • Remove restriction that JaxCustomMedium must not be a 3D pixelated array.

  • Limit total number of input structures in adjoint plugin for performance reasons.

  • ModeSolver and ModeSolverMonitor now contain direction field that explicitly specifies the mode propagation direction (default is “+”).

  • Added an interpolate option to CustomCurrentSource and UniformCurrentSource, which uses linear interpolation to emulate exact placement of the source along directions where the source has zero size, rather than snapping to the nearest grid location, similar to the behavior for PointDipole. Default: True.


  • Plotting 2D materials in SimulationData.plot_field and other circumstances.

  • More segments in plotting of large cylinder and sphere cross-sections.

  • Proper handling of nested list of custom data components in IO, needed for custom dispersive medium coefficients.

  • ElectromagneticFieldData.outer_dot now works correctly for FieldData, not only ModeSolverData.

  • Fix to the setting of the mode solver PML parameters that produces better results for modes which do not decay in the PML, and fewer spurious modes.

  • Fix to single-precision mode solver to do the type conversion on the final matrix only rather than at intermediate steps, which improves accuracy in some cases.

  • Improvements to graphene medium fit.

  • Schema titles in ArrayLike fields.

  • Fix web.estimate_cost error/time-out for large simulations, it should now always work but may take some time for complex cases.

  • A more accurate injection and decomposition of backward propagating waveguide modes in lossy and gyrotropic systems.

2.2.3 - 2023-6-15#




  • Callback URL: “call_back_url” replaced with proper “callbackUrl”.

2.2.2 - 2023-5-25#



  • Tidy3D component .to_hdf5() and .from_hdf5() now accept custom encoder and decoder functions for more flexible IO.


  • JaxDataArrays are properly handled when reading and writing to file, dramatically reducing the VJP simulation download size in server-side adjoint.

  • A bug in a total-field scattered-field (TFSF) validator which was causing unnecessary errors when a TFSF surface intersected with 2D materials.

  • CI tests working with binary installation of gdstk instead of compiling from source.

2.2.1 - 2023-5-23#




  • Downgrade typing_extensions to <=4.5.0 to avoid bug with pydantic for python <= 3.9.

  • Bug in ModeSolver which was causing a preconditioner to be applied even when it is not needed.

2.2.0 - 2023-5-22#


  • Fully anisotropic medium class (FullyAnisotropicMedium) that allows to simulate materials with permittivity and conductivity tensors oriented arbitrary with respect to simulation grid.

  • Adjoint processing is done server side by default, to avoid unnecessary downloading of data.

  • JaxPolySlab in adjoint plugin, which can track derivatives through its .vertices.

  • run_local and run_async_local options in tidy3d.plugins.adjoint.web to provide way to run adjoint processing locally.

  • web.test() to simply test if the authentication is configured correctly and raise exception otherwise.

  • SimulationTask.get_running_tasks() to get a list of running tasks from the server.

  • Retry for set number of seconds in web functions if internet connection errors.

  • Argument scale to ModeSolver.plot_field to control plot scaling.

  • Simulation.plot_3d() method to make 3D rendering of simulation.


  • Perfect electric conductors (PECs) are now modeled as high-conductivity media in both the frontend and backend mode solvers, and their presence triggers the use of a preconditioner to improve numerical stability and robustness. Consequently, the mode solver provides more accurate eigenvectors and field distributions when PEC structures are present.

  • Include source amplitude in amp_time.

  • Increased the maximum allowed estimated simulation data storage to 50GB. Individual monitors with projected data larger than 10GB will trigger a warning.

  • PolySlab.inside now uses matplotlib.path.contains_points for better performance.

  • JaxCustomMedium accepts a maximum of 250,000 grid cells to avoid slow server-side processing.

  • PolySlab.inside now uses matplotlib.path.contains_points.

  • JaxCustomMedium accepts a maximum of 250,000 grid cells.

  • Logging messages are supressed and summarized to avoid repetitions.


  • Log messages provide the correct caller origin (file name and line number).

  • Medium2D is removed from the list of allowed options for Simulation.medium in the documentation.

  • Symmetry works properly in adjoint plugin.

2.1.1 - 2023-4-25#



  • adjoint plugin now filters out adjoint sources that are below a threshold in amplitude relative to the maximum amplitude of the monitor data, reducing unnecessary processing by eliminating sources that won’t contribute to the gradient.

  • web.run_async uses Batch under the hood instead of asyncio.


  • More helpful error messages from HTTP responses.

  • Bug in _validate_no_structures_pml, which was using wrong pml thicknesses.

  • Broken callback_url in webapi.

2.1.0 - 2023-4-18#


  • Group index calculation added to ModeSpec.

  • Waveguide plugin for quickly calculating modes in dielectric waveguides.

  • ElectromagneticFieldData.dot_intep to calculate mode overlap integrals between modes with different discretizations.

  • ElectromagneticFieldData.mode_area to calculate the effective mode area.

  • ElectromagneticFieldData.intensity returns the sum of the squared components of the electric field.

  • Group index calculation added to ModeSolver.

  • Web interface prints clickable link to task on Tidy3D web interface.

  • Allow configuration through API key in python via tidy3d.web.configure(apikey: str) function.


  • adjoint plugin now filters out adjoint sources that are below a threshold in amplitude relative to the maximum amplitude of the monitor data, reducing unnecessary processing by eliminating sources that won’t contribute to the gradient.

  • ArrayLike fields use np.ndarray internally instead of TidyNDArray subclass. Tidy3D objects are no longer hashable, instead, hash the obj.json() string.


  • web.Batch monitoring is more robust, will not raise exception if a job errors or diverges. In this case, the progressbar text will render in red.

  • More robust handling for 2D structure validator.

2.0.3 - 2023-4-11#



  • Times logged in tidy3d.log during solver run now split into Solver time (time-stepping only), Field projection time (after the time stepping if any field projection monitors present) and Data write time (when the raw data is packaged to disk). Previously, Solver time used to include the Field projection time and not Data write time.


  • Port name duplication in smatrix plugin for multimode ports.

  • Web functions create the leading directories for the supplied filename if they don’t exist.

  • Some docstring examples that were giving warnings.

  • web.monitor() only prints message when condition met.

  • PML boxes have non-zero extent along any dimensions where the simulation has 0 size, to fix plotting issues for 2D simulations.

  • Improved PEC handling around curved interfaces and structure intersections. Old handling accessible with subpixel=False (previously, it was independent of the subpixel setting).

  • Fix to field projections sometimes containing NaN values.

2.0.2 - 2023-4-3#




  • Bug in web interface when Simulation upload was not putting quotes around td.inf values.

2.0.1 - 2023-3-31#



  • Default Tidy3D logging level is now set to 'WARNING'.

  • Tidy3D is no longer pip installable from tidy3d-beta on PyPI.

  • Plugins must be imported from their respective directories, eg. from tidy3d.plugins.mode import ModeSolver.

  • Removed Geometry.intersections().

  • Log level only accepts upper case strings.

  • PolySlab reference_plane is "middle" by default.

  • Boundary conditions are now PML() by default.

  • PointDipole sources now have a continuous dependence on the source position, as opposed to snapping to Yee grid locations. Behavior is controlled by the interpolate argument, set to True by default.

  • smatrix plugin accepts list of frequencies and returns data as an xarray.DataArray instead of a nested dict.

  • importlib-metadata version set to >= 6.0.0.


  • Helpful error message if user has insufficient credits.

1.10.0 - 2023-3-28#


  • TriangleMesh class for modeling geometries specified by triangle surface meshes, with support for STL file import.

  • Total-field scattered-field (TFSF) source which allows angled plane waves to be injected into a finite region of space (the total-field region), such that only scattered fields exist outside this region (scattered-field region).

  • Medium2D class for surface conductivity model of a 2D material.

  • Entries in material_library for graphene and some common TMDs.

  • Ability to create a 2D representation of a thin 3D material.

  • SimulationData.plot_field accepts new field components and values, including the Poynting vector.

  • SimulationData.get_poynting_vector for calculating the 3D Poynting vector at the Yee cell centers.

  • Post-init validation of Tidy3D components.

  • Validate post-Simulation init to error if any structures have bounds that terminate inside of the PML.

  • Validate slab_bounds for PolySlab.


  • Tidy3D account authentication done solely through API key. Migration option offered for useres with old username / password authentication.

  • export_matlib_to_file in material_library exports material’s full name in addition to abbreviation.

  • Simpler progress bars for run_async.

  • Medium property n_cfl added to adjust time step size according to CFL condition.

  • In the mode solver plugin, regular methods in transformed into classmethods.

  • ArrayLike types are stored internally as np.ndarray and written to json as lists. constrained_array() provides way to validate ArrayLike values based on ndim and dtype.

  • Pip installing tidy3d automatically creates ~/.tidy3d directory in home directory.

  • Percentage done and field decay determined through http request.

  • SourceTime plotting methods .plot() and .plot_spectrum() accept a val kwarg, which selects which part of the data ('real', 'imag', or 'abs') to plot, rather than plotting all at once.


  • Bug in remote file transfer when client environment has no correct certificate authority pem file install locally.

  • Tidy3D exceptions inherit from ValueError so they are handled properly by pydantic.

  • Two unstable materials in material_library: Cu_JohnsonChristy1972 and Ni_JohnsonChristy1972. TiOx_HoribStable added for improved stability.

  • Bug in infinite long cylinder when the reference_plane is not at the bottom or the cylinder is slanted.

1.9.3 - 2023-3-08#


  • Allow new tidy3d.config.logging_level to accept lower case for backwards compatibility.

1.9.2 - 2023-3-08#


  • set_logging_console allows redirection of console messages to stderr.


  • Use custom logger to avoid changing global logging state when importing tidy3d.

  • Separate logging configuration from custom exception definitions.

1.9.1 - 2023-3-06#


  • Avoiding shapely warning in some cases when checking intersection with an empty shape.

  • Medium.eps_model error when supplied a list of frequencies rather than a numpy array.

  • Set install requirement rich<12.6.0 to fix double output in webapi functions.

1.9.0 - 2023-3-01#


  • Specification of relative permittivity distribution using raw, user-supplied data through a CustomMedium component.

  • Automatic differentiation through Tidy3D simulations using jax through tidy3d.plugins.adjoint.

  • New Drude model variants for Gold and Silver in the material_library.

  • Plugin ComplexPolySlab for supporting complex polyslabs containing self-intersecting polygons during extrusion.

  • Asynchronous running of multiple simulations concurrently using web.run_async.

  • Jax-compatible run_async in the adjoint plugin for efficiently running multi-simulation objectives concurrently and differentiating result.

  • Warning in Simulation.epsilon if many grid cells and structures provided and slow run time expected as a result.

  • verbose option in tidy3d.web functions and containers. If False, there will be no non-essential output when running simulations over web api.

  • Warning if PML or absorbing boundaries are used along a simulation dimension with zero size.


  • Saving and loading of .hdf5 files is made orders of magnitude faster due to an internal refactor.

  • PolySlab.from_gds supports gds_cell from both gdspy and gdstk, both packages are made optional requirements.

  • Adjoint plugin JaxCustomMedium is made faster and can handle several thousand pixels without significant overhead.

  • Jax is made an optional requirement. The adjoint plugin supports jax versions 0.3 and 0.4 for windows and non-windows users, respectively.

  • Issue a deprecation warning that Geometry.intersections will be renamed to Geometry.intersections_plane in 2.0.

  • Limit some warnings to only show for the first structure for which they are encountered.

  • Billed flex unit no longer shown at the end of as it may take a few seconds until it is available. Instead, added a web.real_cost(task_id) function to get the cost after a task run.

  • Refactored tidy3d.web for more robustness and test coverage.


  • Progressbars always set to 100% when webapi functions are finished.

  • Faster handling of Geometry.intersects and Geometry.inside by taking into account geometry bounds.

  • Numpy divide by zero warning in mode solver fixed by initializing jacobians as real instead of complex.

  • Bug in validators for 2D objects being in homogeneous media which were looking at the infinite plane in which the objects lie. This can also significantly speed up some validators in the case of many structures.

  • Sources and monitors with bend radii are displayed with curved arrows.

1.8.4 - 2023-2-13#


  • Error importing Axes type with most recent matplotlib release (3.7).

1.8.3 - 2023-1-26#


  • Bug in Simulation.epsilon with coord_key="centers" in which structures were not rendered.

  • Missing @functools.wrap in ensure_freq_in_range decorator from causing incorrect docstrings.

1.8.2 - 2023-1-12#


  • Warning if users install via tidy3d-beta on pip, from now on, best to use tidy3d directly.

  • Support for dispersive media in AnisotropicMedium


  • Support shapely version >=2.0 for all python versions.

  • Internally refactor Simulation.epsilon and move eps_diagonal to Structure in preparation for future changes.

  • Readme displays updated instructions for installing tidy3d (remove beta version mention).


  • Field decay warning in mode solver when symmetry present.

  • Formatting bug in Tidy3d custom exceptions.


1.8.1 - 2022-12-30#


  • Environment variable TIDY3D_SSL_VERIFY to optionally disable SSL authentication (default is True).

  • Billed FlexUnit cost displayed at the end of web.monitor.


  • Bug on Windows systems with submitting CustomFieldSource data to the server.

  • Fix to FieldData.symmetry_expanded_copy for monitors with colocate=True.


  • The Simulation version updater is called every time a Simulation object is loaded, not just from_file.

  • Boundary specifications that rely on the default Periodic boundary now print a deprecation warning, as the default boundaries will change to PML in Tidy3D 2.0.

1.8.0 - 2022-12-14#


  • CustomFieldSource that can inject arbitrary source fields.

  • ElectromagneticFieldData.flux property for data corresponding to 2D monitors, and method for computing the overlap integral over two sets of frequency-domain field data.

  • Data corresponding to 2D FieldMonitor and FieldTimeMonitor, as well as to ModeSolverMonitor, now also stores grid_correction data related to the finite grid along the normal direction. This needs to be taken into account to avoid e.g. numerical oscillations of the flux with the exact position of the monitor that is due to the interpolation from the grid cell boundaries. These corrections are automatically applied when using the flux and dot methods.

  • Resonance finding plugin for estimating resonance frequency and Q-factor of multiple resonances from time-domain data. Accessed through tidy3d.plugins.ResonanceFinder.

  • New .updated_copy(**kwargs) method to all tidy3d objects to add a more convenient shortcut to copying an instance with updated fields, i.e. med.copy(update=dict(permittivity=3.0)) becomes med.updated_copy(permittivity=3.0).

  • Test support for python 3.11.

  • sidewall_angle option for Cylinder that allows a Cylinder to be tuned into a conical frustum or a cone.

  • reference_plane for PolySlab that provides options to define the vertices at the bottom, middle, or top of the PolySlab.

  • Automesh generation: MeshOverrideStructure that allows for a direct grid size specification in override structures, and dl_min that bounds the minimal grid size.

  • More material models to the material database such as gold from Olman2012.

  • In AdvancedFitterParam for StableDispersionFitter, random_seed option to set the random seed, and bound_f_lower to set the lower bound of pole frequency.

  • Introduced the option to project fields at near, intermediate, and far distances using an exact Green’s function formalism which does not make far-field approximations. This can be enabled in any AbstractFieldProjectionMonitor by setting far_field_approx=False. A tutorial notebook as a comprehensive reference for field projections was added to the documentation.

  • Tracking of modes in ModeSolverData based on overlap values, controlled through ModeSpec.track_freq.

  • Native broadband support for GassuainBeam AstigmaticGaussianBeam, and ModeSource through the num_freqs argument.

  • Apodization option for frequency-domain monitors to ignore temporal data in the beginning and/or end of a simulation


  • Minimum flex unit charge reduced from 0.1 to 0.025.

  • Default courant factor was changed from 0.9 to 0.99.

  • A point dipole source placed on a symmetry plane now always has twice the amplitude of the same source in a simulation without the symmetry plane, as expected by continuity with the case when the dipole is slightly off the symmetry plane, in which case there are effectively two dipoles, the original one and its mirror image. Previously, the amplitude was only doubled for dipoles polarized normal to the plane, because of Yee grid specifics.

  • FluxMonitor and FluxTimeMonitor no longer snap fields to centers, but instead provide continuous interpolation of the flux over the exact geometry of the monitor.

  • Major refactor to internal handling of data structures, including pure Dataset components that do not depend on other Tidy3D components and may therefore be used to define custom data in Tidy3D models.

  • Speed and memory usage improvement when writing and reading Tidy3d models to and from .hdf5 files.

  • Writing Tidy3D models containing custom data to .json file will log a warning and exclude the raw data from the file for performance reasons.

  • Material database reorganization and fixing a few references to the dispersion data.

  • The name Near2Far has been replaced with FieldProjection. For example, Near2FarAngleMonitor is now FieldProjectionAngleMonitor.

  • The API for far field projections has been simplified and several methods have now become properties. For example, the radar cross section is now accessed as .radar_cross_section, not .radar_cross_section().

  • Added a method renormalize_fields to AbstractFieldProjectionData to re-project far fields to different projection distances.

  • The API for DiffractionData was refactored to unify it with the API for AbstractFieldProjectionData.

  • The user no longer needs to supply orders_x and orders_y when creating a DiffractionMonitor; all allowed orders are automatically generated and returned in the resulting DiffractionData.

  • The user no longer needs to supply a medium when creating a DiffractionMonitor or any AbstractFieldProjectionMonitor; the medium through which fields are to be projected is now determined automatically based on the medium in which the monitor is placed.

  • The following attributes of AbstractFieldProjectionMonitor are now properties rather than methods: fields_spherical, fields_cartesian, power, radar_cross_section.


  • Some issues in DiffractionMonitor that is not z-normal that could lead to solver errors or wrong results.

  • Bug leading to solver error when Absorber boundaries with num_layers = 0 are used.

  • Bug leading to solver error when a FieldMonitor crosses a BlochBoundary and not all field components are recorded.

  • When running a Batch, path_dir is created if not existing.

  • Ignore shapely STRtree deprecation warning.

  • Ignore x axis when plotting 1D Simulation cross sections to avoid plot irregularities.

  • Local web api tests.

  • Use Tidy3D logger for some warnings that used to use default python logging.


  • Replaced gdspy dependency with gdstk.

1.7.1 - 2022-10-10#


  • medium field in DiffractionMonitor for decomposition of fields that are not in vacuum.


  • Bug in meshing an empty simulation with zero size along one dimension.

  • Bug causing error in the solver when a PermittivityMonitor is present in the list of monitors and is not at the end of the list.

1.7.0 - 2022-10-03#


  • DiffractionMonitor to compute the power amplitude distribution in all diffraction orders in simulations of periodic structures.

  • PolySlab can be oriented along x or y, not just z.


  • Loading components without validation no longer supported as it is too unpredictable.

  • Webplots plugin was removed as it was cumbersome to maintain and no longer used in web UI.

1.6.3 - 2022-9-13#


  • Type field for DataArray subclasses written to hdf5.


  • Docstring for FluxMonitor and FluxTimeMonitor.


  • Explicit error message about grid_size deprecation.

1.6.2 - 2022-9-6#


  • Support for Near2Far monitors in the presence of simulation symmetries.


  • Bug in 3D Near2Far monitors where surfaces defined in exclude_surfaces will no actually be excluded.

  • Bug in getting angles from k-space values in Near2FarKSpaceMonitor.

  • Bug in SimulationData.plot_field when getting the position along the normal axis for a 2D plot.

1.6.1 - 2022-8-31#


  • Bug in new simulation upload on Windows machines.

1.6.0 - 2022-8-29#


  • New classes of near-to-far monitors for server-side computation of the near field to far field projection.

  • Option to exlude DataArray Fields from a Tidy3dBaseModel json.

  • Option to save/load all models to/from hdf5 format.

  • Option to load base models without validation.

  • Support negative sidewall angle for slanted PolySlab-s.

  • Option to specify only a subset of the S-matrix to compute in the S-matrix plugin, as well as to provide mapping between elements (due to symmetries).

  • More Lorentz-Drude material models to the material database.


  • Raise a more meaningful error if login failed after MAX_ATTEMPTS.

  • Environment login credentials set to "" are now ignored and credentials stored to file are still looked for.

  • Improved subpixel coefficients computation around sharp edges, cornes, and three-structure intersections.


  • Major refactor of the way data structures are used internally.

  • ModeFieldMonitor -> ModeSolerMonitor with associated ModeSolverData. ModeSolverData is now also stored internally in ModeSolver, and the plot_field method can be called directly from ModeSolver instead of ModeSolverData.

  • Field data for monitors that have a zero size along a given dimension is now interpolated to the exact along that dimension.

  • Removed nlopt from requirements, user-side material fitting now uses scipy.

  • New Field normalize_index in Simulation - used to be input parameter when loading simulation data. A given SimulationData can still be renormalized to a different source later on using the new SimulationData.renormalize.

  • FluxMonitor and FluxTimeMonitor-s can now have a 3D box geometry, in which case the flux going out of all box surfaces is computed (optionally, some surfaces can be excluded).

  • Frequency-domain monitors require a non-empty list of frequencies.

  • Reduced the minimum flex unit cost to run a simulation to 0.1.

  • Reduced the premium cost for dispersive materials in typical cases.

  • Added a cost for monitors that should be negligible in typical cases but affects large monitors that significantly slow down the simulation.

1.5.0 - 2022-7-21#


  • Bug in computing the bounds of GeometryGroup.

  • Bug in auto-mesh generation.


  • Ability to compute field projections server-side.


  • All Tidy3D components apart from data structures are now fully immutable.

  • Stopped support for python 3.6, improved support for python 3.10.

  • Web material fitter for lossless input data (no k data provided) will now return a lossless medium.

  • sort_by changed to filter_pol in ModeSpec.

  • center no longer a field of all Geometry components, instead only present when needed, removed in PolySlab and GeometryGroup. Planar geometries no longer have a mandatory length field, but have center_axis and lengt_axis properties for the center and length along the extrusion axis. PolySlab now defined exclusively through slab_bounds, while Cylinder through center and length.

  • In mode solver, allow precision to switch between double and single precision.

  • Near-to-far transformation tool is no longer a plugin, but is now part of Tidy3D’s new core data structures

1.4.1 - 2022-6-13#


  • Bug in plotting polarization of a nomral incidence source for some angle_phi.

  • Bloch vector values required to be real rather than complex.

  • Web security mitigation.

1.4.0 - 2022-6-3#


  • Bug in plotting when alpha is turned off in permittivity overlay.

  • Bug in plotting polarization of an angled incidence source (S,P -> P,S).

  • Throw warning if user tries to download data instances in yaml or json format.

  • Arrow length plotting issues for infinite sources.

  • Issues with nonuniform mesh not extending exactly to simulation boundaries.


  • Bloch periodic boundary conditions, enabling modeling of angled plane wave.

  • GeometryGroup object to associate several Geometry intances in a single Structure leading to improved performance for many objects.

  • Ability to uniquely specify boundary conditions on all 6 Simulation boundaries.

  • Options in field montitors for spatial downsampling and evaluation at yee grid centers.

  • BatchData.load() can load the data for a batch directly from a directory.

  • Utility for updating Simulation objects from old versions of Tidy3d to current version.

  • Explicit web. functions for downloading only simulation.json and tidy3d.log files.


  • Batch objects automatically download their json file upon download and load.

  • Uses shapely instead of gdspy to merge polygons from a gds cell.

  • ComponentModeler (S matrix tool) stores the Batch rather than the BatchData.

  • Custom caching of properties to speed up subsequent calculations.

  • Tidy3d configuration now done through setting attributes of tidy3d.config object.

1.3.3 - 2022-5-18#


  • Bug in Cylinder.inside when axis != 2.


  • AstigmaticGaussianBeam source.


  • Internal functions that may require hashing the simulation many times now use a make_static decorator. This pre-computes the simulation hash and stores it, and makes sure that the simulation has not changed at the beginning and end of the function execution.

  • Speeding up initialization of PolySlab when there is no dilation or slant angle.

  • Allow customizing data range that colormap covers in plot_field.

  • Speeding up of the automatic grid generation using Rtree and other improvements.

  • Better handling of http response errors.

  • In web.monitor, the estimated cost is only displayed when available; avoid “Unable to get cost” warning.

  • In PolySlab.from_gds, the selected polygons are first merged if possible, before the PolySlab-s are made. This avoids bugs e.g. in the case of slanted walls.

1.3.2 - 2022-4-30#


  • Bug in nonuniform mesh where the simulation background medium may be taken into account if higher than other structures overriding it.

1.3.1 - 2022-4-29#



  • The copy() method of Tidy3d components is deep by default.

  • Maximum allowed number of distinct materials is now 65530.


  • Monitor/source opacity values also applied to associated arrows.

  • Auto meshing in the presence of symmetries ignores anything outside of the main symmetry quadrant.

  • If an interface is completely covered by another structure, it is ignored by the mesher.

1.3.0 - 2022-4-26#


  • New grid_spec Field in Simulation that allows more flexibility in defining the mesh.

  • GridSpec1d class defining how the meshing along each dimension should be done, with sublcasses UniformGrid and CustomGrid that cover the functionality previously offered by supplying a float or a list of floats to Simulation.grid_size. New functionality offered by AutoGrid subclass, with the mesh automatically generated based on the minimum required steps per wavelength.

  • New PointDipole source.

  • Opacity kwargs for monitor and source in sim.plot.

  • Separated plotly-based requirements from core requrements file, can be added with "pip install tidy3d-beta[plotly]".


  • Simulation.grid_spec uses the default GridSpec, which has AutoGrid(min_steps_per_wvl=10) in each direction. To initialize a Simulation then it is no longer needed to provide grid information, if sources are added to the simulation. Otherwise an error will be raised asking to provide a wavelength for the auto mesh.

  • VolumeSource is now called UniformCurrentSource.

  • S-matrix module now places the monitors exactly at the port locations and offsets the source slightly for numerical reasons (more accurate).

  • Fixed bug in PolySlab visualization with sidewalls.

  • Inheritance structure of Source reorganized.

  • Better handling of only one td.inf in Box.from_bounds.

  • Added proper label to intensity plots.

  • Made all attributes Field() objects in to clean up docs.

  • Proper handling of Medium.eps_model at frequency of td.inf and None.


  • Simulation.grid_size is removed in favor of Simulation.grid_spec.

1.2.2 - 2022-4-16#


  • SimulationDataApp GUI for visualizing contents of SimulationData in tidy3d.plugings.

  • SimulationPlotly interface for generating Simulation.plot() figures using plotly instead of matplotlib.

  • New PermittivityMonitor and PermittivityData to store the complex relative permittivity as used in the simulation.

  • The maximum credit cost for a simulation can now be queried using web.estimate_cost. It is also displayed by default during web.upload.


  • Faster plotting for matplotlib and plotly.

  • SimulationData normalization keeps track of source index and can be normalized when loading directly from .hdf5 file.

  • Monitor data with symmetries now store the minimum required data to file and expands the symmetries on the fly.

  • Significant speedup in plotting complicated simulations without patch transparency.

  • When a list of dl is provided as a grid_size along a given direction, the grid is placed such that the total size np.sum(dl) is centered at the simulation center. Previously, a grid boundary was always placed at the simulation center.

1.2.1 - 2022-3-30#



  • webapi functions now only authenticate when needed.

  • Credentials storing folder only created when needed.

  • Added maximum number of attemtps in authentication.

  • Made plotly plotting faster.

  • Cached Simulation.medium and Simulation.medium_map computation.

1.2.0 - 2022-3-28#


  • PolySlab geometries support dilation and angled sidewalls.

  • Percent done monitoring of jobs running longer than 10 seconds.

  • Can use vectorized spherical coordinates in tidy3d.plugins.Near2Far.

  • ModeSolver returns a ModeSolverData object similar to SimulationData, containing all the information about the modes.

  • ModeFieldMonitor and ModeFieldData allow the results of a mode solve run server-side to be stored.

  • Plotting of ModeFieldData fields in SimulationData.plot_field and ModeSolverData.plot_field.

  • Ordering of modes by polarization fraction can be specified in ModeSpec.

  • Angled mode sources.


  • Significant speed improvement for Near2Far calculations.

  • freq no longer passed to ModeSolver upon init, instead a list of freqs passed to ModeSolver.solve.

  • Mode solver now returns ModeSolverData object containing information about the mode fields and propagation constants as data arrays over frequency and mode index.

  • Reorganized some of the internal Source classes.

  • Major improvements to Batch objects. returns a BatchData object that maps task_name to SimulationData.

  • Infinity stored as str in json outputs, conforming to json file specifications.

  • No longer need to specify one of x/y/z in SimulationData.plot_field if the monitor has a zero-sized dimension.

  • Simulation.run_time but must be > 0 to upload to server.

1.1.1 - 2022-3-2#



  • Fixed issue where smatrix was not uploaded to pyPI.

1.1.0 - 2022-3-1#


  • Simulation symmetries now fully functional.

  • Ability to perform near-to-far transformations from multiple surface monitors oriented along the x, y or z directions using tidy3d.plugins.Near2Far.

  • tidy3d.plugins.ComponentModeler tool for scattering matrix calculations.


  • Major enhancements to near field to far field transformation tool: multiple monitors supported with arbitrary configuration, user control over sampling point density.

  • Fixed visualization bug in symmetry.

1.0.2 - 2022-2-24#


  • Clarified license terms to not include scripts written using the tidy3d python API.

  • Simulation symmetries are now enabled but currently only affect the mode solver, if the mode plane lies on the simulation center and there’s a symmetry.

  • Validator that mode objects with symmetries are either entirely in the main quadrant, or lie on the symmetry axis.

    • Simulation.plotly() makes a plotly figure of the cross section.

    • Dispersion fitter can parse urls from

  • Clarified license terms to not include scripts written using the tidy3d python API.


  • Fixed a bug in python 3.6 where polyslab vertices loaded differently from file.

1.0.1 - 2022-2-16#


  • Selmeier.from_dispersion() method to quickly make a single-pole fit for lossless weakly dispersive materials.

  • Stable dispersive material fits via webservice.

  • Allow to load dispersive data directly by providing URL to txt or csv file

  • Validates simulation based on discretized size.


  • Polyslab.from_gds returns a list of PolySlab objects imported from all polygons in given layer and dtype, can optionally specify single dtype.

  • Warning about structure close to PML disabled if Absorber type.

  • Source dft now ignores insignificant time amplitudes for speed.

  • New color schemes for plots.

1.0.0 - 2022-1-31#


  • Stable dispersive material fits via webservice.


  • Refined and updated documentation.

0.2.0 - 2022-1-29#


  • FieldMonitor.surface() to split volume monitors into their surfaces.

  • Units and annotation to data.

  • Faster preprocessing.

  • Web authentication using environment variables TIDY3D_USER and TIDY3D_PASS.

  • callback_url in web API to put job metadata when a job is finished.

  • Support for non uniform grid size definition.

  • Gaussian beam source.

  • Automated testing through tox and github actions.

0.1.1 - 2021-11-09#



0.1.0 - 2021-10-21#


  • Web API implemented by converting simulations to old tidy3D

Alpha Release Changes#


  • Solver speed improvement (gain depending on simulation + hardware details).

  • Bringing the speed of the non-angled mode solver back to pre-21.4.2 levels.


  • Improvements to subpixel averaging for dispersive materials.

  • Enabled web login using environment variables TIDY3D_USER and TIDY3D_PASS.


  • Bugfix when running simulation with zero run_time.

  • More internal logging.

  • Fixed unstable 'Li1993_293K' variant of cSi in the material library.

  • Bugfix when downloading data on Windows.

  • Bugfix in material fitting tool when target tolerance is not reached.


  • New Gaussian beam source and example usage.

  • Modal sources and monitors in bent and in angled waveguides with tutorial.

  • Nyquist-limit sampling in frequency-domain monitors (much faster without loss of accuracy).

  • Support for Drude model of material dispersion.

  • Small bugfixes to some of the other dispersion models.

  • PEC boundaries applied by default at the truncation of any boundary with PML, avoiding potential

    issues with using periodic boundaries under the PML instead.

  • Source normalization no longer adding a spurious frequency-dependent phase to the fields.

  • Fixed bug in unpacking monitor fields with symmetries and interpolate=False.

  • Lots of streamlining on the backend side.


  • Fixed bug with zero-size monitor plotting.

  • Fixed bug with empty simulation run introduced in 21.4.0.


  • A few small fixes.

  • Fixed nonlinear constraint in dispersive material fitting tool.

  • Fixed potential issue when a monitor stores neither 'E' nor 'H'.

  • Fixed some backwards compatibility issues introduced in

  • Frequency monitors can now optionally store the complex permittivity at the same locations where the E-fields are recorded, at the monitor frequencies.

  • Frequency monitors now also have an 'interpolate' keyword, which defaults to True and reproduces the behavior of previous versions. If set to False, however, the raw fields evaluated at their corresponding Yee grid locations are returned, instead of the fields interpolated to the Yee cell centers. This also affects the returned permittivity, if requested.

  • Reorganized internal source time dependence handling, enabling more complicated functionality in the future, like custom source time.

  • Total field in the simulation now sampled at the time step of the peak of the source time dependence, for better estimation of the shutoff factor.

  • A number of bug fixes, especially in the new plotting introduced in

  • Reorganized plotting:

  • Speeding up structure visualizations.

  • Structures now shown based on primitive definitions rather than grid discretization. This

    then shows the physical structures but not what the simulation “sees”. Will add an option to display the grid lines in next version.

  • Bumped down matplotlib version requirement to 3.2 and python version requirement to 3.6.

  • Improved handling of PEC interfaces.- Reorganized and extended internal logging.

  • Added tidy3d.__version__.

  • A number of fixes to the example notebooks and the colab integration.

  • Bumping back python version requirement from 3.8 to 3.7.

  • Hotfix to an internal bug in some simulation runs.

  • New dispersion fitting tool for material data and accompanying tutorial.

  • (beta) Non-uniform Cartesian meshing now supported. The grid coordinates are provided

    by hand to Simulation. Next step is implementing auto-meshing.

  • DispersionModel objects can now be directly used as materials.

  • Fixed bug to Cylinder subpixel averaging.

  • Small bugs fixes/added checks for some edge cases.

  • Rehash of symmetries and support for mode sources and monitors with symmetries.

  • Anisotropic materials (diagonal epsilon tensor).

  • Rehashed error handling to output more runtime errors to tidy3d.log.

  • Job and Batch classes for better simulation handling (eventually to fully replace webapi functions).

  • A large number of small improvements and bug fixes.