-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add ape_e spectral factor model #2126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job with this implementation!
I miss a test of numpy input/output datatypes. Also, sphinx warns something near line 64 of the documentation, but I can't grasp what it could be.
The default is None. | ||
|
||
coefficients : array-like, optional | ||
User-defined coefficients, if not using one of the default coefficient | ||
sets via the ``module_type`` parameter. The default is None. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Average photon energy (APE, :math:`\varphi`) [eV] | ||
|
||
band_depth : numeric | ||
Depth of a spectral band, :math:`\varepsilon` [Wm:math:`^{-2}`] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depth of a spectral band, :math:`\varepsilon` [Wm:math:`^{-2}`] | |
Depth of a spectral band, :math:`\varepsilon` [W/m²] |
out = spectrum.spectral_factor_daxini(apes, bands, | ||
module_type=module_type) | ||
assert isinstance(out, pd.Series) | ||
assert np.allclose(expected, out, atol=1e-5) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
assert np.allclose(expected, out, atol=1e-5) | |
assert_allclose(out, expected, atol=1e-5) |
@echedey-ls Thanks for the review. |
Closed for now, see discussion in #2065 regarding availability of coefficients for more details. |
docs/sphinx/source/reference
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.This function calculates the spectral mismatch factor using the average photon energy and the depth of a water absorption band as inputs. Context: #2065