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]: QuDAP: an Open Source Software for Quantum Materials Characterization #7194

Open editorialbot opened 2 months ago

editorialbot commented 2 months ago

Submitting author: !--author-handle-->@CharlieGPA40<!--end-author-handle-- (Chunli Tang) Repository: https://github.com/CharlieGPA40/QuDAP Branch with paper.md (empty if default branch): Version: v0.0.5 Editor: Pending Reviewers: Pending Managing EiC: Arfon Smith

Status

status

Status badge code:

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

Author instructions

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

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

✅ OK DOIs

- 10.21105/joss.05304 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Python tutorial
- No DOI given, and none found for title: Thermal transport in 2D materials
- No DOI given, and none found for title: Emerging intrinsic magnetism in two-dimensional ma...
- No DOI given, and none found for title: Laser-Assisted Synthesis of Monolayer 2D MoSe2 Cry...
- No DOI given, and none found for title: Quantum engineering with hybrid magnonic systems a...
- No DOI given, and none found for title: Spin dynamics in van der Waals magnetic systems
- No DOI given, and none found for title: Vibrating sample magnetometer
- No DOI given, and none found for title: Anomalous hall effect
- No DOI given, and none found for title: Atomic force microscopy for two-dimensional materi...
- No DOI given, and none found for title: Quantum Design PPMS DynaCool
- No DOI given, and none found for title: MultiPyVu 2.1.4
- No DOI given, and none found for title: Model 845 Datasheet v2.75
- No DOI given, and none found for title: Keithley 6220-6221
- No DOI given, and none found for title: Model 2182 and 2182A Nanovoltmeter User’s Manual
- No DOI given, and none found for title: Model 7265 DSP Lock-in Amplifier
- No DOI given, and none found for title: PyQt6 Documentation
- No DOI given, and none found for title: Instrument Automation with Python
- No DOI given, and none found for title: Pandas documentation
- No DOI given, and none found for title: Matplotlib 3.9.1 documentation

❌ MISSING DOIs

- 10.1109/tasc.2023.3271950 may be a valid DOI for title: Methodology to Characterize Thermal Properties of ...
- 10.1007/s42247-021-00214-5 may be a valid DOI for title: Recent developments on 2D magnetic materials: chal...
- 10.1021/acsnano.1c06864 may be a valid DOI for title: Recent developments in van der Waals antiferromagn...
- 10.1039/c3nr03242f may be a valid DOI for title: Review on measurement techniques of transport prop...
- 10.1002/admi.201701246 may be a valid DOI for title: Mechanical properties of 2D materials studied by i...

❌ INVALID DOIs

- None
editorialbot commented 2 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.14 s (2448.9 files/s, 89970.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          30           1234           1490           8416
SVG                            309              9              0            769
XML                              2              0              0            356
TeX                              1             25              0            198
Markdown                         2             50              0            108
YAML                             3              6              5             97
TOML                             1              2              0             20
-------------------------------------------------------------------------------
SUM:                           348           1326           1495           9964
-------------------------------------------------------------------------------

Commit count by author:

   198  Chunli Tang
    34  CharlieGPA40
editorialbot commented 2 months ago

Paper file info:

📄 Wordcount for paper.md is 1154

✅ The paper includes a Statement of need section

editorialbot commented 2 months ago

License info:

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

editorialbot commented 2 months ago

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

editorialbot commented 2 months ago

Five most similar historical JOSS papers:

NOMAD CAMELS: Configurable Application for Measurements, Experiments and Laboratory Systems Submitting author: @lapmk Handling editor: @srmnitc (Active) Reviewers: @NicolasCARPi, @ktahar Similarity score: 0.6969

PYDAQ: Data Acquisition and Experimental Analysis with Python Submitting author: @samirmartins Handling editor: @kyleniemeyer (Active) Reviewers: @galessiorob, @nataliakeles Similarity score: 0.6950

Pyra: Automated EM27/SUN Greenhouse Gas Measurement Software Submitting author: @patrickjaigner Handling editor: @AoifeHughes (Retired) Reviewers: @nmstreethran, @arthur-e Similarity score: 0.6891

Qiskit Experiments: A Python package to characterize and calibrate quantum computers Submitting author: @eggerdj Handling editor: @danielskatz (Active) Reviewers: @nunezco2, @goerz, @TejasAvinashShetty Similarity score: 0.6843

MAHOS: Measurement Automation Handling and Orchestration System Submitting author: @ktahar Handling editor: @arfon (Active) Reviewers: @sidihamady, @aquilesC Similarity score: 0.6767

⚠️ 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 2 months ago

@CharlieGPA40 - thanks for your submission to JOSS. We're currently managing a large backlog of submissions and the editor most appropriate for your area is already rather busy.

For now, we will need to waitlist this paper and process it as the queue reduces. Thanks for your patience!

CharlieGPA40 commented 2 months ago

@editorialbot check references

editorialbot commented 2 months ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.3390/nano13010117 is OK
- 10.1109/TASC.2023.3271950 is OK
- 10.1088/2053-1583/abc8cb is OK
- 10.1007/s42247-021-00214-5 is OK
- 10.1021/acsanm.2c01458 is OK
- 10.1109/TQE.2021.3057799 is OK
- 10.1016/j.physrep.2023.09.002 is OK
- 10.1021/acsnano.1c06864 is OK
- 10.21105/joss.05304 is OK
- 10.1063/1.1715636 is OK
- 10.1103/RevModPhys.82.1539 is OK
- 10.1039/C3NR03242F is OK
- 10.1016/j.optcom.2017.05.015 is OK
- 10.1002/admi.201701246 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Python tutorial
- No DOI given, and none found for title: Quantum Design PPMS DynaCool
- No DOI given, and none found for title: MultiPyVu 2.1.4
- No DOI given, and none found for title: Model 845 Datasheet v2.75
- No DOI given, and none found for title: Keithley 6220-6221
- No DOI given, and none found for title: Model 2182 and 2182A Nanovoltmeter User’s Manual
- No DOI given, and none found for title: Model 7265 DSP Lock-in Amplifier
- No DOI given, and none found for title: PyQt6 Documentation
- No DOI given, and none found for title: Instrument Automation with Python
- No DOI given, and none found for title: Pandas documentation
- No DOI given, and none found for title: Matplotlib 3.9.1 documentation

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None
CharlieGPA40 commented 2 months ago

@editorialbot generate pdf

editorialbot commented 2 months ago

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

editorialbot commented 2 months ago

Five most similar historical JOSS papers:

NOMAD CAMELS: Configurable Application for Measurements, Experiments and Laboratory Systems Submitting author: @lapmk Handling editor: @srmnitc (Active) Reviewers: @NicolasCARPi, @ktahar Similarity score: 0.6967

PYDAQ: Data Acquisition and Experimental Analysis with Python Submitting author: @samirmartins Handling editor: @kyleniemeyer (Active) Reviewers: @galessiorob, @nataliakeles Similarity score: 0.6945

Pyra: Automated EM27/SUN Greenhouse Gas Measurement Software Submitting author: @patrickjaigner Handling editor: @AoifeHughes (Retired) Reviewers: @nmstreethran, @arthur-e Similarity score: 0.6889

Qiskit Experiments: A Python package to characterize and calibrate quantum computers Submitting author: @eggerdj Handling editor: @danielskatz (Active) Reviewers: @nunezco2, @goerz, @TejasAvinashShetty Similarity score: 0.6840

MAHOS: Measurement Automation Handling and Orchestration System Submitting author: @ktahar Handling editor: @arfon (Active) Reviewers: @sidihamady, @aquilesC Similarity score: 0.6762

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

phibeck commented 1 month ago

Hi @arfon I could edit this one (with some caveat, see below)

Hi @CharlieGPA40 I briefly looked at the repo. Before we start, it would be good to clarify the hardware requirements for this submission. As per the documentation it seems like reviewers would need access to a very specific configuration, is that correct? According to our policy, the reviewers must be able to test the software. In order to go forward with the review, we do therefore need you to provide a way for the reviewers to run the software, for example via software emulation, or alternatively, assign reviewers with access to the hardware. Perhaps you can let me know if you can think of someone without COI who does have access, or which direction you want to proceed, thanks.

CharlieGPA40 commented 1 month ago

Hi @phibeck,

Thank you for your response! The current software has two parts: the data processing part and the data acquisition part. It can run without fulfilling any of the hardware requirements on Windows. I am willing to provide the emulation to run the data acquisition process and the example data to run each data processing feature.

kyleniemeyer commented 1 month ago

@CharlieGPA40 the package needs to be fully testable and able to be run without the hardware, so please do provide necessary data for this purpose. In addition, is this limited to running on Windows? That massively limits the reusability of the software.

CharlieGPA40 commented 1 week ago

Hi @kyleniemeyer and @phibeck, I have provided the emulation feature and sample data, which allows the software to run without hardware restrictions. However, due to the compatibility requirements of most instruments, the instrumentation functionality is limited to Windows machines. The data processing features are fully operational across all operating systems. I really appreciate the feedback you have provided!