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.0.1] - 2023-3-31#
Default Tidy3d logging level is now set to
Tidy3D is no longer pip installable from
Plugins must be imported from their respective directories, eg.
from tidy3d.plugins.mode import ModeSolver.
Log level only accepts upper case strings.
Boundary conditions are now
PointDipolesources now have a continuous dependence on the source position, as opposed to snapping to Yee grid locations. Behavior is controlled by the
interpolateargument, set to
smatrixplugin accepts list of frequencies and returns data as an
xarray.DataArrayinstead of a nested
importlib-metadataversion set to
Helpful error message if user has insufficient credits.
1.10.0 - 2023-3-28#
TriangleMeshclass 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).
Medium2Dclass for surface conductivity model of a 2D material.
material_libraryfor graphene and some common TMDs.
Ability to create a 2D representation of a thin 3D material.
SimulationData.plot_fieldaccepts new field components and values, including the Poynting vector.
SimulationData.get_poynting_vectorfor 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.
Tidy3D account authentication done solely through API key. Migration option offered for useres with old username / password authentication.
material_libraryexports material’s full name in addition to abbreviation.
Simpler progress bars for
n_cfladded to adjust time step size according to CFL condition.
In the mode solver plugin, regular methods in
solver.pytransformed into classmethods.
ArrayLiketypes are stored internally as
np.ndarrayand written to json as lists.
constrained_array()provides way to validate
ArrayLikevalues based on
Pip installing tidy3d automatically creates
~/.tidy3ddirectory in home directory.
Percentage done and field decay determined through http request.
valkwarg, which selects which part of the data (
'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
ValueErrorso they are handled properly by pydantic.
Two unstable materials in
TiOx_HoribStableadded for improved stability.
Bug in infinite long cylinder when the
reference_planeis not at the bottom or the cylinder is slanted.
1.9.3 - 2023-3-08#
tidy3d.config.logging_levelto accept lower case for backwards compatibility.
1.9.2 - 2023-3-08#
set_logging_consoleallows 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_modelerror when supplied a list of frequencies rather than a numpy array.
Set install requirement
rich<12.6.0to fix double output in webapi functions.
1.9.0 - 2023-3-01#
Specification of relative permittivity distribution using raw, user-supplied data through a
Automatic differentiation through
New Drude model variants for Gold and Silver in the
ComplexPolySlabfor supporting complex polyslabs containing self-intersecting polygons during extrusion.
Asynchronous running of multiple simulations concurrently using
adjointplugin for efficiently running multi-simulation objectives concurrently and differentiating result.
Simulation.epsilonif many grid cells and structures provided and slow run time expected as a result.
tidy3d.webfunctions 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
.hdf5files is made orders of magnitude faster due to an internal refactor.
gdstk, both packages are made optional requirements.
JaxCustomMediumis 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.intersectionswill be renamed to
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
web.runas 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.
tidy3d.webfor more robustness and test coverage.
Progressbars always set to 100% when webapi functions are finished.
Faster handling of
Geometry.insideby 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#
Axestype with most recent
1.8.3 - 2023-1-26#
coord_key="centers"in which structures were not rendered.
medium.pycausing incorrect docstrings.
1.8.2 - 2023-1-12#
Warning if users install via
tidy3d-betaon pip, from now on, best to use
Support for dispersive media in
Support shapely version >=2.0 for all python versions.
Structurein 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#
TIDY3D_SSL_VERIFYto optionally disable SSL authentication (default is
Billed FlexUnit cost displayed at the end of
Bug on Windows systems with submitting
CustomFieldSourcedata to the server.
FieldData.symmetry_expanded_copyfor monitors with
Simulationversion updater is called every time a
Simulationobject is loaded, not just
Boundary specifications that rely on the default
Periodicboundary now print a deprecation warning, as the default boundaries will change to
PMLin Tidy3D 2.0.
1.8.0 - 2022-12-14#
CustomFieldSourcethat can inject arbitrary source fields.
ElectromagneticFieldData.fluxproperty for data corresponding to 2D monitors, and
ElectromagneticFieldData.dotmethod for computing the overlap integral over two sets of frequency-domain field data.
Data corresponding to 2D
FieldTimeMonitor, as well as to
ModeSolverMonitor, now also stores
grid_correctiondata 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
Resonance finding plugin for estimating resonance frequency and Q-factor of multiple resonances from time-domain data. Accessed through
.updated_copy(**kwargs)method to all tidy3d objects to add a more convenient shortcut to copying an instance with updated fields, i.e.
Test support for python 3.11.
Cylinderthat allows a
Cylinderto be tuned into a conical frustum or a cone.
PolySlabthat provides options to define the vertices at the bottom, middle, or top of the
MeshOverrideStructurethat allows for a direct grid size specification in override structures, and
dl_minthat bounds the minimal grid size.
More material models to the material database such as gold from Olman2012.
random_seedoption to set the random seed, and
bound_f_lowerto 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
far_field_approx=False. A tutorial notebook as a comprehensive reference for field projections was added to the documentation.
Tracking of modes in
ModeSolverDatabased on overlap values, controlled through
Native broadband support for
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
Default courant factor was changed from
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.
FluxTimeMonitorno 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
Datasetcomponents that do not depend on other
Tidy3Dcomponents and may therefore be used to define custom data in
Speed and memory usage improvement when writing and reading Tidy3d models to and from
Tidy3Dmodels containing custom data to
.jsonfile 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.
Near2Farhas been replaced with
FieldProjection. For example,
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
Added a method
AbstractFieldProjectionDatato re-project far fields to different projection distances.
The API for
DiffractionDatawas refactored to unify it with the API for
The user no longer needs to supply
orders_ywhen creating a
DiffractionMonitor; all allowed orders are automatically generated and returned in the resulting
The user no longer needs to supply a
mediumwhen creating a
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
AbstractFieldProjectionMonitorare now properties rather than methods:
Some issues in
DiffractionMonitorthat is not
z-normal that could lead to solver errors or wrong results.
Bug leading to solver error when
num_layers = 0are used.
Bug leading to solver error when a
BlochBoundaryand not all field components are recorded.
When running a
path_diris created if not existing.
Ignore x axis when plotting 1D
Simulationcross sections to avoid plot irregularities.
Local web api tests.
Use Tidy3D logger for some warnings that used to use default python logging.
1.7.1 - 2022-10-10#
DiffractionMonitorfor 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
PermittivityMonitoris present in the list of monitors and is not at the end of the list.
1.7.0 - 2022-10-03#
DiffractionMonitorto compute the power amplitude distribution in all diffraction orders in simulations of periodic structures.
PolySlabcan be oriented along
y, not just
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
DataArraysubclasses written to
Explicit error message about
1.6.2 - 2022-9-6#
Near2Farmonitors in the presence of simulation symmetries.
Bug in 3D
Near2Farmonitors where surfaces defined in
exclude_surfaceswill no actually be excluded.
Bug in getting angles from
k-space values in
SimulationData.plot_fieldwhen 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
DataArrayFields from a
Option to save/load all models to/from
Option to load base models without validation.
Support negative sidewall angle for slanted
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
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.
ModeSolverDatais now also stored internally in
ModeSolver, and the
plot_fieldmethod can be called directly from
Field data for monitors that have a zero size along a given dimension is now interpolated to the exact
monitor.centeralong that dimension.
nloptfrom requirements, user-side material fitting now uses
Simulation- used to be input parameter when loading simulation data. A given
SimulationDatacan still be renormalized to a different source later on using the new
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
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
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
kdata provided) will now return a lossless medium.
centerno longer a field of all
Geometrycomponents, instead only present when needed, removed in
Planargeometries no longer have a mandatory
lengthfield, but have
lengt_axisproperties for the center and length along the extrusion axis.
PolySlabnow defined exclusively through
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
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
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.
GeometryGroupobject to associate several
Geometryintances in a single
Structureleading to improved performance for many objects.
Ability to uniquely specify boundary conditions on all 6
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
Simulationobjects from old versions of
Tidy3dto current version.
web.functions for downloading only
Batchobjects automatically download their json file upon
gdspyto merge polygons from a gds cell.
ComponentModeler(S matrix tool) stores the
Batchrather than the
Custom caching of properties to speed up subsequent calculations.
Tidy3d configuration now done through setting attributes of
1.3.3 - 2022-5-18#
axis != 2.
Internal functions that may require hashing the simulation many times now use a
make_staticdecorator. 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
PolySlabwhen there is no dilation or slant angle.
Allow customizing data range that colormap covers in
Speeding up of the automatic grid generation using Rtree and other improvements.
Better handling of http response errors.
web.monitor, the estimated cost is only displayed when available; avoid “Unable to get cost” warning.
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#
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#
Simulationthat allows more flexibility in defining the mesh.
GridSpec1dclass defining how the meshing along each dimension should be done, with sublcasses
CustomGridthat cover the functionality previously offered by supplying a float or a list of floats to
Simulation.grid_size. New functionality offered by
AutoGridsubclass, with the mesh automatically generated based on the minimum required steps per wavelength.
Opacity kwargs for monitor and source in
plotly-based requirements from core requrements file, can be added with
"pip install tidy3d-beta[plotly]".
Simulation.grid_specuses the default
GridSpec, which has
AutoGrid(min_steps_per_wvl=10)in each direction. To initialize a
Simulationthen 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.
VolumeSourceis now called
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
PolySlabvisualization with sidewalls.
Inheritance structure of
Better handling of only one
Added proper label to intensity plots.
Made all attributes
data.pyto clean up docs.
Proper handling of
Medium.eps_modelat frequency of
Simulation.grid_sizeis removed in favor of
1.2.2 - 2022-4-16#
SimulationDataAppGUI for visualizing contents of
SimulationPlotlyinterface for generating
PermittivityDatato 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
Faster plotting for matplotlib and plotly.
SimulationDatanormalization 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
dlis provided as a
grid_sizealong 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#
webapifunctions 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#
PolySlabgeometries support dilation and angled sidewalls.
Percent done monitoring of jobs running longer than 10 seconds.
Can use vectorized spherical coordinates in
ModeSolverDataobject similar to
SimulationData, containing all the information about the modes.
ModeFieldDataallow the results of a mode solve run server-side to be stored.
Ordering of modes by polarization fraction can be specified in
Angled mode sources.
Significant speed improvement for
freqno longer passed to
ModeSolverupon init, instead a list of
Mode solver now returns
ModeSolverDataobject containing information about the mode fields and propagation constants as data arrays over frequency and mode index.
Reorganized some of the internal
Major improvements to
BatchDataobject that maps
Infinity stored as
strin json outputs, conforming to json file specifications.
No longer need to specify one of
SimulationData.plot_fieldif the monitor has a zero-sized dimension.
Simulation.run_timebut 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#
Simulationsymmetries 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.ComponentModelertool 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 refractiveindex.info
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_gdsreturns a list of
PolySlabobjects 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.
Web authentication using environment variables
callback_urlin 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#
PML parameters and padding Grid with pml pixels by @momchil-flex in #64
Documentation by @tylerflex in #63
Gds import from @tylerflex in #69
Loggin by @tylerflex in #70
Multi-pole Drude medium by @weiliangjin2021 in #73
Mode Solver: from @tylerflex in #74
Near2Far from @tylerflex in #77
Separated docs from @tylerflex in #78
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
Bugfix when running simulation with zero
More internal logging.
cSiin 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
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
Fixed some backwards compatibility issues introduced in 18.104.22.168.
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
Trueand 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 22.214.171.124.
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.
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.
DispersionModelobjects can now be directly used as materials.
Fixed bug to
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.