[PRE REVIEW]: OceanLight.jl: A Julia package for calculating irradiance in the upper ocean using Monte Carlo simulations

[editorialbot]

Submitting author: @haoboatlab (郝轩亭 (Hao, Xuanting))
Repository: https://github.com/haoboatlab/OceanLight.jl
Branch with paper.md (empty if default branch):
Version: v.1.0.0
Editor: Pending
Reviewers: Pending
Managing EiC: Kristen Thyng

Status

Status badge code:

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

Author instructions

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

@haoboatlab 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.98  T=0.04 s (831.1 files/s, 141708.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Julia                            6            377            854           2258
TOML                             4            133              2            525
Markdown                        12            197              0            477
YAML                             7              3              4            185
TeX                              1             10              0             90
-------------------------------------------------------------------------------
SUM:                            30            720            860           3535
-------------------------------------------------------------------------------

Commit count by author:

    90	tayT0T
    14	Boat_Lab

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1204

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[editorialbot]

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

✅ OK DOIs

- None

🟡 SKIP DOIs

- No DOI given, and none found for title: Shedding new light on light in the ocean
- No DOI given, and none found for title: Light and Water: Radiative Transfer in Natural Wat...
- No DOI given, and none found for title: Monte Carlo procedure for simulating the penetrati...
- No DOI given, and none found for title: A DNS capability for obtaining underwater light fi...

❌ MISSING DOIs

- 10.1029/2003rg000148 may be a valid DOI for title: Optical oceanography: recent advances and future d...
- 10.21236/ad0753474 may be a valid DOI for title: Volume scattering functions for selected ocean wat...
- 10.1029/2022gl097769 may be a valid DOI for title: A novel machine learning method for accelerated mo...
- 10.1364/ao.20.000177 may be a valid DOI for title: Optical properties of the clearest natural waters ...
- 10.1029/2011jc007338 may be a valid DOI for title: Measurements of high-frequency light fluctuations ...
- 10.1029/2011jc007156 may be a valid DOI for title: Vertical changes in the probability distribution o...
- 10.1117/1.oe.53.5.051408 may be a valid DOI for title: Monte Carlo radiative transfer simulation for the ...

❌ INVALID DOIs

- None

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PlanktonIndividuals.jl: A GPU supported individual-based phytoplankton life cycle model
Submitting author: @zhenwu0728
Handling editor: @elbeejay (Active)
Reviewers: @Datseris, @BrodiePearson
Similarity score: 0.7109

Optimising Light Source Positioning for Even and Flux-Efficient Illumination
Submitting author: @adrena-lab
Handling editor: @trallard (Retired)
Reviewers: @cmccomb, @nicoguaro
Similarity score: 0.7051

OceanBioME.jl: A flexible environment for modelling the coupled interactions between ocean biogeochemistry and physics
Submitting author: @jagoosw
Handling editor: @kthyng (Active)
Reviewers: @francispoulin, @iuryt
Similarity score: 0.6955

Oceananigans.jl: Fast and friendly geophysical fluid dynamics on GPUs
Submitting author: @ali-ramadhan
Handling editor: @kthyng (Active)
Reviewers: @funsim, @mancellin
Similarity score: 0.6888

pycoxmunk: A python package for computing sea surface reflectance
Submitting author: @simonrp84
Handling editor: @pdebuyl (Active)
Reviewers: @arthur-e, @molinav
Similarity score: 0.6837

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

[kthyng]

Hi @haoboatlab and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

• OSI-approved license
• Installation instructions
• Documentation exists at all
• Tests of some sort
• Check paper (make sure compiles, read through, check for length 250-1000 words)
• Substantial scholarly effort
• Clear research application

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any), or suggest reviewers. For reviewers, please suggest 5 reviewers from the database listed above or your own (non-conflicted) extended network. Their github handles are most useful to receive but please don't use "@" to reference them since it will prematurely ping them.

[haoboatlab]

Hi @kthyng , thanks for handling the preview of our paper. We are fixing the missing DOI issue. Below is a list of reviewers that I suggest:

1. Yidongfang Si, [email protected], Dr. Si is an expert in geophysical fluid dynamics and she combines theoretical approaches and numerical simulations to investigate fundamental problems in physical oceanography.
2. Bia Villas Bôas (biavillasboas), [email protected], Dr. Villas Bôas is a physical oceanographer who combines observations, theory, and modeling to understand how coupled air-sea interactions affect the environment.
3. An Wang, [email protected], Dr. Wang is an expert in ocean wave applications and the fundamental and critical problems in free surface flows.
4. Gregory L. Wagner (glwagner), [email protected], Gregory L. Wagner, Dr. Wagner is one of the main developers of Oceananigans, a ocean model written in Julia.
5. iuryt (https://github.com/iuryt)

[haoboatlab]

@editorialbot commands

[editorialbot]

Hello @haoboatlab, 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

[haoboatlab]

@editorialbot check references

[editorialbot]

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

✅ OK DOIs

- 10.1063/1.3580492 is OK
- 10.1029/2003RG000148 is OK
- 10.21236/ad0753474 is OK
- 10.1029/2022GL097769 is OK
- 10.1364/ao.20.000177 is OK
- 10.1029/2011JC007338 is OK
- 10.1029/2011JC007156 is OK
- 10.1117/1.OE.53.5.051408 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Light and Water: Radiative Transfer in Natural Wat...
- No DOI given, and none found for title: Monte Carlo procedure for simulating the penetrati...
- No DOI given, and none found for title: A DNS capability for obtaining underwater light fi...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[haoboatlab]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PlanktonIndividuals.jl: A GPU supported individual-based phytoplankton life cycle model
Submitting author: @zhenwu0728
Handling editor: @elbeejay (Active)
Reviewers: @Datseris, @BrodiePearson
Similarity score: 0.7113

Optimising Light Source Positioning for Even and Flux-Efficient Illumination
Submitting author: @adrena-lab
Handling editor: @trallard (Retired)
Reviewers: @cmccomb, @nicoguaro
Similarity score: 0.7052

OceanBioME.jl: A flexible environment for modelling the coupled interactions between ocean biogeochemistry and physics
Submitting author: @jagoosw
Handling editor: @kthyng (Active)
Reviewers: @francispoulin, @iuryt
Similarity score: 0.6958

Oceananigans.jl: Fast and friendly geophysical fluid dynamics on GPUs
Submitting author: @ali-ramadhan
Handling editor: @kthyng (Active)
Reviewers: @funsim, @mancellin
Similarity score: 0.6890

pycoxmunk: A python package for computing sea surface reflectance
Submitting author: @simonrp84
Handling editor: @pdebuyl (Active)
Reviewers: @arthur-e, @molinav
Similarity score: 0.6839

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