-
Notifications
You must be signed in to change notification settings - Fork 34
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
Vectorial model rewrite and update associated tests and documentation #336
Vectorial model rewrite and update associated tests and documentation #336
Conversation
06061f7
to
cbd7eb0
Compare
Codecov Report
@@ Coverage Diff @@
## main #336 +/- ##
==========================================
+ Coverage 75.65% 76.84% +1.18%
==========================================
Files 78 78
Lines 6795 6978 +183
==========================================
+ Hits 5141 5362 +221
+ Misses 1654 1616 -38
|
@sjoset There are some lines of code not being covered by the tests. See the coverage report for details: https://app.codecov.io/gh/NASA-Planetary-Science/sbpy/pull/336/blob/sbpy/activity/gas/core.py Most of them are trivial branches, but the |
That failing test will be addressed with #374 |
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.
Could you make an entry for this update in CHANGES.rst under New Features, including the improvements and the new binned_production
constructor? Also, add any API changes to the relevant section (e.g., angular_substeps
was removed from VectorialModel
).
Finally, remove the warning in the documentation (gas.rst).
Do you have or do you plan to have a citeable reference for the comparison to the FORTRAN version?
|
||
return N | ||
|
||
|
||
@dataclass | ||
class VMParent: |
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.
Please provide a docstring for this and the other VM* data classes.
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.
Are they meant to be used by users? If not, could you prefix them with "_" to indicate they are private to the submodule? Then the docstrings can just be one-line descriptions.
…rial model example, and document changes
Thanks for the fixes and updates! |
This is a rewrite of the vectorial model to utilize numpy where possible, assemble results neatly, and bring the results better in line with the fortran version.
All tests in sbpy/activity/gas/tests/test_core.py passed and flake8 was clear.