Responses to pyOpenSci review #842
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #842 +/- ##
==========================================
- Coverage 96.53% 96.39% -0.14%
==========================================
Files 48 48
Lines 9257 9292 +35
==========================================
+ Hits 8936 8957 +21
- Misses 321 335 +14
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
…to retrieve the notebooks
| @@ -271,6 +272,9 @@ the stingray source directory. | |||
| Using Stingray | |||
| =============== | |||
|
|
|||
| The documentation below is built on top of Jupyter notebooks that can be run locally. | |||
| The easiest way to retrieve the notebooks is by `cloning the notebooks repository <https://github.com/StingraySoftware/notebooks>`_ and browsing the directories, which are conveniently divided by topic. | |||
|
|
|||
There was a problem hiding this comment.
@taldcroft Is this addition in the right direction for what you were asking?
| { name = "Stingray Developers", email = "[email protected]" } | ||
| ] | ||
| license = { text = "MIT" } | ||
| requires-python = ">=3.8" |
There was a problem hiding this comment.
@masonng-astro @taldcroft I added all these metadata to the pyproject.toml file, including the supported Python versions and a contact (a Google Group which is admittedly underused but an easy way to contact us).
The python version encoded here is picked up by the badge in the README
| |Docs|, |joss|, |Repo status|, " " | ||
| |License|, |doi|, |Coverage Status Master|, " " | ||
|
|
||
|
|
There was a problem hiding this comment.
@masonng-astro @taldcroft Here are the new badges, including the repo status from repostatus.org and the supported Python versions, as requested
| @@ -125,6 +124,8 @@ For the Gaussian Process modeling in `stingray.modeling.gpmodeling`, you'll need | |||
| + etils | |||
| + typing_extensions | |||
|
|
|||
| For the Bexvar calculations in `stingray.bexvar` and `stingray.lightcurve`, you'll need `UltraNest <https://johannesbuchner.github.io/UltraNest/index.html>`_. | |||
|
|
|||
There was a problem hiding this comment.
@masonng-astro here is the Ultranest line
This is to address the comments at
pyOpenSci/software-submission#201
The big change here is that we fully move the configuration to
pyproject.toml. This removes some of the inconsistencies coming from having half of the configuration insetup.cfg.In turn, this allows some goodies like having an automatic badge for the compatible Python version, which was one of the requests from the pyOpenSci review.
The rest of changes are rather minor and mostly involve clarifications in the docs.
One bugfix in crosscorrelation.py to solve #845 (note that I reproduced the failing line, now working, in test_crosscorrelation.py).
Resolve #846
Resolve #841
Resolve #839
Resolve #845