Skip to content

Commit

Permalink
Minor documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
MarJMue committed Jul 3, 2024
1 parent a644aa5 commit 86b0a8b
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 6 deletions.
79 changes: 75 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,79 @@
# Changelog

## Version 0.20.0

### New

- Vectorized KKR
- NumPy 2.0.0 support

### Bug fixes

- Fix root selection mistakes for Bruggeman EMA

### Known issues

- Performance regression for newer SciPy versions of expm solver (#178)


## Version 0.19.0

### New

- Python 3.12 Support
- Averaging of ResultLists
- Breaking change: Renamed RII.load_dispersion to RII.get_dispersion to be more consistent.


## Version 0.18.1

### Bug fixes

- Bump pygments from 2.13.0 to 2.15.0
- Bump tornado from 6.3.2 to 6.3.3
- Fixes wvase importer


## Version 0.18.0

### What's Changed

- Update spectraray importer
- Update RII database and use new file structure
- Bump scipy from 1.9.1 to 1.10.0
- Adds woollam importer


## Version 0.17.0

### New

- Support for NXopt based nexus definitions
- Interpolation order for refractiveindex.info database
- Speed up for formula dispersions

### Bug fixes

- Better error messages
- Raise error when solver2x2 gets a negative k


## Version 0.16.0

# New
### New

- Support for nexus dispersion files
- Formula based dispersions
- Cauchy Urbach dispersion
- Filtering by range for the refractive index database

# Bugfixes
### Bug fixes

- Fixed a bug where incompatible dispersions were created in refractive index database
- Created separated index and dielectric dispersions
- Fixed checks for DispersionSums when dispersions are entered via \*args


## Version 0.15.1

### New
Expand All @@ -28,6 +87,7 @@
- Don't allow adding of refractive index based dispersions
- Don't allow adding of tabular dispersions


## Version 0.15.0

### New
Expand All @@ -36,12 +96,14 @@
- Kramers-Kronig-Relationship conversions for dielectric functions
- Add Cody-Lorentz dispersion model


## Version 0.14.1

### Bug fixes:

- Installs the correct extra requirements in the docker container


## Version 0.14.0

### Breaking changes:
Expand All @@ -54,6 +116,7 @@
- Introduced proper dependency management
- Changed the dependency of extra install requirements for fitting and testing


## Version 0.13.0

### Breaking Changes:
Expand All @@ -65,6 +128,7 @@
- Fix error in eigenvalue sorting (PropergatorEig and non-isotropic backmaterials)
- Pin version of ipywidgets to keep plotly working


## Version 0.12.0

### Breaking Changes:
Expand All @@ -84,20 +148,24 @@

- Fix nan values in MaxwellGarnettEMA


## Version 0.11.0

- Adds reading functionality for [NeXus files](https://fairmat-experimental.github.io/nexus-fairmat-proposal/50433d9039b3f33299bab338998acb5335cd8951/classes/contributed_definitions/NXellipsometry.html#nxellipsometry).


## Version 0.10.1

- The fitting module is not imported at top-level anymore. It has now to be imported by `elli.fitting`.


## Version 0.10.0

- Dispersions are now addressed by their name only (instead of Dispersion...)
- Dispersions are initialized with two distinguished set of parameters for parameters which are set once and parameters which may be set multiple times (for oscillators etc). They can be added by invoking the `add` command on the respective class.
- There is a new factory class `DispersionFactory` to get a dispersion from it's string name, i.e. `DispersionFactory.get_dispersion(...)`


## Version 0.9.2

- Fitting decorator buttons (fit, undo, redo)
Expand All @@ -106,13 +174,15 @@
- Fixed Jones vector default
- Included more documentation


## Version 0.9.1

- Automated build of Docker images
- Benchmarking setup
- Added more documentation
- Renamed a lot of functions for PEP8 compliance
- More bugfixes
- More Bug fixes


## Version 0.9.0

Expand All @@ -123,7 +193,8 @@
- Improve fitting decorators
- Added plotting and fitting for Mueller matrices
- Added type hints
- Various calculation bugfixes
- Various calculation Bug fixes


## Version 0.1.0

Expand Down
4 changes: 2 additions & 2 deletions src/elli/dispersions/cody_lorentz.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@


class CodyLorentz(Dispersion):
"""Tauc-Lorentz dispersion law. Model by Ferlauto et al.
"""Cody-Lorentz dispersion law. Model by Ferlauto et al.
Single parameters:
:Eg: Bandgap energy (eV). Defaults to 1.6.
Expand All @@ -29,7 +29,7 @@ class CodyLorentz(Dispersion):
--
Output:
The Cody lorentz dispersion. Please refer to the references for a full formula.
The Cody-Lorentz dispersion. Please refer to the references for a full formula.
References:
* Ferlauto et al., J. Appl. Phys. 92, 2424 (2002)
Expand Down

0 comments on commit 86b0a8b

Please sign in to comment.