[REVIEW]: OpenPelt: Python Framework for Thermoelectric Temperature Control System Development

[editorialbot]

Submitting author: @gdetor (Georgios Detorakis)
Repository: https://github.com/thejackal360/OpenPelt-Public
Branch with paper.md (empty if default branch): master
Version: beta
Editor: @rkurchin
Reviewers: @tpurcell90, @danaraujocr
Archive: 10.5281/zenodo.6514903

Status

Status badge code:

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

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@tpurcell90 & @danaraujocr, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @rkurchin know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @tpurcell90

📝 Checklist for @danaraujocr

[editorialbot]

Hello humans, 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]

Software report:

github.com/AlDanial/cloc v 1.88  T=0.07 s (273.2 files/s, 26939.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          15            218            294            967
Markdown                         2             59              0            277
TeX                              1              7              0             81
Bourne Shell                     1              3              0             43
YAML                             1              1              4             18
-------------------------------------------------------------------------------
SUM:                            20            288            298           1386
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/S0003-2670(03)00676-7 is OK
- 10.1049/el:20062442 is OK
- 10.1145/1731022.1731030 is OK
- 10.1109/IMTC.2000.848895 is OK

MISSING DOIs

- None

INVALID DOIs

- 10.1016/j.applthermaleng.2004.03.001 is INVALID
- 10.1007/978-3-642-23099-8 is INVALID

[editorialbot]

Wordcount for paper.md is 1206

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[tpurcell90]

Review checklist for @tpurcell90

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/thejackal360/OpenPelt-Public?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@gdetor) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• 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

Software paper

• Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
• State of the field: Do the authors describe how this software compares to other commonly-used packages?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

[tpurcell90]

@gdetor and @thejackal360 would you rather all comments be made here or in issues on the repository?

[tpurcell90]

The paper is generally well written, but there are issues with the documentation that make the using the code difficult for a new user

1. The installation instructions presented in the README only works if one has the right version of gcc (I think it has to be 8.2.1+ because of GLIBC_2.29). This is because instead of providing the source code for the modified version of ngspiceas a submodule or an external code, the repository includes libngspice.so which was compiled with gcc-9.4. This is a major limiting factor for installing the code, and I think that the ngspice library's source code should be provided, including instructions on how to compile it. Ideally this would be done automatically with pip, but that would be non-trivial to set up.

2. The README has a few typos in it, including links to the private repository for OpenPelt.

3. While the tests are automated, they are done with a seperate bash script that overrides LD_LIBRARY_PATH to include the provided libngspice.so file. If you have to compile ngspice from source this breaks the script. I'd recommend converting the existing testing protocol to use pytest

4. The provided examples and API are not enough for a newcomer to understand how to use the code. I'd include a description of the physical model that is being modeled in the examples. Improvements to the python API would also be helpful as it is currently incomplete.

I opened issues on the repository for these problems

[thejackal360]

Thank you for your feedback! We've resolved all the issues on the OpenPelt repo.

[tpurcell90]

There are still a few functions in controller.py and all of neural_network.py that are undocumented

[gdetor]

@tpurcell90 Thank you for pointing out that issue. We fixed that.

[rkurchin]

@tpurcell90, many thanks for starting your review so promptly! @danaraujocr, please don't hesitate to ask if you need any clarifications on how the process works.

[danaraujocr]

Review checklist for @danaraujocr

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/thejackal360/OpenPelt-Public?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@gdetor) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• 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

Software paper

• Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
• State of the field: Do the authors describe how this software compares to other commonly-used packages?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[tpurcell90]

All my comments have been addressed.

[rkurchin]

👋 Hi @danaraujocr, just checking in on how your review is going!

[danaraujocr]

Hi Rachel, Sorry about the delay. Had an issue with my computer and just solved it. Will continue the work later today.

[danaraujocr]

@gdetor and @thejackal360
The paper is well written, but the installation doc are still not perfectly clear. I ran a new ubuntu 20.04 installation on a virtual machine to check if the installation would run exactly as described but it didn't for minor reasons. The few things I would suggest adding/changing are:
1 - in the build_nspice.sh file a YACC command is called and those were not available in the build I used. Easily solvable. I commented on the issue opened by @tpurcell90 adding this complication.
2 - In the instructions to add the lbngspice environment variable the text suggests that one needs to copy/paste the snippet into .bashrc and what is in it is a command that does that for you. that might be confusing for some users.
3 - In the snippet that contains the code below :
$ cd OpenPelt/
$ ./build_ngspice.sh
$ pip3 (or pip) install .
I think you should only keep the last line, as the two previous lines have probably already been executed. (especially the shell script)

Other than those minor things, nothing else to add.

[gdetor]

@danaraujocr Thank you for your comments/suggestions. We updated the README file including all your suggestions.

[danaraujocr]

@rkurchin no other commentaries to make.

[rkurchin]

Thanks everyone! Authors, I'll do an editorial pass over the manuscript and send any comments shortly. In the meantime, the next steps for you are:

1. Merge any and all changes from this review into your main branch and issue a new version tag. (If you want to merge in the paper, you may, but it is not required that the actual manuscript live into the repo in perpetuity since JOSS will host it and you can simply add a badge link or whatever you like. But the actual changes to software and docs do need to be merged!)
2. Create a DOI for the contents of the repo at the same commit corresponding to that version tag, e.g. using figshare or Zenodo. Please make sure that the metadata (version number, title, author list, etc.) match those of your manuscript.
3. Post a comment here with the version number and DOI.

[rkurchin]

@editorialbot check references

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.applthermaleng.2004.03.001 is OK
- 10.1016/S0003-2670(03)00676-7 is OK
- 10.1049/el:20062442 is OK
- 10.1007/978-3-642-23099-8 is OK
- 10.1145/1731022.1731030 is OK
- 10.1109/IMTC.2000.848895 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[rkurchin]

Some small editorial comments:

• There's a weirdly-formatted citation at the end of the first paragraph in the Statement of Need, where one typesets in square brackets and the other not (broad note on citation formatting, to cite multiple sources at once, you can do e.g. [@doe99; @smith2000; @smith2004]) to get them all in one set of parentheses)
• line 29: hyphenate "several-minute" (compound adjective)
• 45: hyphenate "open-source" (ditto)
• I suggest surrounding code with `` to get monospace typesetting, e.g. for mentions of tec_plant et al.
• line 71: should be "...unlikely to be very many..."
• 74: suggest rephrasing to "...they are solved using iterative methods for systems of differential equations." (removes duplication of "solve" in same sentence)

[gdetor]

@rkurchin Thank you for the suggestions/comments. We have incorporated all your suggestions to the text. Soon we will provide the DOI and the tag.

[thejackal360]

@editorialbot set beta as version

[editorialbot]

I'm sorry @thejackal360, I'm afraid I can't do that. That's something only editors are allowed to do.

[thejackal360]

Version Number: beta
DOI: 10.5281/zenodo.6514903

Are we able to change the version to "beta" for the submission? JOSS won't let us use "@editorialbot set beta as version" since we are not editors.

[rkurchin]

@editorialbot set beta as version

[editorialbot]

Done! version is now beta

[rkurchin]

@editorialbot set 10.5281/zenodo.6514903 as archive

[editorialbot]

Done! Archive is now 10.5281/zenodo.6514903

[rkurchin]

@editorialbot generate pdf

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[rkurchin]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.applthermaleng.2004.03.001 is OK
- 10.1016/S0003-2670(03)00676-7 is OK
- 10.1049/el:20062442 is OK
- 10.1007/978-3-642-23099-8 is OK
- 10.1145/1731022.1731030 is OK
- 10.1109/IMTC.2000.848895 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#3191

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3191, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

[kyleniemeyer]

Hi @gdetor, I'm the AEIC on duty this week doing some final checks.

It looks like one reference is missing a DOI: Degrave et al. 2022. (Not sure why the automated check missed this.) Can you add this?

[gdetor]

@kyleniemeyer Thank you for pointing that out. We added the missing DOI.

[kyleniemeyer]

@editorialbot generate pdf

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[kyleniemeyer]

@editorialbot accept

[editorialbot]

Doing it live! Attempting automated processing of paper acceptance...

[editorialbot]

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

[editorialbot]

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

0. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.04306 joss-papers#3195
1. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04306
2. If everything looks good, then close this review issue.
3. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

[kyleniemeyer]

Congratulations @gdetor on your article's publication in JOSS!

Many thanks to @tpurcell90 and @danaraujocr for reviewing this, and @rkurchin for editing it.

[editorialbot]

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.04306/status.svg)](https://doi.org/10.21105/joss.04306)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.04306">
  <img src="https://joss.theoj.org/papers/10.21105/joss.04306/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.04306/status.svg
   :target: https://doi.org/10.21105/joss.04306

This is how it will look in your documentation:

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://joss.theoj.org/reviewer-signup.html
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss