Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PRE REVIEW]: nleis.py: A Nonlinear Electrochemical Impedance Analysis Toolbox #7349

Closed
editorialbot opened this issue Oct 14, 2024 · 36 comments
Assignees
Labels
pre-review Python TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Oct 14, 2024

Submitting author: @yuefan98 (Yuefan Ji)
Repository: https://github.com/yuefan98/nleis.py
Branch with paper.md (empty if default branch):
Version: v0.1
Editor: @lucydot
Reviewers: @alberto-battistel, @leeberty84
Managing EiC: Kevin M. Moerman

Status

status

Status badge code:

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

Author instructions

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

@yuefan98 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 editorialbot added pre-review Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials labels Oct 14, 2024
@editorialbot
Copy link
Collaborator Author

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
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.04 s (830.5 files/s, 171006.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          14           1359           1842           2527
Markdown                         6            120              0            281
YAML                             4             23              7            109
TeX                              1             11              0             92
reStructuredText                 9             74            138             67
Jupyter Notebook                 1              0            856             58
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            37           1599           2851           3169
-------------------------------------------------------------------------------

Commit count by author:

    38	Yuefan Ji
    22	yuefan98
     3	Dan Schwartz
     3	Matt Murbach
     3	allcontributors[bot]

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1149/2.0711811jes is OK
- 10.21105/joss.02349 is OK
- 10.1016/j.ijhydene.2007.05.036 is OK
- 10.1016/j.jpowsour.2020.228742 is OK
- 10.1149/1.2055011 is OK
- 10.1149/2.0301711jes is OK
- 10.1149/1945-7111/acada7 is OK
- 10.1149/1945-7111/ad15ca is OK
- 10.1149/1945-7111/ad2596 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Electrochemical impedance spectroscopy

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 1481

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

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

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

DearEIS - A GUI program for analyzing impedance spectra
Submitting author: @vyrjana
Handling editor: @jgostick (Active)
Reviewers: @Aslan-Kosakian, @mdmurbach
Similarity score: 0.7171

EchemFEM: A Firedrake-based Python package for electrochemical transport
Submitting author: @tlroy
Handling editor: @RMeli (Active)
Reviewers: @sudarshanv01, @alizma, @TomTranter
Similarity score: 0.6519

fuelcell: A Python package and graphical user interface for electrochemical data analysis
Submitting author: @samaygarg
Handling editor: @jgostick (Active)
Reviewers: @jlopata21, @shimpalee
Similarity score: 0.6489

RHEOS.jl -- A Julia Package for Rheology Data Analysis
Submitting author: @akabla
Handling editor: @jedbrown (Active)
Reviewers: @adambeall, @gbruer15, @HaoZeke
Similarity score: 0.6471

liionpack: A Python package for simulating packs of batteries with PyBaMM
Submitting author: @TomTranter
Handling editor: @timtroendle (Retired)
Reviewers: @EricaEgg, @mefuller, @yangbai90
Similarity score: 0.6435

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

@Kevin-Mattheus-Moerman
Copy link
Member

@yuefan98 Dear author, thanks for this submission. I am the AEiC on this track and here to help process the initial steps. Before we proceed, please can you have a look at the following points:

  • In your affiliations, can you spell out USA as United States of America, thanks.
  • Your README is very minimal. The following is not a strict requirement, but having separate sections e.g. on getting started, testing, documentation, etc may be good.
  • The references do not appear to render at the end of the paper. I'll ask our team to see if they can spot why that is, but in the meantime, feel free to try to diagnose it yourself too.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot invite @lucydot as editor

@editorialbot
Copy link
Collaborator Author

Invitation to edit this submission sent!

@Kevin-Mattheus-Moerman
Copy link
Member

@openjournals/dev can you see why the references are not showing in the paper? Thanks!

@yuefan98
Copy link

Hi @Kevin-Mattheus-Moerman, thanks for bringing these to my attention.

  1. Sure, I will change that accordingly
  2. We are trying to keep the README minimal while we have comprehensive documentation linked within the README using Sphinx. Here is the link for your reference. https://nleispy.readthedocs.io/en/latest/.
  3. Sure, I will try to fix it as well

@yuefan98
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

DearEIS - A GUI program for analyzing impedance spectra
Submitting author: @vyrjana
Handling editor: @jgostick (Active)
Reviewers: @Aslan-Kosakian, @mdmurbach
Similarity score: 0.7094

EchemFEM: A Firedrake-based Python package for electrochemical transport
Submitting author: @tlroy
Handling editor: @RMeli (Active)
Reviewers: @sudarshanv01, @alizma, @TomTranter
Similarity score: 0.6579

liionpack: A Python package for simulating packs of batteries with PyBaMM
Submitting author: @TomTranter
Handling editor: @timtroendle (Retired)
Reviewers: @EricaEgg, @mefuller, @yangbai90
Similarity score: 0.6577

RHEOS.jl -- A Julia Package for Rheology Data Analysis
Submitting author: @akabla
Handling editor: @jedbrown (Active)
Reviewers: @adambeall, @gbruer15, @HaoZeke
Similarity score: 0.6517

fuelcell: A Python package and graphical user interface for electrochemical data analysis
Submitting author: @samaygarg
Handling editor: @jgostick (Active)
Reviewers: @jlopata21, @shimpalee
Similarity score: 0.6485

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

@yuefan98
Copy link

Hi @Kevin-Mattheus-Moerman, I have resolved issues with references and updated the affiliation. Please let me know if there are any additional adjustments I need to make at this stage. Thanks!

@lucydot
Copy link

lucydot commented Oct 21, 2024

@editorialbot assign me as editor

@editorialbot
Copy link
Collaborator Author

Assigned! @lucydot is now the editor

@lucydot
Copy link

lucydot commented Oct 24, 2024

@editorialbot generate pdf

@lucydot
Copy link

lucydot commented Oct 24, 2024

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1149/2.0711811jes is OK
- 10.21105/joss.02349 is OK
- 10.1016/j.ijhydene.2007.05.036 is OK
- 10.1016/j.jpowsour.2020.228742 is OK
- 10.1149/1.2055011 is OK
- 10.1149/2.0301711jes is OK
- 10.1149/1945-7111/acada7 is OK
- 10.1149/1945-7111/ad15ca is OK
- 10.1149/1945-7111/ad2596 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Electrochemical impedance spectroscopy

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

DearEIS - A GUI program for analyzing impedance spectra
Submitting author: @vyrjana
Handling editor: @jgostick (Active)
Reviewers: @Aslan-Kosakian, @mdmurbach
Similarity score: 0.7118

liionpack: A Python package for simulating packs of batteries with PyBaMM
Submitting author: @TomTranter
Handling editor: @timtroendle (Retired)
Reviewers: @EricaEgg, @mefuller, @yangbai90
Similarity score: 0.6661

EchemFEM: A Firedrake-based Python package for electrochemical transport
Submitting author: @tlroy
Handling editor: @RMeli (Active)
Reviewers: @sudarshanv01, @alizma, @TomTranter
Similarity score: 0.6634

RHEOS.jl -- A Julia Package for Rheology Data Analysis
Submitting author: @akabla
Handling editor: @jedbrown (Active)
Reviewers: @adambeall, @gbruer15, @HaoZeke
Similarity score: 0.6626

fuelcell: A Python package and graphical user interface for electrochemical data analysis
Submitting author: @samaygarg
Handling editor: @jgostick (Active)
Reviewers: @jlopata21, @shimpalee
Similarity score: 0.6562

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

@lucydot
Copy link

lucydot commented Oct 24, 2024

Hi @yuefan98 👋 - I will be your editor for this submission

@yuefan98 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.

@lucydot
Copy link

lucydot commented Oct 24, 2024

I have resolved issues with references and updated the affiliation.

Confirmed, thank you.

@yuefan98
Copy link

Hi @lucydot.

Thank you for editing my submission. Here is a list of potential reviewers who have already agreed to review for JOSS with relevant expertise.

  • larsenkg
  • alberto-battistel
  • leeberty84
  • BradyPlanden
  • DEARLIBS
  • yaomz16
  • ericfell
  • mefuller
  • sudarshanv01

@lucydot
Copy link

lucydot commented Oct 28, 2024

@larsenkg @alberto-battistel @leeberty84 - hello 👋 - are you available to review this JOSS submission?

@leeberty84
Copy link

@larsenkg @alberto-battistel @leeberty84 - hello 👋 - are you available to review this JOSS submission?

I am available to review the submission. Please let me know. Thank you.

@alberto-battistel
Copy link

@larsenkg @alberto-battistel @leeberty84 - hello 👋 - are you available to review this JOSS submission?

I am also available.

@lucydot
Copy link

lucydot commented Nov 4, 2024

@leeberty84 @alberto-battistel - great! I will add you both as reviewers and then start the review (which will be on a new thread). There will be instructions at the top of thread for you. If you have any other questions, please just ask. We expect reviews to take 4-6 weeks, however it is an iterative procedure - a conversation between authors, reviewers and editors - so please start your review as early as you can.

@lucydot
Copy link

lucydot commented Nov 4, 2024

@editorialbot add @alberto-battistel as reviewer

@editorialbot
Copy link
Collaborator Author

@alberto-battistel added to the reviewers list!

@lucydot
Copy link

lucydot commented Nov 4, 2024

@editorialbot add @leeberty84 as reviewer

@editorialbot
Copy link
Collaborator Author

@leeberty84 added to the reviewers list!

@lucydot
Copy link

lucydot commented Nov 4, 2024

@editorialbot start review

@editorialbot
Copy link
Collaborator Author

OK, I've started the review over in #7424.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pre-review Python TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials
Projects
None yet
Development

No branches or pull requests

6 participants