[PRE REVIEW]: yieldplotlib: A unified library for exoplanet yield code visualizations

[editorialbot]

Submitting author: @steigersg (Sarah Steiger)
Repository: https://github.com/HWO-Yield-Visualizations/yieldplotlib
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: Pending
Reviewers: Pending
Managing EiC: Warrick Ball

Status

Status badge code:

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

Author instructions

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

@steigersg 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]

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

✅ OK DOIs

- 10.1117/12.2233913 is OK
- 10.1088/0004-637X/795/2/122 is OK
- 10.1117/12.3018328 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Cross-Model Validation of Coronagraphic Exposure T...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.09 s (829.3 files/s, 153831.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          45            929           1408           8914
Markdown                        14            238              2            904
Text                             1             12              0            290
YAML                             9             40             37            240
Jupyter Notebook                 1              0            386            123
TeX                              1              0              0             76
TOML                             1             11              0             62
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            74           1242           1841          10644
-------------------------------------------------------------------------------

Commit count by author:

   213	Sarah Steiger
   137	Corey Spohn
    91	pre-commit-ci[bot]
    58	GitHub Action
     1	Alex Howe

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1725

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: MIT License (Valid open source OSI approved license)

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PlanetMapper: A Python package for visualising, navigating and mapping Solar System observations
Submitting author: @ortk95
Handling editor: @mbobra (Active)
Reviewers: @steo85it, @tedjohnson12
Similarity score: 0.7069

ThermoParser: Streamlined Analysis of Thermoelectric Properties
Submitting author: @kbspooner
Handling editor: @mbarzegary (Active)
Reviewers: @enricgrau, @fnattino, @espottesmith
Similarity score: 0.6947

splot - visual analytics for spatial statistics
Submitting author: @slumnitz
Handling editor: @leouieda (Retired)
Reviewers: @ResidentMario, @martinfleis
Similarity score: 0.6856

plotastic: Bridging Plotting and Statistics in Python
Submitting author: @markur4
Handling editor: @rkurchin (Active)
Reviewers: @gmrandazzo, @SunnyXu
Similarity score: 0.6852

Spelunker: A quick-look Python pipeline for JWST NIRISS FGS Guide Star Data
Submitting author: @GalagaBits
Handling editor: @ivastar (Active)
Reviewers: @evamariaa, @taylorbell57
Similarity score: 0.6812

⚠️ 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 @steigersg, 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'll indicate up front that this will probably take several months given the current backlog. Sorry, and thanks for your patience!

In the meantime, note that our docs ask that papers are short:

The paper should be between 250-1000 words. Authors submitting papers significantly longer than 1000 words may be asked to reduce the length of their paper.

Though I won't insist on the paper being strictly under 1000 words, it would be good to try to get it below about 1200 or so. The main point of the paper is to describe the context and purpose of the software. Though this can be motivated with examples, the paper shouldn't double up on documentation. In this case, I think it's mainly the "Methods and Functionality" section that you should try to reduce.

[warrickball]

Editors, note that about 5200 lines of Python is in src/yieldplotlib/key_map.py.

[steigersg]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

coronagraph: Telescope Noise Modeling for Exoplanets in Python
Submitting author: @jlustigy
Handling editor: @arfon (Active)
Reviewers: @lpueyo
Similarity score: 0.7342

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

deeplenstronomy: A dataset simulation package for strong gravitational lensing
Submitting author: @rmorgan10
Handling editor: @pdebuyl (Active)
Reviewers: @shreyasbapat, @jiwoncpark
Similarity score: 0.7270

exoplanet: Gradient-based probabilistic inference for exoplanet data & other astronomical time series
Submitting author: @dfm
Handling editor: @arfon (Active)
Reviewers: @grburgess, @benjaminpope
Similarity score: 0.7265

Astronomical échelle spectroscopy data analysis with muler
Submitting author: @gully
Handling editor: @xuanxu (Active)
Reviewers: @bmorris3, @wtgee
Similarity score: 0.7254

⚠️ 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.

[steigersg]

@editorialbot commands

[editorialbot]

Hello @steigersg, here are the things you can ask me to do:

# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Get a link to the complete list of reviewers
@editorialbot list reviewers