[PRE REVIEW]: PyStarshade: simulating high-contrast imaging of exoplanets with starshades

[editorialbot]

Submitting author: @xiaziyna (Jamila Taaki)
Repository: https://github.com/xiaziyna/PyStarshade
Branch with paper.md (empty if default branch):
Version: 0.1.8
Editor: @ivastar
Reviewers: @Jashcraf, @ivalaginja
Managing EiC: Warrick Ball

Status

Status badge code:

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

Author instructions

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

@xiaziyna 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.05 s (717.1 files/s, 80719.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          23            470           1268           1553
TeX                              1             11              0            105
Markdown                         2             42              0             91
reStructuredText                 4             60             67             46
YAML                             2              6             24             29
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            34            601           1367           1859
-------------------------------------------------------------------------------

Commit count by author:

   169	Jamila Taaki
    66	xiaziyna
    13	ielo

[editorialbot]

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

✅ OK DOIs

- 10.1117/12.2314407 is OK
- 10.3847/1538-3881/ac45f5 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: SISTER: Starshade Imaging Simulation Toolkit for E...
- No DOI given, and none found for title: Efficient high-order accurate Fresnel diffraction ...
- No DOI given, and none found for title: fresnaq: FRESNel Areal Quadrature
- No DOI given, and none found for title: Introduction to Fourier optics
- No DOI given, and none found for title: Advances in edge diffraction algorithms
- No DOI given, and none found for title: Diffraq: Diffraction with Areal Quadrature
- No DOI given, and none found for title: ExoVista
- No DOI given, and none found for title: EXOSIMS: Exoplanet Open-Source Imaging Mission Sim...

❌ MISSING DOIs

- 10.1364/oe.20.015196 may be a valid DOI for title: Boundary diffraction wave integrals for diffractio...

❌ INVALID DOIs

- None

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 598

✅ 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 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

PyPO: a Python package for Physical Optics
Submitting author: @arendMoerman
Handling editor: @danielskatz (Active)
Reviewers: @MikeHughesKent, @brandondube
Similarity score: 0.7630

ExoTETHyS: Tools for Exoplanetary Transits around host stars
Submitting author: @gmorello
Handling editor: @arfon (Active)
Reviewers: @steven-murray, @williamjameshandley
Similarity score: 0.7611

ZodiPy: A Python package for zodiacal light simulations
Submitting author: @MetinSa
Handling editor: @dfm (Active)
Reviewers: @dfm
Similarity score: 0.7462

ExoRad 2.0: The generic point source radiometric model
Submitting author: @LorenzoMugnai
Handling editor: @dfm (Active)
Reviewers: @skendrew, @eas342
Similarity score: 0.7451

DBSP_DRP: A Python package for automated spectroscopic data reduction of DBSP data
Submitting author: @finagle29
Handling editor: @arfon (Active)
Reviewers: @crhea93, @arjunsavel
Similarity score: 0.7409

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[warrickball]

Hi @xiaziyna — 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. Thanks for your patience!

In the meantime, I notice that your co-authors aren't listed as having contributed to the code. Could you briefly describe here what their contributions to the project have been? We don't object to authors who are not code contributors but do have requirements on authorship, which I'll quote here for convenience:

Purely financial (such as being named on an award) and organizational (such as general supervision of a research group) contributions are not considered sufficient for co-authorship of JOSS submissions, but active project direction and other forms of non-code contributions are. The authors themselves assume responsibility for deciding who should be credited with co-authorship, and co-authors must always agree to be listed. In addition, co-authors agree to be accountable for all aspects of the work, and to notify JOSS if any retraction or correction of mistakes are needed after publication.

[xiaziyna]

Hi @warrickball, co-authors contributed to developing research ideas implemented here (optical methods/model) and advised on the code use cases and computational methods.

[ivastar]

@editorialbot assign @ivastar as editor

[editorialbot]

Assigned! @ivastar is now the editor

[ivastar]

@xiaziyna thank you for your patience with this submission. I am taking over as an editor. I will be looking for reviewers in the next couple of weeks. It would be greatly appreciated of you could recommend a few people who you think would be good referees, either here or via email ([email protected]).

[xiaziyna]

Hi @ivastar, I look forward to working with you. Does the reviewer have to be listed on the JOSS database of reviewers? If so, I can suggest the following: Iva Laginja @ivalaginja, Jaren Nicholas Ashcraft
@Jashcraf, Ewan Douglas @douglase.

[ivastar]

@editorialbot add @Jashcraf as reviewer

[editorialbot]

@Jashcraf added to the reviewers list!

[ivalaginja]

I'm willing to review if you still need a second!

[ivastar]

@ivalaginja awesome! I didn't reach out because I know you are already doing another review, but I am really grateful for you volunteering!

[ivastar]

@editorialbot add @ivalaginja as a reviewer

[editorialbot]

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

[ivastar]

@editorialbot add @ivalaginja as reviewer

[editorialbot]

@ivalaginja added to the reviewers list!

[ivastar]

@editorialbot start review

[editorialbot]

OK, I've started the review over in #7917.