opnavlab / sonic Goto Github PK

@athrasher7 Below are my review comments for SONIC openjournals/joss-reviews#6812

• Please add a setup.m function and use the addpath command to automatically add all the main and subfolders to the main folder.

• Please add a readme.md to all the folders so that people can read easily what's going on in that folder.

• Please add a one-sentence description of the licenses to each code file.

• Please describe how people can contribute to this software package on the first page. Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support.

• In my personal project TsgFEM I use a MATLAB script called test_all.m (https://github.com/Muhao-Chen/Tensegrity_Finite_Element_Method_TsgFEM/blob/main/Software_Verification_and_Examples/test_all.m) to run all tests/demos automatically. Consider adopting a similar automated testing scheme.

• Please add more introduction to how to use the software to solve real-world analysis problems on the first page and the paper. It is preferred to have a few bullet points.

• Other languages are used apart from Matlab and HTML. Consider writing a paragraph to clarify if related software or environment setup is needed.

• Versions of MATLAB toolbox dependencies (Image Processing Toolbox, Computer Vision System Toolbox) and computer requirements need to be explained in more detail.

Add covariance to HorizonOPNAV class.

Paper Comments:

• The paper is very-well written, and the code is well-documented.
• My recommendation is to include at least a couple of figures in the paper which illustrate the capability of the SONIC package to real world problems. Examples include: 1) the Synthetic Star Image of Arcturus, and its surrounding starfield, 2) smear removal of the Bennu asteroid image, 3) intensity of the image over a scan line, 4) Vesta 3D reconstruction. Including some of these figures in the paper, in my opinion would enrich the quality, and offer a preview of the capabilities to a diverse, non-specialist audience reading the paper.

Code Comments:

• The code is generally well-written, and well-organized. The examples in the documentation clearly illustrate the applications.
• There are no unit tests for any of the methods in +sonic. Please consider adding some unit tests for at least some of the core methods, or provide a justification how the authors verified the functions used are implemented correctly.
• There are no integration tests which exercise multiple methods used in a workflow. Please consider adding some integration tests, or alternatively provide a justification (for example: can the software reproduce some published results elsewhere?)
• "Note: As of 5/16/2024, SONIC has a few MATLAB toolbox dependencies which will require installation prior to full operation."
  • [optional] Instead of a hard-coded date, consider creating a tagged release, and use the version tag here instead (eg: v1.0)
  • [optional] consider replacing "SONIC has a few MATLAB toolbox dependencies" with "SONIC requires the following MATLAB toolboxes installed."
  • please specify the minimum required versions for the two dependencies, and if the latest versions are preferred.
• There are no community guidelines for contributions. Please consider adding a minimal CONTRIBUTING.md: https://github.com/astropy/astropy?tab=readme-ov-file#contributing-code-documentation-or-feedback

Minor comments:

• The first reference appears it should be "Astrometry.net", instead of "Astronomy.net"

Need to add functionality for smear removal in CCD images.