[PRE REVIEW]: Idiomatic Ephemeris Sourcing and Parsing in Julia

[editorialbot]

Submitting author: !--author-handle-->@cadojo<!--end-author-handle-- (Joseph D Carpinelli) Repository: https://github.com/cadojo/EphemerisSources.jl Branch with paper.md (empty if default branch): main Version: N/A Editor: !--editor-->@adonath<!--end-editor-- Reviewers: @tamasgal, @andrew-saydjari Managing EiC: Dan Foreman-Mackey

Status

Status badge code:

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

Author instructions

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

@cadojo 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.37 s (478.5 files/s, 111649.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSS                             19            857            139          17600
HTML                            73           3038              2          12996
JavaScript                      60            504            533           3948
SVG                              2              0              0           1274
Markdown                         1             23              0            171
JSON                            18              0              0             18
TeX                              1              1              0             17
CSV                              1              0              0              2
Jupyter Notebook                 2              0            178              0
-------------------------------------------------------------------------------
SUM:                           177           4423            852          36026
-------------------------------------------------------------------------------

Commit count by author:

    55  Documenter.jl
     3  Joe(y) Carpinelli
     3  Quarto GHA Workflow Runner
     2  Joey Carpinelli

[editorialbot]

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

OK DOIs

- None

MISSING DOIs

- 10.1016/0032-0633(95)00107-7 may be a valid DOI for title: Ancillary Data Services of NASA’s Navigation and A...
- No DOI given, and none found for title: Status of the JPL horizons ephemeris system

INVALID DOIs

- None

[editorialbot]

:warning: An error happened when generating the pdf.

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 897

✅ The paper includes a Statement of need section

[editorialbot]

License info:

🔴 Failed to discover a valid open source license

[dfm]

@editorialbot set main as branch

[editorialbot]

Done! branch is now main

[dfm]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.01 s (1368.7 files/s, 40962.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                         5             46              0            161
YAML                             3             14              0             78
Julia                            1              9              4             62
TOML                             3              1              0             23
TeX                              1              1              0             17
Bourne Shell                     1              1              0              2
-------------------------------------------------------------------------------
SUM:                            14             72              4            343
-------------------------------------------------------------------------------

Commit count by author:

    53  Joey Carpinelli
     8  Joe(y) Carpinelli

[editorialbot]

Paper file info:

⚠️ Failed to find a paper file in https://github.com/cadojo/ephemeris.loopy.codes (branch: main)

[editorialbot]

License info:

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

[dfm]

@editorialbot set gh-pages as branch

[editorialbot]

Done! branch is now gh-pages

[dfm]

@cadojo — 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 think we should spend some time getting this submission a little more aligned with the way JOSS reviews typically work.

1. The big issue is that the paper doesn't have the correct syntax. Can you update it to have the syntax shown in our docs here, instead of using Quarto? It would be much better if this is on the main branch instead of autogenerated and pushed to the gh-pages branch, unless there's a strong argument otherwise.

2. Also JOSS typically operates under the assumption that the code and paper live together in the same project, but that isn't the case here. This submission covers 5 separate repositories, and the submitted project only contains documentation. We can work around this, but it does complicate our workflow to some extent. It does look to me like these 5 projects do contain sufficient "scholarly effort", but each one of the projects is very small (see cloc summaries below), with a relatively short revision history. We can definitely work around this, but I'd love to get a comment here from you about the justification for distributing the project like this instead of as a single library.

Output of cloc on each project

```bash ~/Desktop ❯ rm -rf main.zip; wget -q https://github.com/cadojo/HorizonsAPI.jl/archive/refs/heads/main.zip; cloc main.zip 19 text files. 16 unique files. 4 files ignored. github.com/AlDanial/cloc v 2.00 T=0.03 s (463.3 files/s, 22819.5 lines/s) ------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- Julia 3 84 84 289 Markdown 4 33 0 119 YAML 4 4 0 115 Text 3 2 0 32 TOML 2 4 0 22 ------------------------------------------------------------------------------- SUM: 16 127 84 577 ------------------------------------------------------------------------------- ~/Desktop ❯ rm -rf main.zip; wget -q https://github.com/cadojo/HorizonsEphemeris.jl/archive/refs/heads/main.zip; cloc main.zip 16 text files. 13 unique files. 4 files ignored. github.com/AlDanial/cloc v 2.00 T=0.11 s (116.2 files/s, 6464.4 lines/s) ------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- Julia 3 84 38 256 Markdown 4 44 0 128 YAML 4 5 0 126 TOML 2 4 0 38 ------------------------------------------------------------------------------- SUM: 13 137 38 548 ------------------------------------------------------------------------------- ~/Desktop ❯ rm -rf main.zip; wget -q https://github.com/cadojo/SPICEKernels.jl/archive/refs/heads/main.zip; cloc main.zip 24 text files. 21 unique files. 3 files ignored. github.com/AlDanial/cloc v 2.00 T=0.05 s (386.2 files/s, 100044.3 lines/s) ------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- Julia 8 1531 2723 722 YAML 6 9 0 183 Markdown 3 58 0 175 TOML 3 4 0 33 make 1 0 0 2 ------------------------------------------------------------------------------- SUM: 21 1602 2723 1115 ------------------------------------------------------------------------------- ~/Desktop ❯ rm -rf main.zip; wget -q https://github.com/cadojo/SPICEBodies.jl/archive/refs/heads/main.zip; cloc main.zip 16 text files. 13 unique files. 3 files ignored. github.com/AlDanial/cloc v 2.00 T=0.03 s (375.4 files/s, 15161.1 lines/s) ------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- YAML 4 4 0 118 Markdown 3 33 0 110 Julia 3 44 78 106 TOML 3 4 0 28 ------------------------------------------------------------------------------- SUM: 13 85 78 362 ------------------------------------------------------------------------------- ~/Desktop ❯ rm -rf main.zip; wget -q https://github.com/cadojo/SPICEApplications.jl/archive/refs/heads/main.zip; cloc main.zip 16 text files. 13 unique files. 3 files ignored. github.com/AlDanial/cloc v 2.00 T=0.04 s (364.7 files/s, 29034.0 lines/s) ------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- Julia 4 168 243 395 YAML 4 5 0 128 Markdown 3 17 0 52 TOML 2 4 0 23 ------------------------------------------------------------------------------- SUM: 13 194 243 598 ------------------------------------------------------------------------------- ```

[cadojo]

@editorialbot set main as branch

[editorialbot]

Done! branch is now main

[cadojo]

@editorialbot commands

[editorialbot]

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

[cadojo]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf. Paper file not found.

[cadojo]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.05 s (1235.8 files/s, 146985.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Julia                           20           1760           2949           1457
Markdown                        20            233              0            793
YAML                             8             44             15            283
TOML                            14             19              0            155
TeX                              1              1              0             17
Bourne Shell                     1              1              0              2
make                             1              0              0              2
-------------------------------------------------------------------------------
SUM:                            65           2058           2964           2709
-------------------------------------------------------------------------------

Commit count by author:

   100  Joey Carpinelli
    73  cadojo
    68  Joe Carpinelli
    26  Joe(y) Carpinelli
     8  CompatHelper Julia
     1  github-actions[bot]

[editorialbot]

Paper file info:

⚠️ Failed to find a paper file in https://github.com/cadojo/ephemeris.loopy.codes (branch: main)

[editorialbot]

License info:

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

[cadojo]

@editorialbot set https://github.com/cadojo/EphemerisSources as repository

[editorialbot]

I'm sorry @cadojo, I'm afraid I can't do that. That's something only editors are allowed to do.

[cadojo]

@dfm Thank you for your time and guidance! I think I have addressed all of the topics above, but please let me know if I have any other actions I should take. Also, could you please change the repository to https://github.com/cadojo/EphemerisSources.jl?

Thank you again for everything. Please let me know if I can simplify this process further.

---

1. The big issue is that the paper doesn't have the correct syntax.

I edited the paper to match the example you referenced. I had thought "Pandoc Markdown" was good enough, but I should be precisely matching the example now. Please let me know if it is still failing to build internally for you all.

2. Also JOSS typically operates under the assumption that the code and paper live together in the same project, but that isn't the case here.

Having all of those small projects in separate repos had become a hassle for me as well. I just moved all of those projects into one common repository: cadojo/EphemerisSources.jl. The EphemerisSources.jl package is not actually a library I am releasing, it is just boilerplate to support multiple Julia projects in a single package. So, I would still like to release this paper for four separate Julia packages (I have removed SPICEApplications, as that is just a small wrapper and was an outlier in the paper), if that is possible. I've followed some of the SciML guidance, which recommends sub-packages in a common repo.

So in short, I now have EphemerisSources.jl as a common repo for all projects, this paper, and unified documentation. These packages are still released separately with Julia's package manager, but if I understand you correctly, that isn't a problem for this paper

[cadojo]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf.

[cadojo]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf. Problem with ORCID (https://orcid.org/0000-0001-8655-8125) for Joseph Carpinelli. ORCID looks to be the wrong length.

[cadojo]

@editorialbot generate pdf

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[cadojo]

@editorialbot generate pdf @editorialbot generate latex

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[cadojo]

@editorialbot generate pdf

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[dfm]

@editorialbot invite @adonath as editor

[editorialbot]

Invitation to edit this submission sent!

[adonath]

@editorialbot assign @adonath as editor

[editorialbot]

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

@editorialbot commands

[adonath]

@editorialbot commands

[editorialbot]

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

# List all available commands
@editorialbot commands

# Add to this issue's reviewers list
@editorialbot add @username as reviewer

# Remove from this issue's reviewers list
@editorialbot remove @username from reviewers

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

# Assign a user as the editor of this submission
@editorialbot assign @username as editor

# Remove the editor assigned to this submission
@editorialbot remove editor

# Remind an author, a reviewer or the editor to return to a review after a 
# certain period of time (supported units days and weeks)
@editorialbot remind @reviewer in 2 weeks

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

# Set a value for version
@editorialbot set v1.0.0 as version

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

# Set a value for repository
@editorialbot set https://github.com/organization/repo as repository

# Set a value for the archive DOI
@editorialbot set 10.5281/zenodo.6861996 as archive

# Mention the EiCs for the correct track
@editorialbot ping track-eic

# 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

# Recommends the submission for acceptance
@editorialbot recommend-accept

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Flag submission with questionable scope
@editorialbot query scope

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

# Creates a post-review checklist with editor and authors tasks
@editorialbot create post-review checklist

# Open the review issue
@editorialbot start review

[adonath]

@editorialbot assign @adonath as editor

[editorialbot]

Assigned! @adonath is now the editor

[cadojo]

Hey @adonath! I will be updating the repository a bit this weekend. All of the code is there for review, but I've run into automated tagging issues after moving code from several packages into this one project.

Also, could you please change the repository to "EphemerisSources.jl"?

https://github.com/cadojo/EphemerisSources.jl

[cadojo]

@editorialbot generate pdf

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[adonath]

@editorialbot set https://github.com/cadojo/EphemerisSources.jl as repository