Skip to content

Commit

Permalink
Changelog and pre release script run
Browse files Browse the repository at this point in the history
  • Loading branch information
momchil-flex committed Feb 21, 2024
1 parent 8a77486 commit e89d74a
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 49 deletions.
38 changes: 15 additions & 23 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [2.6.0] - 2024-01-21

### Added
- Automatic subdivision of 2D materials with inhomogeneous substrate/superstrate.
Expand All @@ -12,33 +12,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Free-carrier absorption (FCA) and free-carrier plasma dispersion (FCPD) nonlinearities inside `TwoPhotonAbsorption` class.
- `log_path` argument in `set_logging_file`, set to `False` by default.
- `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.

### Changed
- `DataArray.to_hdf5()` accepts both file handles and file paths.
- `ModeSolverMonitor` is deprecated. Mode field profiles can be retrieved directly from `ModeMonitor` with `store_fields_direction` set.
- The log file for a simulation run has been modified to include more information including warnings collected during execution.

### Fixed
- Add dispersion information to dataframe output when available from mode solver under the column "dispersion (ps/(nm km))".
- Skip adjoint source for diffraction amplitudes of NaN.
- Helpful error message if `val` supplied to `SimulationData.plot_field` not supported.
- Fixed validator that warns if angled plane wave does not match simulation boundaries, which was not warning for periodic boundaries.
- Validates that no nans are present in `DataArray` values in custom components.
- Removed nans from Cartesian temperature monitors in thermal simulations by using nearest neighbor interpolation for values outside of heat simulation domain.

## [2.6.0rc1] - 2024-01-11

### Added
- `tidy3d.plugins.design` tool to explore user-defined design spaces.
- `ModeData.dispersion` and `ModeSolverData.dispersion` are calculated together with the group index.
- 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.
- Integration of the `documentation` alongside the main codebase repository.
- Integration of the `tidy3d-notebooks` repository.
- `tidy3d develop` CLI and development guide on the main documentation.
- Added a convenience method `Simulation.subsection()` to a create a new simulation based on a subregion of another one.
- Users can toggle task caching through `from tidy3d.web.core.environment import Env` and `Env.enable_caching(enableCaching: bool = True)`
- 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.

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

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

## [2.5.2] - 2024-01-11

### Fixed
Expand Down Expand Up @@ -1104,9 +1097,8 @@ 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/v2.6.0rc1...pre/2.6
[2.6.0rc1]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...v2.6.0rc1
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...develop
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.6.0...develop
[2.6.0]: https://github.com/flexcompute/tidy3d/compare/v2.5.2...v2.6.0
[2.5.2]: https://github.com/flexcompute/tidy3d/compare/v2.5.1...v2.5.2
[2.5.1]: https://github.com/flexcompute/tidy3d/compare/v2.5.0...v2.5.1
[2.5.0]: https://github.com/flexcompute/tidy3d/compare/v2.4.3...v2.5.0
Expand Down
Binary file modified tests/sims/simulation_sample.h5
Binary file not shown.
6 changes: 3 additions & 3 deletions tests/sims/simulation_sample.json
Original file line number Diff line number Diff line change
Expand Up @@ -2223,9 +2223,9 @@
"type": "GridSpec"
},
"version": "2.6.0",
"run_time": 1e-12,
"courant": 0.8,
"normalize_index": 0,
"shutoff": 0.0001,
"subpixel": false,
"normalize_index": 0,
"courant": 0.8
"run_time": 1e-12
}
Loading

0 comments on commit e89d74a

Please sign in to comment.