Skip to content

Commit e89d74a

Browse files
committed
Changelog and pre release script run
1 parent 8a77486 commit e89d74a

File tree

4 files changed

+41
-49
lines changed

4 files changed

+41
-49
lines changed

CHANGELOG.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ All notable changes to this project will be documented in this file.
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
44
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
55

6-
## [Unreleased]
6+
## [2.6.0] - 2024-01-21
77

88
### Added
99
- Automatic subdivision of 2D materials with inhomogeneous substrate/superstrate.
@@ -12,33 +12,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- Free-carrier absorption (FCA) and free-carrier plasma dispersion (FCPD) nonlinearities inside `TwoPhotonAbsorption` class.
1313
- `log_path` argument in `set_logging_file`, set to `False` by default.
1414
- `ErosionDilationPenalty` to `tidy3d.plugins.adjoint.utils.penalty` to penalize parameter arrays that change under erosion and dilation. This is a simple and effective way to penalize features that violate minimum feature size or radius of curvature fabrication constraints in topology optimization.
15-
16-
### Changed
17-
- `DataArray.to_hdf5()` accepts both file handles and file paths.
18-
- `ModeSolverMonitor` is deprecated. Mode field profiles can be retrieved directly from `ModeMonitor` with `store_fields_direction` set.
19-
- The log file for a simulation run has been modified to include more information including warnings collected during execution.
20-
21-
### Fixed
22-
- Add dispersion information to dataframe output when available from mode solver under the column "dispersion (ps/(nm km))".
23-
- Skip adjoint source for diffraction amplitudes of NaN.
24-
- Helpful error message if `val` supplied to `SimulationData.plot_field` not supported.
25-
- Fixed validator that warns if angled plane wave does not match simulation boundaries, which was not warning for periodic boundaries.
26-
- Validates that no nans are present in `DataArray` values in custom components.
27-
- Removed nans from Cartesian temperature monitors in thermal simulations by using nearest neighbor interpolation for values outside of heat simulation domain.
28-
29-
## [2.6.0rc1] - 2024-01-11
30-
31-
### Added
3215
- `tidy3d.plugins.design` tool to explore user-defined design spaces.
3316
- `ModeData.dispersion` and `ModeSolverData.dispersion` are calculated together with the group index.
3417
- A utility function `td.medium_from_nk()` that automatically constructs a non-dispersive medium when permittivity>=1, and a single-pole Lorentz medium when permittivity<1.
3518
- Integration of the `documentation` alongside the main codebase repository.
3619
- Integration of the `tidy3d-notebooks` repository.
3720
- `tidy3d develop` CLI and development guide on the main documentation.
3821
- Added a convenience method `Simulation.subsection()` to a create a new simulation based on a subregion of another one.
39-
- Users can toggle task caching through `from tidy3d.web.core.environment import Env` and `Env.enable_caching(enableCaching: bool = True)`
22+
- Users can toggle task caching through `from tidy3d.web.core.environment import Env` and `Env.enable_caching(True)` to enable, `Env.enable_caching(False)` to disable, or `Env.enable_caching(None)` to use global setting from web client account page.
4023

4124
### Changed
25+
- `DataArray.to_hdf5()` accepts both file handles and file paths.
26+
- `ModeSolverMonitor` is deprecated. Mode field profiles can be retrieved directly from `ModeMonitor` with `store_fields_direction` set.
27+
- The log file for a simulation run has been modified to include more information including warnings collected during execution.
4228
- `poetry` based installation. Removal of `setup.py` and `requirements.txt`.
4329
- Upgrade to sphinx 6 for the documentation build, and change of theme.
4430
- Remote mode solver web api automatically reduces the associated `Simulation` object to the mode solver plane before uploading it to server.
@@ -47,7 +33,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4733
- Added an optional argument `field` in class method `.from_vtu()` of `TriangularGridDataset` and `TetrahedralGridDataset` for specifying the name of data field to load.
4834

4935
### Fixed
50-
- Removed spurious warnings realted to reloading simulation containing `PerturbationMedium` with `CustomChargePerturbation`/`CustomHeatPerturbation`
36+
- Add dispersion information to dataframe output when available from mode solver under the column "dispersion (ps/(nm km))".
37+
- Skip adjoint source for diffraction amplitudes of NaN.
38+
- Helpful error message if `val` supplied to `SimulationData.plot_field` not supported.
39+
- Fixed validator that warns if angled plane wave does not match simulation boundaries, which was not warning for periodic boundaries.
40+
- Validates that no nans are present in `DataArray` values in custom components.
41+
- Removed nans from Cartesian temperature monitors in thermal simulations by using nearest neighbor interpolation for values outside of heat simulation domain.
42+
- Removed spurious warnings realted to reloading simulation containing `PerturbationMedium` with `CustomChargePerturbation`/`CustomHeatPerturbation`.
43+
5144
## [2.5.2] - 2024-01-11
5245

5346
### Fixed
@@ -1104,9 +1097,8 @@ which fields are to be projected is now determined automatically based on the me
11041097
- Job and Batch classes for better simulation handling (eventually to fully replace webapi functions).
11051098
- A large number of small improvements and bug fixes.
11061099

1107-
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.6.0rc1...pre/2.6
1108-
[2.6.0rc1]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...v2.6.0rc1
1109-
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...develop
1100+
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.6.0...develop
1101+
[2.6.0]: https://github.com/flexcompute/tidy3d/compare/v2.5.2...v2.6.0
11101102
[2.5.2]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...v2.5.2
11111103
[2.5.1]: https://github.com/flexcompute/tidy3d/compare/v2.5.0...v2.5.1
11121104
[2.5.0]: https://github.com/flexcompute/tidy3d/compare/v2.4.3...v2.5.0

tests/sims/simulation_sample.h5

0 Bytes
Binary file not shown.

tests/sims/simulation_sample.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2223,9 +2223,9 @@
22232223
"type": "GridSpec"
22242224
},
22252225
"version": "2.6.0",
2226-
"run_time": 1e-12,
2226+
"courant": 0.8,
2227+
"normalize_index": 0,
22272228
"shutoff": 0.0001,
22282229
"subpixel": false,
2229-
"normalize_index": 0,
2230-
"courant": 0.8
2230+
"run_time": 1e-12
22312231
}

0 commit comments

Comments
 (0)