joss-paper: Minor

[ericneiva]

Documentation

Core API documentation

• Document CollocationPoint
• Document HierarchicalCollocationPoint
• This signature does not correspond to the function signature it documents

Examples

In this example

• Should the first line of the code snippet read using DistributedSparseGrids
• pointprobs argument of sparse_grid... would pointprops be a better name?

Paper

• I would recommend to make the example self-contained, that is, add the missing lines needed to generate Figure 1 (happy to see that too in the readme documentation)
• I would add DOIs or arXiv links to all references
• Has all financial support been properly acknowledged?
• (Line 4) Complete full affiliation details
• (Line 18) to be solved
• (Line 18) ...and, in addition, if the solution... (does this make sense?)
• In the example, #set of all collocation points to # set of all collocation points

Archive

• Has the software been already archived?

Unused type variables

• I run your tests with Julia 1.8.3 and I got the following "unused type variable" warnings:

WARNING: method definition for next_level_pt_idx at /home/eric-neiva/.julia/packages/DistributedSparseGrids/F7UUX/src/CollocationPoints/one_dimensional_collocation_points.jl:60 declares type variable CT but does not use it.
WARNING: method definition for length at /home/eric-neiva/.julia/packages/DistributedSparseGrids/F7UUX/src/AdaptiveSparseGrids/utils.jl:130 declares type variable HCP but does not use it.
WARNING: method definition for init! at /home/eric-neiva/.julia/packages/DistributedSparseGrids/F7UUX/src/DistributedSparseGrids.jl:71 declares type variable F but does not use it.
WARNING: method definition for init at /home/eric-neiva/.julia/packages/DistributedSparseGrids/F7UUX/src/DistributedSparseGrids.jl:106 declares type variable F but does not use it.

See openjournals/joss-reviews#5003

[baxmittens]

Thank you for your detailed notes. I think I did change everything accordingly. If this review is finished I will issue a new version of this package (0.1.4) and archive this version. I think this will be the best way. Do you agree @ericneiva ?

[baxmittens]

I forgot to mention: there was no financial support for this project.

[baxmittens]

to see the changes according to the unused type warning you may have to checkout the newest commit

]add DistributedSparseGrids#7be01c3

or wait till I have registered a new release

[ericneiva]

If this review is finished I will issue a new version of this package (0.1.4) and archive this version. I think this will be the best way. Do you agree @ericneiva ?

Sure, @baxmittens!

• On commit 7be01c3 I am still getting the first warning about an unused variable in next_level_pt_idx.
• Have you thought about listing the affiliation of the second author as "Independent Researcher" instead of "None"? See here.

Feel free to close this issue whenever the SW is archived.

[baxmittens]

Ok, thank you. I probably missed something there. I will double-check the unused variable and fix this.

I just had a look at this thread.

openjournals/joss#406

Probably outdated...
My colleague (who recently changed company) is checking with his employer about what affiliation he should use for this paper. so this will probably change again anyways.