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

[editorialbot]

Submitting author: !--author-handle-->@ChunHuangPhy<!--end-author-handle-- (Chun Huang) Repository: https://github.com/ChunHuangPhy/CompactObject Branch with paper.md (empty if default branch): Version: v1.9.9 Editor: Pending Reviewers: Pending Managing EiC: Warrick Ball

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)

Author instructions

Thanks for submitting your paper to JOSS @ChunHuangPhy. Currently, there isn't a JOSS editor assigned to your paper.

@ChunHuangPhy if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, 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]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.15 s (978.7 files/s, 316789.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JavaScript                      16           2435           2505           9216
Python                          42           1673           2064           3957
Jupyter Notebook                29              0          10196           3564
CSV                              3              0              0           3451
SVG                              1              0              0           2671
HTML                            12            272             36           2334
CSS                              4            187             35            756
reStructuredText                30            363            250            447
TeX                              1             22              0            347
Markdown                         2             71              0            218
YAML                             2              4              6             67
TOML                             1              2              0             35
DOS Batch                        1              8              1             26
make                             2              8             14             18
-------------------------------------------------------------------------------
SUM:                           146           5045          15107          27107
-------------------------------------------------------------------------------

Commit count by author:

   341  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  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]

:warning: An error happened when generating the pdf.

[warrickball]

@ChunHuangPhy — Thanks for your submission! All the suitable JOSS editors are currently working at capacity so I'm going to "waitlist" this review until an editor with the relevant expertise is available to take it on.

I also noticed that our system hasn't automatically recognised your MIT License. I'm not quite sure why not but it might be because your specific text differs from the standard version. Specifically, I think these lines

Copyright (c)[2024 Chun Huang, João Cartaxo, Tuhin Malik, Wenli Yuan,
Shashwat Sourav, Xuezhi Liu, Tianzhe Zhou, John Groger, Zhiheng Wang, Nicole Osborn, Nathan Whitsett]

might need to be

Copyright (c) 2024 Chun Huang, João Cartaxo, Tuhin Malik, Wenli Yuan,
Shashwat Sourav, Xuezhi Liu, Tianzhe Zhou, John Groger, Zhiheng Wang, Nicole Osborn, Nathan Whitsett

and you might even need to put all the authors back on one line. Have a look at other MIT Licensed code you might know of or browse past JOSS articles to see what might be the issue here, then run @editorialbot check repository to rerun our checks.

Also, the paper is failing to build at least because of a YAML error in the metadata, which is also flagged by the GitHub UI if you view the file there. Specifically, I think the tags should be indented by two spaces, not four.

If you think you've fixed this, you can try rebuilding the paper with @editorialbot generate pdf.

[ChunHuangPhy]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.15 s (966.3 files/s, 312850.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JavaScript                      16           2435           2505           9216
Python                          42           1673           2064           3957
Jupyter Notebook                29              0          10196           3564
CSV                              3              0              0           3451
SVG                              1              0              0           2671
HTML                            12            272             36           2334
CSS                              4            187             35            756
reStructuredText                30            367            250            451
TeX                              1             22              0            347
Markdown                         2             71              0            218
YAML                             2              4              6             67
TOML                             1              2              0             35
DOS Batch                        1              8              1             26
make                             2              8             14             18
-------------------------------------------------------------------------------
SUM:                           146           5049          15107          27111
-------------------------------------------------------------------------------

Commit count by author:

   343  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  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)

[ChunHuangPhy]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf.

[ChunHuangPhy]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf.