openjournals / joss-reviews

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

[PRE REVIEW]: Control software for the open-source Broadly Reconfigurable and Expandable Automation Device (BREAD) System #7189

Open editorialbot opened 1 week ago

editorialbot commented 1 week ago

Submitting author: !--author-handle-->@xanderchinxyz<!--end-author-handle-- (Xander Chin) Repository: https://github.com/FHafting/BREAD-Local-Software Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: Pending Reviewers: Pending Managing EiC: Arfon Smith

Status

status

Status badge code:

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

Author instructions

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

@xanderchinxyz 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 week 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 week ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

βœ… OK DOIs

- 10.1016/j.ohx.2023.e00467 is OK
- 10.1016/j.ohx.2020.e00137 is OK
- 10.1088/1361-6501/ac9994 is OK
- 10.1371/journal.pbio.3000014 is OK
- 10.3390/electronics12244893 is OK

🟑 SKIP DOIs

- No DOI given, and none found for title: Plotly.js
- No DOI given, and none found for title: Arduino-ESP32
- No DOI given, and none found for title: ESPAsyncWebServer
- No DOI given, and none found for title: MOST_OpenReactor

❌ MISSING DOIs

- 10.1016/j.measurement.2014.05.010 may be a valid DOI for title: Low-cost open-source multifunction data acquisitio...
- 10.1109/nssmic.2014.7431254 may be a valid DOI for title: Design of the SLAC RCE Platform: A general purpose...

❌ INVALID DOIs

- None
editorialbot commented 1 week ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.03 s (474.9 files/s, 153551.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                             1            118             12           1889
Arduino Sketch                   3            231            127           1383
TeX                              1             10              0            247
Markdown                         2             22              0             67
YAML                             1              1              4             19
JavaScript                       1              0             51             10
CSV                              3              0              0              9
JSON                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            13            382            194           3627
-------------------------------------------------------------------------------

Commit count by author:

    31  xanderchinxyz
     8  Xander Chin
     8  finnhafting
     1  Finn Hafting
editorialbot commented 1 week ago

Paper file info:

πŸ“„ Wordcount for paper.md is 1124

βœ… The paper includes a Statement of need section

editorialbot commented 1 week ago

License info:

πŸ”΄ Failed to discover a valid open source license

editorialbot commented 1 week 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 week ago

Five most similar historical JOSS papers:

Pybehave: a hardware agnostic, Python-based framework for controlling behavioral neuroscience experiments Submitting author: @theonlydvr Handling editor: @sappelhoff (Active) Reviewers: @tuliofalmeida, @alustig3 Similarity score: 0.6535

jsPsych: Enabling an Open-Source Collaborative Ecosystem of Behavioral Experiments Submitting author: @jodeleeuw Handling editor: @oliviaguest (Active) Reviewers: @pmcharrison, @xinyiguan, @chartgerink Similarity score: 0.6305

CHAMP is a HPC Access and Metadata Portal Submitting author: @cc-a Handling editor: @crvernon (Active) Reviewers: @thurber, @acrlakshman Similarity score: 0.6272

Autosubmit GUI: A Javascript-based Graphical User Interface to Monitor Experiments Workflow Execution Submitting author: @wuruchi Handling editor: @arfon (Active) Reviewers: @djmitche, @ikayz Similarity score: 0.6264

Pyafscgap.org: Open source multi-modal Python-based tools for NOAA AFSC RACE GAP Submitting author: @sampottinger Handling editor: @Kevin-Mattheus-Moerman (Active) Reviewers: @Kevin-Mattheus-Moerman Similarity score: 0.6188

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

arfon commented 1 week ago

@editorialbot query scope

@xanderchinxyz – many thanks for your submission to JOSS. I'm going to start a scope review amongst the JOSS editors to decide if this submission is research software as defined by JOSS. This does not mean that it is not software that is useful in research, but just that JOSS might not consider it in scope for review as research software.

This process will likely take a week or so to complete.

editorialbot commented 1 week ago

Submission flagged for editorial review.

arfon commented 1 week ago

@xanderchinxyz – could you please explain how this software can be tested?

xanderchinxyz commented 2 days ago

@xanderchinxyz – could you please explain how this software can be tested?

Hi @arfon the software can be tested with a SparkFun ESP32 WROOM Thing Plus that has a mounted SD card. Sample data from the CSV file can then be shown and displayed when connecting to the locally hosted website. However, to test the control functionality, additional hardware from the BREAD system is required, which we're happy to provide if needed.