openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
722 stars 38 forks source link

[PRE REVIEW]: EKF_CAL: Extended Kalman Filter-based Calibration and Localization #7292

Open editorialbot opened 1 month ago

editorialbot commented 1 month ago

Submitting author: !--author-handle-->@JHartzer<!--end-author-handle-- (Jacob Hartzer) Repository: https://github.com/unmannedlab/ekf_cal/ Branch with paper.md (empty if default branch): Version: 0.5 Editor: Pending Reviewers: Pending Managing EiC: Kyle Niemeyer

Status

status

Status badge code:

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

Author instructions

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

@JHartzer 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 commented 1 month ago

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 commented 1 month ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.10 s (2025.6 files/s, 286480.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C++                             76           1930           1351           8611
Python                          13            353            338           2492
CSS                              3            463            144           2140
YAML                            22            138             56           1717
C/C++ Header                    50            650           2294           1657
Perl                             2            144            319           1274
Markdown                        16            143              0            665
JSON                             5              0              0            463
CMake                            1             39             15            200
JavaScript                       4             42             89            156
HTML                             2             14             27             88
TeX                              2              5              0             58
XML                              1              4              3             25
Dockerfile                       1              5              4             24
Bourne Shell                     1              0              0              5
-------------------------------------------------------------------------------
SUM:                           199           3930           4640          19575
-------------------------------------------------------------------------------

Commit count by author:

   526  Jacob
     1  JHartzer
     1  Jacob Hartzer
editorialbot commented 1 month ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1109/SSRR56537.2022.10018692 is OK
- 10.1109/SDF-MFI59545.2023.10361310 is OK
- 10.1109/ICRA40945.2020.9196524 is OK
- 10.48550/arXiv.2205.14087 is OK
- 10.1109/ICRA.2016.7487628 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Computer Vision Toolbox version: 24.1 (R2022b)

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
editorialbot commented 1 month ago

Paper file info:

📄 Wordcount for paper.md is 1455

✅ The paper includes a Statement of need section

editorialbot commented 1 month ago

License info:

🟡 License found: GNU General Public License v3.0 (Check here for OSI approval)

editorialbot commented 1 month ago

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

editorialbot commented 1 month ago

Five most similar historical JOSS papers:

imucal - A Python library to calibrate 6 DOF IMUs Submitting author: @AKuederle Handling editor: @adi3 (Active) Reviewers: @tuliofalmeida, @finsberg Similarity score: 0.7231

AixCaliBuHA: Automated calibration of building and HVAC systems Submitting author: @FWuellhorst Handling editor: @fraukewiese (Active) Reviewers: @samanmostafavi, @shamsiharis Similarity score: 0.6683

SLAM Toolbox: SLAM for the dynamic world Submitting author: @stevemacenski Handling editor: @arfon (Active) Reviewers: @mosteo, @carlosjoserg Similarity score: 0.6589

Pose2Sim: An open-source Python package for multiview markerless kinematics Submitting author: @DavidPagnon Handling editor: @danasolav (Active) Reviewers: @lambdaloop, @jonmatthis, @CVHammond Similarity score: 0.6427

GeoBO: Python package for Multi-Objective Bayesian Optimisation and Joint Inversion in Geosciences Submitting author: @sebhaan Handling editor: @hugoledoux (Active) Reviewers: @npetra, @sgkang Similarity score: 0.6330

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

kyleniemeyer commented 1 month ago

Hi @JHartzer, we will use this pre-review issue to find an editor and reviewers, and resolve any issues.

Although I can see that your software package meets most of our requirements (documentation, installation instructions, etc.), I'm not sure about a test suite. At minimum, we need instructions on manually testing the full functionality of the software; normally, we want to see—and reviewers will request—an automated test suite for unit and functional testing. (And at best, hooked into continuous integration.)

JHartzer commented 1 month ago

Hello @kyleniemeyer! Thank you for the initial feedback. I do have a test suite (that is not yet automated) for code testing and coverage. I've updated the main README and documentation landing to hopefully make that a little more clear. I can also take an action to work on a CI pipeline.

As far as reviewer suggestions, here is a list of possibilities from similar authors and a keyword search:

kyleniemeyer commented 1 month ago

@JHartzer please do work on the CI pipeline; generally this isn't too challenging to set up with GitHub Actions.

@pdebuyl could you edit this?

kyleniemeyer commented 1 month ago

@editorialbot invite @pdebuyl as editor

editorialbot commented 1 month ago

Invitation to edit this submission sent!

JHartzer commented 1 month ago

The unit tests are now being performed automatically with a github workflow!

kyleniemeyer commented 3 weeks ago

@JHartzer great! Although, it looks like the README badge is not rendering properly - perhaps the link is incorrect?

JHartzer commented 3 weeks ago

Thanks for the catch! That should be resolved now. It was a classic case of 'it works on my machine' using a private test repo badge.

pdebuyl commented 3 weeks ago

Hi @kyleniemeyer I can't take this submission right now, sorry.

kyleniemeyer commented 4 hours ago

@JHartzer unfortunately, we do not have any other editors available to handle this, so it will have to go on our waitlist until someone frees up.