[REVIEW]: CompactObject: An open-source Python package for full-scope neutron star equation of state inference

[editorialbot]

Submitting author: @ChunHuangPhy (Chun Huang)
Repository: https://github.com/ChunHuangPhy/CompactObject
Branch with paper.md (empty if default branch):
Version: v1.9.9
Editor: @warrickball
Reviewers: @kelslund, @rhaas80
Archive: Pending

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/767dfa84e527ba5fca907401e51cd371"><img src="https://joss.theoj.org/papers/767dfa84e527ba5fca907401e51cd371/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/767dfa84e527ba5fca907401e51cd371/status.svg)](https://joss.theoj.org/papers/767dfa84e527ba5fca907401e51cd371)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@kelslund & @rhaas80, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @warrickball know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

@kelslund, please create your checklist typing: @editorialbot generate my checklist

@rhaas80, please create your checklist typing: @editorialbot generate my checklist

[editorialbot]

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1109/MCSE.2007.55 is OK
- 10.1201/9781003306580-5 is OK
- 10.1088/0004-637X/773/1/11 is OK
- 10.1038/s41586-022-04750-w is OK
- 10.3847/1538-4357/acce3a is OK
- 10.3847/1538-4357/ac5d3c is OK
- 10.1103/PhysRevD.9.3471 is OK
- 10.1086/379209 is OK
- 10.1103/physrevc.90.015801 is OK
- 10.1016/j.nuclphysa.2010.02.010 is OK
- 10.1017/pasa.2017.60 is OK
- 10.3847/1538-4357/834/1/3 is OK
- 10.3233/978-1-61499-649-1-87 is OK
- 10.1109/mcse.2011.37 is OK
- 10.1145/2833157.2833162 is OK
- 10.5281/zenodo.10927600 is OK
- 10.1109/MCSE.2007.58 is OK
- 10.1093/mnras/stae844 is OK
- 10.21105/joss.00024 is OK
- 10.21105/joss.03021 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1086/670067 is OK
- 10.21105/joss.03001 is OK
- 10.1109/MCSE.2007.53 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: NumbaMinpack
- No DOI given, and none found for title: CompactObject: An open-source package for neutron ...
- No DOI given, and none found for title: Constraining twin star in speed of sound equation ...
- No DOI given, and none found for title: Constraining first-order phase transition inside n...
- No DOI given, and none found for title: Bayesian inference of strangeon matter equation of...

❌ MISSING DOIs

- 10.21105/joss.06003 may be a valid DOI for title: NEoST: A Python Package for Nested Sampling of the...
- 10.1093/mnras/stae2792 may be a valid DOI for title: Constraining a relativistic mean field model using...

❌ INVALID DOIs

- https://doi.org/10.1016/j.jpdc.2007.09.005 is INVALID because of 'https://doi.org/' prefix

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.16 s (955.1 files/s, 307028.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JavaScript                      16           2435           2505           9216
Python                          43           1694           2157           4005
Jupyter Notebook                29              0          10235           3567
CSV                              3              0              0           3451
SVG                              1              0              0           2671
HTML                            12            272             36           2334
CSS                              4            187             35            756
Text                             3            121              0            610
reStructuredText                30            370            254            452
TeX                              1             22              0            347
Markdown                         2             75              1            220
YAML                             2              4              6             67
TOML                             1              2              0             35
DOS Batch                        1              8              1             26
make                             2              8             14             18
-------------------------------------------------------------------------------
SUM:                           150           5198          15244          27775
-------------------------------------------------------------------------------

Commit count by author:

   366	ChunHuangPhy
   105	9
    30	osborn62
    29	João Cartaxo
    16	Nicole Osborn
     9	zhoutz
     8	nwhitsett
     7	Shashwat Sourav
     6	Xuezhi Liu
     5	Tuhin Malik
     5	obs-oertel
     4	crystalywl
     3	ZhihengWA
     3	fizban007
     2	DELL
     2	dxy21
     1	John John Groger
     1	Warrick Ball
     1	jgroger

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1341

✅ The paper includes a Statement of need section

[editorialbot]

License info:

🟡 License found: Other (Check here for OSI approval)

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[warrickball]

Hi @kelslund & @rhaas80, and thanks again for agreeing to review. This is the review thread for the paper. All of our correspondence will now happen here.

Please read the "Reviewer instructions & questions" in the first comment above, and generate your checklists by commenting @editorialbot generate my checklist on this issue. As you go over the submission, please check off any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. We aim to work with the authors to help them meet our criteria instead of merely passing judgement on the submission. We also encourage reviewers to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#7759 so that the issue/PR is linked to this thread. Please also feel free to comment and ask questions on this thread. JOSS editors have found it better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for the review process to be completed within about 4-6 weeks but start whenever you can. JOSS reviews are iterative and the authors can start responding while you continue to review other parts of the submission.

If it suits your workflow, you're welcome to assign yourself to this issue in the GitHub UI.

Finally, don't hesitate to ask any questions you might have about the process.