Implement two-ion model for >= v9 compatibility#254
Merged
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #254 +/- ##
==========================================
- Coverage 90.71% 90.50% -0.21%
==========================================
Files 41 42 +1
Lines 3456 3667 +211
==========================================
+ Hits 3135 3319 +184
- Misses 321 348 +27 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
864203c to
0f80c04
Compare
0f80c04 to
b81199d
Compare
This was referenced Mar 25, 2025
Owner
Author
|
The v8 test failures are just due to a naming change in the variables used in the test data. This is already tracked by #347. |
Collaborator
|
Hooray! Thanks for your efforts, Will! That's a major milestone for the package. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #234
Fixes #224
Fixes #344
This PR represents the major changes needed for compatibility with versions 9 and later of the CHIANTI database. Most notably, it modifies
Ion.level_populationsmethod to include processes that couple a given ion and the next highest ionization state through ionization and recombination processes. In addition, this PR also includes the following changes:High-level Summary
Ion.level_populationsn_levelsandn_transitionsproperty toIonis_autoionizationandis_bound_boundtoTransitionsfor more easily differentiating between different kinds of transitions.LeveltoLevelsand add ability to hold information about multiple energy levels at once.Transitionsto be more efficient and useful as a high-level objectburgess_tully_descaleto never return object-type arraysChecklist
n_levelspropertyn_transitionspropertyburgess_tully_descaleto never return object-type arraysLogic for excluding ionization/recombination correction factor when two-ion model is usedfiascowe treat these as terms in the coefficient matrix)Docs(see Add topic guide on level populations calculation #349)Review whereCreate an issue to replace all usage of_elvlcis used explicitly (favorlevels)_elvlcwithself.levels(or indexing)_wgfawithself.transitions