From bef56db3c80e59cb5677ccc431f5911a0964b719 Mon Sep 17 00:00:00 2001 From: Tyler Hughes Date: Mon, 13 Feb 2023 17:50:38 -0600 Subject: [PATCH] preparation for 1.8.4 release --- CHANGELOG.md | 10 ++++++++-- tests/sims/simulation_1_8_4.json | 1 + tidy3d/schema.json | 4 ++-- tidy3d/version.py | 2 +- 4 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 tests/sims/simulation_1_8_4.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 437910a40..c21c5706e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.8.4] - 2023-2-13 + +### Fixed +- Import error when matplotlib updated to 3.7 + ## [1.8.3] - 2023-1-26 ### Fixed @@ -541,8 +546,9 @@ which fields are to be projected is now determined automatically based on the me - Job and Batch classes for better simulation handling (eventually to fully replace webapi functions). - A large number of small improvements and bug fixes. -[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v1.8.3...develop -[1.8.2]: https://github.com/flexcompute/tidy3d/compare/v1.8.2...v1.8.3 +[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v1.8.4...develop +[1.8.4]: https://github.com/flexcompute/tidy3d/compare/v1.8.3...v1.8.4 +[1.8.3]: https://github.com/flexcompute/tidy3d/compare/v1.8.2...v1.8.3 [1.8.2]: https://github.com/flexcompute/tidy3d/compare/v1.8.1...v1.8.2 [1.8.1]: https://github.com/flexcompute/tidy3d/compare/v1.8.0...v1.8.1 [1.8.0]: https://github.com/flexcompute/tidy3d/compare/v1.7.1...v1.8.0 diff --git a/tests/sims/simulation_1_8_4.json b/tests/sims/simulation_1_8_4.json new file mode 100644 index 000000000..3ae92ceb3 --- /dev/null +++ b/tests/sims/simulation_1_8_4.json @@ -0,0 +1 @@ +{"type": "Simulation", "center": [0.0, 0.0, 0.0], "size": [8.0, 8.0, 8.0], "run_time": 1e-12, "medium": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 1.0, "conductivity": 0.0}, "symmetry": [0, 0, 0], "structures": [{"geometry": {"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, 1.0, 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 2.0, "conductivity": 0.0}}, {"geometry": {"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, "Infinity", 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 1.0, "conductivity": 3.0}}, {"geometry": {"type": "Sphere", "radius": 1.0, "center": [1.0, 0.0, 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Sellmeier", "coeffs": [[1.03961212, 0.00600069867], [0.231792344, 0.0200179144]]}}, {"geometry": {"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, 1.0, 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Lorentz", "eps_inf": 2.0, "coeffs": [[1.0, 2.0, 3.0]]}}, {"geometry": {"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, 1.0, 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Debye", "eps_inf": 2.0, "coeffs": [[1.0, 3.0]]}}, {"geometry": {"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, 1.0, 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Drude", "eps_inf": 2.0, "coeffs": [[1.0, 3.0]]}}, {"geometry": {"type": "GeometryGroup", "geometries": [{"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, 1.0, 1.0]}]}, "name": null, "type": "Structure", "medium": {"name": "PEC", "frequency_range": null, "type": "PECMedium"}}, {"geometry": {"type": "Cylinder", "axis": 1, "sidewall_angle": 0.0, "reference_plane": "bottom", "radius": 1.0, "center": [1.0, 0.0, -1.0], "length": 2.0}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "AnisotropicMedium", "xx": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 1.0, "conductivity": 0.0}, "yy": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 2.0, "conductivity": 0.0}, "zz": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 3.0, "conductivity": 0.0}}}, {"geometry": {"type": "PolySlab", "axis": 2, "sidewall_angle": 0.0, "reference_plane": "bottom", "slab_bounds": [-1.0, 1.0], "dilation": 0.0, "vertices": [[-1.5, -1.5], [-0.5, -1.5], [-0.5, -0.5]]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "PoleResidue", "eps_inf": 1.0, "poles": [[{"real": 0.0, "imag": 6206417594288582.0}, {"real": -0.0, "imag": -3.311074436985222e+16}]]}}], "sources": [{"type": "UniformCurrentSource", "center": [0.0, 0.5, 0.0], "size": [0.0, 0.0, 0.0], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "polarization": "Hx"}, {"type": "PointDipole", "center": [0.0, 0.5, 0.0], "size": [0, 0, 0], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "polarization": "Ex"}, {"type": "ModeSource", "center": [0.0, 0.5, 0.0], "size": [2.0, 0.0, 2.0], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "num_freqs": 1, "direction": "-", "mode_spec": {"num_modes": 1, "target_neff": null, "num_pml": [0, 0], "filter_pol": null, "angle_theta": 0.0, "angle_phi": 0.0, "precision": "single", "bend_radius": null, "bend_axis": null, "track_freq": "central", "type": "ModeSpec"}, "mode_index": 0}, {"type": "PlaneWave", "center": [0.0, 0.0, 0.0], "size": [0.0, "Infinity", "Infinity"], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "direction": "+", "angle_theta": 0.0, "angle_phi": 0.0, "pol_angle": 0.1}, {"type": "GaussianBeam", "center": [0.0, 0.0, 0.0], "size": [0.0, 3.0, 3.0], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "num_freqs": 1, "direction": "+", "angle_theta": 0.0, "angle_phi": 0.0, "pol_angle": 1.5707963267948966, "waist_radius": 1.0, "waist_distance": 0.0}, {"type": "AstigmaticGaussianBeam", "center": [0.0, 0.0, 0.0], "size": [0.0, 3.0, 3.0], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "num_freqs": 1, "direction": "+", "angle_theta": 0.0, "angle_phi": 0.0, "pol_angle": 1.5707963267948966, "waist_sizes": [1.0, 2.0], "waist_distances": [3.0, 4.0]}, {"type": "CustomFieldSource", "center": [0.0, 1.0, 2.0], "size": [2.0, 2.0, 0.0], "source_time": {"amplitude": 1.0, "phase": 0.0, "type": "GaussianPulse", "freq0": 200000000000000.0, "fwidth": 40000000000000.0, "offset": 5.0}, "name": null, "field_dataset": {"type": "FieldDataset", "Ex": "XR.DATAARRAY", "Ey": null, "Ez": null, "Hx": null, "Hy": null, "Hz": null}}], "boundary_spec": {"x": {"plus": {"name": null, "type": "PML", "num_layers": 20, "parameters": {"sigma_order": 3, "sigma_min": 0.0, "sigma_max": 1.5, "type": "PMLParams", "kappa_order": 3, "kappa_min": 1.0, "kappa_max": 3.0, "alpha_order": 1, "alpha_min": 0.0, "alpha_max": 0.0}}, "minus": {"name": null, "type": "Absorber", "num_layers": 100, "parameters": {"sigma_order": 3, "sigma_min": 0.0, "sigma_max": 6.4, "type": "AbsorberParams"}}, "type": "Boundary"}, "y": {"plus": {"name": null, "type": "BlochBoundary", "bloch_vec": 1.0}, "minus": {"name": null, "type": "BlochBoundary", "bloch_vec": 1.0}, "type": "Boundary"}, "z": {"plus": {"name": null, "type": "Periodic"}, "minus": {"name": null, "type": "Periodic"}, "type": "Boundary"}, "type": "BoundarySpec"}, "monitors": [{"type": "FieldMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, 0.0, 0.0], "name": "field", "freqs": [150000000000000.0, 200000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "fields": ["Ex"], "interval_space": [1, 1, 1], "colocate": false}, {"type": "FieldTimeMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, 0.0, 0.0], "name": "field_time", "start": 0.0, "stop": null, "interval": 100, "fields": ["Ex", "Ey", "Ez", "Hx", "Hy", "Hz"], "interval_space": [1, 1, 1], "colocate": false}, {"type": "FluxMonitor", "center": [0.0, 0.0, 0.0], "size": [1.0, 1.0, 0.0], "name": "flux", "freqs": [200000000000000.0, 250000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "normal_dir": "+", "exclude_surfaces": null}, {"type": "FluxTimeMonitor", "center": [0.0, 0.0, 0.0], "size": [1.0, 1.0, 0.0], "name": "flux_time", "start": 0.0, "stop": null, "interval": 1, "normal_dir": "+", "exclude_surfaces": null}, {"type": "PermittivityMonitor", "center": [0.0, 0.0, 0.0], "size": [1.0, 1.0, 0.1], "name": "eps", "freqs": [100000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}}, {"type": "ModeMonitor", "center": [0.0, 0.0, 0.0], "size": [1.0, 1.0, 0.0], "name": "mode", "freqs": [200000000000000.0, 250000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "mode_spec": {"num_modes": 1, "target_neff": null, "num_pml": [0, 0], "filter_pol": null, "angle_theta": 0.0, "angle_phi": 0.0, "precision": "single", "bend_radius": null, "bend_axis": null, "track_freq": "central", "type": "ModeSpec"}}, {"type": "ModeSolverMonitor", "center": [0.0, 0.0, 0.0], "size": [1.0, 1.0, 0.0], "name": "mode_solver", "freqs": [200000000000000.0, 250000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "mode_spec": {"num_modes": 1, "target_neff": null, "num_pml": [0, 0], "filter_pol": null, "angle_theta": 0.0, "angle_phi": 0.0, "precision": "single", "bend_radius": null, "bend_axis": null, "track_freq": "central", "type": "ModeSpec"}}, {"type": "FieldProjectionAngleMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, 2.0, 2.0], "name": "proj_angle", "freqs": [250000000000000.0, 300000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "normal_dir": "+", "exclude_surfaces": null, "custom_origin": [1.0, 2.0, 3.0], "far_field_approx": true, "proj_distance": 1000000.0, "theta": [-1.5707963267948966, -1.5390630676677268, -1.5073298085405573, -1.4755965494133876, -1.443863290286218, -1.4121300311590483, -1.3803967720318788, -1.348663512904709, -1.3169302537775396, -1.2851969946503699, -1.2534637355232003, -1.2217304763960306, -1.189997217268861, -1.1582639581416914, -1.1265306990145216, -1.0947974398873521, -1.0630641807601826, -1.0313309216330129, -0.9995976625058433, -0.9678644033786736, -0.936131144251504, -0.9043978851243344, -0.8726646259971648, -0.8409313668699951, -0.8091981077428254, -0.7774648486156558, -0.7457315894884862, -0.7139983303613165, -0.6822650712341469, -0.6505318121069773, -0.6187985529798077, -0.5870652938526381, -0.5553320347254684, -0.5235987755982987, -0.4918655164711292, -0.46013225734395946, -0.42839899821678995, -0.3966657390896202, -0.3649324799624507, -0.333199220835281, -0.30146596170811146, -0.26973270258094173, -0.23799944345377222, -0.2062661843266025, -0.17453292519943298, -0.14279966607226324, -0.11106640694509373, -0.079333147817924, -0.047599888690754266, -0.015866629563584755, 0.015866629563584977, 0.04759988869075449, 0.07933314781792422, 0.11106640694509373, 0.14279966607226346, 0.17453292519943298, 0.2062661843266027, 0.23799944345377222, 0.26973270258094195, 0.30146596170811146, 0.3331992208352812, 0.3649324799624507, 0.39666573908962044, 0.42839899821678995, 0.4601322573439597, 0.4918655164711292, 0.5235987755982991, 0.5553320347254687, 0.5870652938526382, 0.6187985529798077, 0.6505318121069776, 0.6822650712341471, 0.7139983303613167, 0.7457315894884862, 0.7774648486156561, 0.8091981077428256, 0.8409313668699951, 0.8726646259971647, 0.9043978851243346, 0.9361311442515041, 0.9678644033786736, 0.9995976625058436, 1.031330921633013, 1.0630641807601826, 1.0947974398873521, 1.126530699014522, 1.1582639581416916, 1.189997217268861, 1.2217304763960306, 1.2534637355232006, 1.28519699465037, 1.3169302537775396, 1.348663512904709, 1.380396772031879, 1.4121300311590486, 1.443863290286218, 1.475596549413388, 1.5073298085405575, 1.539063067667727, 1.5707963267948966], "phi": [0.0, 1.5707963267948966]}, {"type": "FieldProjectionCartesianMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, 2.0, 2.0], "name": "proj_cartesian", "freqs": [250000000000000.0, 300000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "normal_dir": "+", "exclude_surfaces": null, "custom_origin": [1.0, 2.0, 3.0], "far_field_approx": true, "proj_axis": 2, "proj_distance": 5.0, "x": [-1.0, 0.0, 1.0], "y": [-2.0, -1.0, 0.0, 1.0, 2.0]}, {"type": "FieldProjectionKSpaceMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, 2.0, 2.0], "name": "proj_kspace", "freqs": [250000000000000.0, 300000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "normal_dir": "+", "exclude_surfaces": null, "custom_origin": [1.0, 2.0, 3.0], "far_field_approx": true, "proj_axis": 2, "proj_distance": 1000000.0, "ux": [0.1, 0.2], "uy": [0.3, 0.4, 0.5]}, {"type": "FieldProjectionAngleMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, 2.0, 2.0], "name": "proj_angle_exact", "freqs": [250000000000000.0, 300000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "normal_dir": "+", "exclude_surfaces": null, "custom_origin": [1.0, 2.0, 3.0], "far_field_approx": true, "proj_distance": 1000000.0, "theta": [-1.5707963267948966, -1.5390630676677268, -1.5073298085405573, -1.4755965494133876, -1.443863290286218, -1.4121300311590483, -1.3803967720318788, -1.348663512904709, -1.3169302537775396, -1.2851969946503699, -1.2534637355232003, -1.2217304763960306, -1.189997217268861, -1.1582639581416914, -1.1265306990145216, -1.0947974398873521, -1.0630641807601826, -1.0313309216330129, -0.9995976625058433, -0.9678644033786736, -0.936131144251504, -0.9043978851243344, -0.8726646259971648, -0.8409313668699951, -0.8091981077428254, -0.7774648486156558, -0.7457315894884862, -0.7139983303613165, -0.6822650712341469, -0.6505318121069773, -0.6187985529798077, -0.5870652938526381, -0.5553320347254684, -0.5235987755982987, -0.4918655164711292, -0.46013225734395946, -0.42839899821678995, -0.3966657390896202, -0.3649324799624507, -0.333199220835281, -0.30146596170811146, -0.26973270258094173, -0.23799944345377222, -0.2062661843266025, -0.17453292519943298, -0.14279966607226324, -0.11106640694509373, -0.079333147817924, -0.047599888690754266, -0.015866629563584755, 0.015866629563584977, 0.04759988869075449, 0.07933314781792422, 0.11106640694509373, 0.14279966607226346, 0.17453292519943298, 0.2062661843266027, 0.23799944345377222, 0.26973270258094195, 0.30146596170811146, 0.3331992208352812, 0.3649324799624507, 0.39666573908962044, 0.42839899821678995, 0.4601322573439597, 0.4918655164711292, 0.5235987755982991, 0.5553320347254687, 0.5870652938526382, 0.6187985529798077, 0.6505318121069776, 0.6822650712341471, 0.7139983303613167, 0.7457315894884862, 0.7774648486156561, 0.8091981077428256, 0.8409313668699951, 0.8726646259971647, 0.9043978851243346, 0.9361311442515041, 0.9678644033786736, 0.9995976625058436, 1.031330921633013, 1.0630641807601826, 1.0947974398873521, 1.126530699014522, 1.1582639581416916, 1.189997217268861, 1.2217304763960306, 1.2534637355232006, 1.28519699465037, 1.3169302537775396, 1.348663512904709, 1.380396772031879, 1.4121300311590486, 1.443863290286218, 1.475596549413388, 1.5073298085405575, 1.539063067667727, 1.5707963267948966], "phi": [0.0, 1.5707963267948966]}, {"type": "DiffractionMonitor", "center": [0.0, 0.0, 0.0], "size": [0.0, "Infinity", "Infinity"], "name": "diffraction", "freqs": [100000000000000.0, 200000000000000.0], "apodization": {"start": null, "end": null, "width": null, "type": "ApodizationSpec"}, "normal_dir": "+"}], "grid_spec": {"grid_x": {"type": "AutoGrid", "min_steps_per_wvl": 10.0, "max_scale": 1.4, "dl_min": 0.0, "mesher": {"type": "GradedMesher"}}, "grid_y": {"type": "CustomGrid", "dl": [0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04, 0.04]}, "grid_z": {"type": "UniformGrid", "dl": 0.05}, "wavelength": null, "override_structures": [{"geometry": {"type": "Box", "center": [-1.0, 0.0, 0.0], "size": [1.0, 1.0, 1.0]}, "name": null, "type": "Structure", "medium": {"name": null, "frequency_range": null, "type": "Medium", "permittivity": 2.0, "conductivity": 0.0}}], "type": "GridSpec"}, "shutoff": 0.0001, "subpixel": false, "normalize_index": 0, "courant": 0.8, "version": "1.8.4"} \ No newline at end of file diff --git a/tidy3d/schema.json b/tidy3d/schema.json index 4f63227c4..69d5a845c 100644 --- a/tidy3d/schema.json +++ b/tidy3d/schema.json @@ -1,6 +1,6 @@ { "title": "Simulation", - "description": "Contains all information about Tidy3d simulation.\n\nParameters\n----------\ncenter : Tuple[float, float, float] = (0.0, 0.0, 0.0)\n [units = um]. Center of object in x, y, and z.\nsize : Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]\n [units = um]. Size in x, y, and z directions.\nrun_time : PositiveFloat\n [units = sec]. Total electromagnetic evolution time in seconds. Note: If simulation 'shutoff' is specified, simulation will terminate early when shutoff condition met. \nmedium : Union[Medium, AnisotropicMedium, PECMedium, PoleResidue, Sellmeier, Lorentz, Debye, Drude] = Medium(name=None, frequency_range=None, type='Medium', permittivity=1.0, conductivity=0.0)\n Background medium of simulation, defaults to vacuum if not specified.\nsymmetry : Tuple[Literal[0, -1, 1], Literal[0, -1, 1], Literal[0, -1, 1]] = (0, 0, 0)\n Tuple of integers defining reflection symmetry across a plane bisecting the simulation domain normal to the x-, y-, and z-axis at the simulation center of each axis, respectvely. Each element can be ``0`` (no symmetry), ``1`` (even, i.e. 'PMC' symmetry) or ``-1`` (odd, i.e. 'PEC' symmetry). Note that the vectorial nature of the fields must be taken into account to correctly determine the symmetry value.\nstructures : Tuple[Structure, ...] = ()\n Tuple of structures present in simulation. Note: Structures defined later in this list override the simulation material properties in regions of spatial overlap.\nsources : Tuple[Annotated[Union[tidy3d.components.source.UniformCurrentSource, tidy3d.components.source.PointDipole, tidy3d.components.source.GaussianBeam, tidy3d.components.source.AstigmaticGaussianBeam, tidy3d.components.source.ModeSource, tidy3d.components.source.PlaneWave, tidy3d.components.source.CustomFieldSource], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})], ...] = ()\n Tuple of electric current sources injecting fields into the simulation.\nboundary_spec : Optional[BoundarySpec] = None\n Specification of boundary conditions along each dimension. If ``None``, periodic boundary conditions are applied on all sides. Default will change to PML in 2.0 so explicitly setting the boundaries is recommended.\nmonitors : Tuple[Annotated[Union[tidy3d.components.monitor.FieldMonitor, tidy3d.components.monitor.FieldTimeMonitor, tidy3d.components.monitor.PermittivityMonitor, tidy3d.components.monitor.FluxMonitor, tidy3d.components.monitor.FluxTimeMonitor, tidy3d.components.monitor.ModeMonitor, tidy3d.components.monitor.ModeSolverMonitor, tidy3d.components.monitor.FieldProjectionAngleMonitor, tidy3d.components.monitor.FieldProjectionCartesianMonitor, tidy3d.components.monitor.FieldProjectionKSpaceMonitor, tidy3d.components.monitor.DiffractionMonitor], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})], ...] = ()\n Tuple of monitors in the simulation. Note: monitor names are used to access data after simulation is run.\ngrid_spec : GridSpec = GridSpec(grid_x=AutoGrid(type='AutoGrid',, min_steps_per_wvl=10.0,, max_scale=1.4,, dl_min=0.0,, mesher=GradedMesher(type='GradedMesher')), grid_y=AutoGrid(type='AutoGrid',, min_steps_per_wvl=10.0,, max_scale=1.4,, dl_min=0.0,, mesher=GradedMesher(type='GradedMesher')), grid_z=AutoGrid(type='AutoGrid',, min_steps_per_wvl=10.0,, max_scale=1.4,, dl_min=0.0,, mesher=GradedMesher(type='GradedMesher')), wavelength=None, override_structures=(), type='GridSpec')\n Specifications for the simulation grid along each of the three directions.\nshutoff : NonNegativeFloat = 1e-05\n Ratio of the instantaneous integrated E-field intensity to the maximum value at which the simulation will automatically terminate time stepping. Used to prevent extraneous run time of simulations with fully decayed fields. Set to ``0`` to disable this feature.\nsubpixel : bool = True\n If ``True``, uses subpixel averaging of the permittivity based on structure definition, resulting in much higher accuracy for a given grid size.\nnormalize_index : Optional[NonNegativeInt] = 0\n Index of the source in the tuple of sources whose spectrum will be used to normalize the frequency-dependent data. If ``None``, the raw field data is returned unnormalized.\ncourant : ConstrainedFloatValue = 0.99\n Courant stability factor, controls time step to spatial step ratio. Lower values lead to more stable simulations for dispersive materials, but result in longer simulation times. This factor is normalized to no larger than 1 when CFL stability condition is met in 3D.\nversion : str = 1.8.3\n String specifying the front end version number.\n\nExample\n-------\n>>> from tidy3d import Sphere, Cylinder, PolySlab\n>>> from tidy3d import UniformCurrentSource, GaussianPulse\n>>> from tidy3d import FieldMonitor, FluxMonitor\n>>> from tidy3d import GridSpec, AutoGrid\n>>> from tidy3d import BoundarySpec, Boundary\n>>> sim = Simulation(\n... size=(2.0, 2.0, 2.0),\n... grid_spec=GridSpec(\n... grid_x = AutoGrid(min_steps_per_wvl = 20),\n... grid_y = AutoGrid(min_steps_per_wvl = 20),\n... grid_z = AutoGrid(min_steps_per_wvl = 20)\n... ),\n... run_time=40e-11,\n... structures=[\n... Structure(\n... geometry=Box(size=(1, 1, 1), center=(-1, 0, 0)),\n... medium=Medium(permittivity=2.0),\n... ),\n... ],\n... sources=[\n... UniformCurrentSource(\n... size=(0, 0, 0),\n... center=(0, 0.5, 0),\n... polarization=\"Hx\",\n... source_time=GaussianPulse(\n... freq0=2e14,\n... fwidth=4e13,\n... ),\n... )\n... ],\n... monitors=[\n... FieldMonitor(size=(0, 0, 0), center=(0, 0, 0), freqs=[1.5e14, 2e14], name='point'),\n... FluxMonitor(size=(1, 1, 0), center=(0, 0, 0), freqs=[2e14, 2.5e14], name='flux'),\n... ],\n... symmetry=(0, 0, 0),\n... boundary_spec=BoundarySpec(\n... x = Boundary.pml(num_layers=20),\n... y = Boundary.pml(num_layers=30),\n... z = Boundary.periodic(),\n... ),\n... shutoff=1e-6,\n... courant=0.8,\n... subpixel=False,\n... )", + "description": "Contains all information about Tidy3d simulation.\n\nParameters\n----------\ncenter : Tuple[float, float, float] = (0.0, 0.0, 0.0)\n [units = um]. Center of object in x, y, and z.\nsize : Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]\n [units = um]. Size in x, y, and z directions.\nrun_time : PositiveFloat\n [units = sec]. Total electromagnetic evolution time in seconds. Note: If simulation 'shutoff' is specified, simulation will terminate early when shutoff condition met. \nmedium : Union[Medium, AnisotropicMedium, PECMedium, PoleResidue, Sellmeier, Lorentz, Debye, Drude] = Medium(name=None, frequency_range=None, type='Medium', permittivity=1.0, conductivity=0.0)\n Background medium of simulation, defaults to vacuum if not specified.\nsymmetry : Tuple[Literal[0, -1, 1], Literal[0, -1, 1], Literal[0, -1, 1]] = (0, 0, 0)\n Tuple of integers defining reflection symmetry across a plane bisecting the simulation domain normal to the x-, y-, and z-axis at the simulation center of each axis, respectvely. Each element can be ``0`` (no symmetry), ``1`` (even, i.e. 'PMC' symmetry) or ``-1`` (odd, i.e. 'PEC' symmetry). Note that the vectorial nature of the fields must be taken into account to correctly determine the symmetry value.\nstructures : Tuple[Structure, ...] = ()\n Tuple of structures present in simulation. Note: Structures defined later in this list override the simulation material properties in regions of spatial overlap.\nsources : Tuple[Annotated[Union[tidy3d.components.source.UniformCurrentSource, tidy3d.components.source.PointDipole, tidy3d.components.source.GaussianBeam, tidy3d.components.source.AstigmaticGaussianBeam, tidy3d.components.source.ModeSource, tidy3d.components.source.PlaneWave, tidy3d.components.source.CustomFieldSource], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})], ...] = ()\n Tuple of electric current sources injecting fields into the simulation.\nboundary_spec : Optional[BoundarySpec] = None\n Specification of boundary conditions along each dimension. If ``None``, periodic boundary conditions are applied on all sides. Default will change to PML in 2.0 so explicitly setting the boundaries is recommended.\nmonitors : Tuple[Annotated[Union[tidy3d.components.monitor.FieldMonitor, tidy3d.components.monitor.FieldTimeMonitor, tidy3d.components.monitor.PermittivityMonitor, tidy3d.components.monitor.FluxMonitor, tidy3d.components.monitor.FluxTimeMonitor, tidy3d.components.monitor.ModeMonitor, tidy3d.components.monitor.ModeSolverMonitor, tidy3d.components.monitor.FieldProjectionAngleMonitor, tidy3d.components.monitor.FieldProjectionCartesianMonitor, tidy3d.components.monitor.FieldProjectionKSpaceMonitor, tidy3d.components.monitor.DiffractionMonitor], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})], ...] = ()\n Tuple of monitors in the simulation. Note: monitor names are used to access data after simulation is run.\ngrid_spec : GridSpec = GridSpec(grid_x=AutoGrid(type='AutoGrid',, min_steps_per_wvl=10.0,, max_scale=1.4,, dl_min=0.0,, mesher=GradedMesher(type='GradedMesher')), grid_y=AutoGrid(type='AutoGrid',, min_steps_per_wvl=10.0,, max_scale=1.4,, dl_min=0.0,, mesher=GradedMesher(type='GradedMesher')), grid_z=AutoGrid(type='AutoGrid',, min_steps_per_wvl=10.0,, max_scale=1.4,, dl_min=0.0,, mesher=GradedMesher(type='GradedMesher')), wavelength=None, override_structures=(), type='GridSpec')\n Specifications for the simulation grid along each of the three directions.\nshutoff : NonNegativeFloat = 1e-05\n Ratio of the instantaneous integrated E-field intensity to the maximum value at which the simulation will automatically terminate time stepping. Used to prevent extraneous run time of simulations with fully decayed fields. Set to ``0`` to disable this feature.\nsubpixel : bool = True\n If ``True``, uses subpixel averaging of the permittivity based on structure definition, resulting in much higher accuracy for a given grid size.\nnormalize_index : Optional[NonNegativeInt] = 0\n Index of the source in the tuple of sources whose spectrum will be used to normalize the frequency-dependent data. If ``None``, the raw field data is returned unnormalized.\ncourant : ConstrainedFloatValue = 0.99\n Courant stability factor, controls time step to spatial step ratio. Lower values lead to more stable simulations for dispersive materials, but result in longer simulation times. This factor is normalized to no larger than 1 when CFL stability condition is met in 3D.\nversion : str = 1.8.4\n String specifying the front end version number.\n\nExample\n-------\n>>> from tidy3d import Sphere, Cylinder, PolySlab\n>>> from tidy3d import UniformCurrentSource, GaussianPulse\n>>> from tidy3d import FieldMonitor, FluxMonitor\n>>> from tidy3d import GridSpec, AutoGrid\n>>> from tidy3d import BoundarySpec, Boundary\n>>> sim = Simulation(\n... size=(2.0, 2.0, 2.0),\n... grid_spec=GridSpec(\n... grid_x = AutoGrid(min_steps_per_wvl = 20),\n... grid_y = AutoGrid(min_steps_per_wvl = 20),\n... grid_z = AutoGrid(min_steps_per_wvl = 20)\n... ),\n... run_time=40e-11,\n... structures=[\n... Structure(\n... geometry=Box(size=(1, 1, 1), center=(-1, 0, 0)),\n... medium=Medium(permittivity=2.0),\n... ),\n... ],\n... sources=[\n... UniformCurrentSource(\n... size=(0, 0, 0),\n... center=(0, 0.5, 0),\n... polarization=\"Hx\",\n... source_time=GaussianPulse(\n... freq0=2e14,\n... fwidth=4e13,\n... ),\n... )\n... ],\n... monitors=[\n... FieldMonitor(size=(0, 0, 0), center=(0, 0, 0), freqs=[1.5e14, 2e14], name='point'),\n... FluxMonitor(size=(1, 1, 0), center=(0, 0, 0), freqs=[2e14, 2.5e14], name='flux'),\n... ],\n... symmetry=(0, 0, 0),\n... boundary_spec=BoundarySpec(\n... x = Boundary.pml(num_layers=20),\n... y = Boundary.pml(num_layers=30),\n... z = Boundary.periodic(),\n... ),\n... shutoff=1e-6,\n... courant=0.8,\n... subpixel=False,\n... )", "type": "object", "properties": { "type": { @@ -331,7 +331,7 @@ "version": { "title": "Version", "description": "String specifying the front end version number.", - "default": "1.8.3", + "default": "1.8.4", "type": "string" } }, diff --git a/tidy3d/version.py b/tidy3d/version.py index b3b4e2127..de67aa5f6 100644 --- a/tidy3d/version.py +++ b/tidy3d/version.py @@ -1,5 +1,5 @@ """Defines the front end version of tidy3d""" -__version__ = "1.8.3" +__version__ = "1.8.4" PIP_NAME = "tidy3d-beta"