Skip to content

Commit 86b0a8b

Browse files
committed
Minor documentation fixes
1 parent a644aa5 commit 86b0a8b

2 files changed

Lines changed: 77 additions & 6 deletions

File tree

CHANGELOG.md

Lines changed: 75 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,79 @@
11
# Changelog
22

3+
## Version 0.20.0
4+
5+
### New
6+
7+
- Vectorized KKR
8+
- NumPy 2.0.0 support
9+
10+
### Bug fixes
11+
12+
- Fix root selection mistakes for Bruggeman EMA
13+
14+
### Known issues
15+
16+
- Performance regression for newer SciPy versions of expm solver (#178)
17+
18+
19+
## Version 0.19.0
20+
21+
### New
22+
23+
- Python 3.12 Support
24+
- Averaging of ResultLists
25+
- Breaking change: Renamed RII.load_dispersion to RII.get_dispersion to be more consistent.
26+
27+
28+
## Version 0.18.1
29+
30+
### Bug fixes
31+
32+
- Bump pygments from 2.13.0 to 2.15.0
33+
- Bump tornado from 6.3.2 to 6.3.3
34+
- Fixes wvase importer
35+
36+
37+
## Version 0.18.0
38+
39+
### What's Changed
40+
41+
- Update spectraray importer
42+
- Update RII database and use new file structure
43+
- Bump scipy from 1.9.1 to 1.10.0
44+
- Adds woollam importer
45+
46+
47+
## Version 0.17.0
48+
49+
### New
50+
51+
- Support for NXopt based nexus definitions
52+
- Interpolation order for refractiveindex.info database
53+
- Speed up for formula dispersions
54+
55+
### Bug fixes
56+
57+
- Better error messages
58+
- Raise error when solver2x2 gets a negative k
59+
60+
361
## Version 0.16.0
462

5-
# New
63+
### New
664

765
- Support for nexus dispersion files
866
- Formula based dispersions
967
- Cauchy Urbach dispersion
1068
- Filtering by range for the refractive index database
1169

12-
# Bugfixes
70+
### Bug fixes
1371

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

76+
1877
## Version 0.15.1
1978

2079
### New
@@ -28,6 +87,7 @@
2887
- Don't allow adding of refractive index based dispersions
2988
- Don't allow adding of tabular dispersions
3089

90+
3191
## Version 0.15.0
3292

3393
### New
@@ -36,12 +96,14 @@
3696
- Kramers-Kronig-Relationship conversions for dielectric functions
3797
- Add Cody-Lorentz dispersion model
3898

99+
39100
## Version 0.14.1
40101

41102
### Bug fixes:
42103

43104
- Installs the correct extra requirements in the docker container
44105

106+
45107
## Version 0.14.0
46108

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

119+
57120
## Version 0.13.0
58121

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

131+
68132
## Version 0.12.0
69133

70134
### Breaking Changes:
@@ -84,20 +148,24 @@
84148

85149
- Fix nan values in MaxwellGarnettEMA
86150

151+
87152
## Version 0.11.0
88153

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

156+
91157
## Version 0.10.1
92158

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

161+
95162
## Version 0.10.0
96163

97164
- Dispersions are now addressed by their name only (instead of Dispersion...)
98165
- 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.
99166
- There is a new factory class `DispersionFactory` to get a dispersion from it's string name, i.e. `DispersionFactory.get_dispersion(...)`
100167

168+
101169
## Version 0.9.2
102170

103171
- Fitting decorator buttons (fit, undo, redo)
@@ -106,13 +174,15 @@
106174
- Fixed Jones vector default
107175
- Included more documentation
108176

177+
109178
## Version 0.9.1
110179

111180
- Automated build of Docker images
112181
- Benchmarking setup
113182
- Added more documentation
114183
- Renamed a lot of functions for PEP8 compliance
115-
- More bugfixes
184+
- More Bug fixes
185+
116186

117187
## Version 0.9.0
118188

@@ -123,7 +193,8 @@
123193
- Improve fitting decorators
124194
- Added plotting and fitting for Mueller matrices
125195
- Added type hints
126-
- Various calculation bugfixes
196+
- Various calculation Bug fixes
197+
127198

128199
## Version 0.1.0
129200

src/elli/dispersions/cody_lorentz.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313

1414
class CodyLorentz(Dispersion):
15-
"""Tauc-Lorentz dispersion law. Model by Ferlauto et al.
15+
"""Cody-Lorentz dispersion law. Model by Ferlauto et al.
1616
1717
Single parameters:
1818
:Eg: Bandgap energy (eV). Defaults to 1.6.
@@ -29,7 +29,7 @@ class CodyLorentz(Dispersion):
2929
--
3030
3131
Output:
32-
The Cody lorentz dispersion. Please refer to the references for a full formula.
32+
The Cody-Lorentz dispersion. Please refer to the references for a full formula.
3333
3434
References:
3535
* Ferlauto et al., J. Appl. Phys. 92, 2424 (2002)

0 commit comments

Comments
 (0)