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]: TEMPO: A Python Package for Time Evolution of Pulse Sequences in QuTiP #7709

Open
editorialbot opened this issue Jan 23, 2025 · 8 comments
Labels
pre-review Python TeX Track: 3 (PE) Physics and Engineering waitlisted Submissions in the JOSS backlog due to reduced service mode.

Comments

@editorialbot
Copy link
Collaborator

Submitting author: @oonjnertzern (Jner Tzern Oon)
Repository: https://github.com/hakalasonja/TEMPO
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: Pending
Reviewers: Pending
Managing EiC: Kyle Niemeyer

Status

status

Status badge code:

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

Author instructions

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

@oonjnertzern 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: 3 (PE) Physics and Engineering labels Jan 23, 2025
@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

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

✅ OK DOIs

- 10.1016/j.cpc.2012.02.021 is OK
- 10.1016/j.cpc.2012.11.019 is OK
- 10.1016/s1049-250x(01)80063-x is OK
- 10.1371/journal.pone.0208561 is OK
- 10.1002/9780470034590.emrstm1521 is OK
- 10.1103/revmodphys.92.015004 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Spin dynamics

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.98  T=0.03 s (861.3 files/s, 191548.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          11            579            652           1592
XML                              2              0              0            691
Jupyter Notebook                 2              0           2203            400
Markdown                         2             63             23             98
TeX                              1              8              0             90
Text                             2              0              0             54
reStructuredText                 4             33             36             40
YAML                             2              8              0             33
DOS Batch                        1              8              1             26
make                             1              4              7              9
TOML                             1              1              0              7
CSS                              1              1              1              4
-------------------------------------------------------------------------------
SUM:                            30            705           2923           3044
-------------------------------------------------------------------------------

Commit count by author:

    72	hakalasonja
    49	oonjnertzern
    44	George Witt

@editorialbot
Copy link
Collaborator Author

Paper file info:

⚠️ Wordcount for paper.md is 1355

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

🔴 Failed to discover a valid open source 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:

Qiskit Dynamics: A Python package for simulating the time dynamics of quantum systems
Submitting author: @DanPuzzuoli
Handling editor: @danielskatz (Active)
Reviewers: @babreu-ncsa, @goerz, @hodgestar
Similarity score: 0.6456

SpiDy.jl: open-source Julia package for the study of non-Markovian stochastic dynamics
Submitting author: @mekise
Handling editor: @matthewfeickert (Active)
Reviewers: @Datseris, @mdavezac
Similarity score: 0.6293

libEnsemble: A complete Python toolkit for dynamic ensembles of calculations
Submitting author: @jmlarson1
Handling editor: @jbytecode (Active)
Reviewers: @jsoishi, @SergeyYakubov
Similarity score: 0.6230

DE-Sim: an object-oriented, discrete-event simulation tool for data-intensive modeling of complex systems in Python
Submitting author: @artgoldberg
Handling editor: @danielskatz (Active)
Reviewers: @gonsie, @carothersc, @yadudoc
Similarity score: 0.6194

ThermoParser: Streamlined Analysis of Thermoelectric Properties
Submitting author: @kbspooner
Handling editor: @mbarzegary (Active)
Reviewers: @enricgrau, @fnattino, @espottesmith
Similarity score: 0.6189

⚠️ 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
Copy link

Hi @oonjnertzern, thanks for your submission. Unfortunately, we have low editor availability right now, so I have to put your submission on our waitlist until someone frees up.

In the meantime, a few questions / comments:

  • In the paper, please add an explicit # References section header at the end.

  • I notice in your installation instructions in the README that you direct a conda-based environment, but then install your package using pip. Unless you specifically need conda (e.g., for a non-Python dependency), it would be simpler for folks to just install all dependencies with pip (and use venv to set up a virtual environment, for example).

    You could still include conda as alternate path for folks who use conda, but it doesn't seem necessary here (vs. a pure built-in Python installation route with venv & pip).

  • Your documentation is missing some instructions on running the test suite, as well as any examples - could you add those?

@kyleniemeyer kyleniemeyer added the waitlisted Submissions in the JOSS backlog due to reduced service mode. label Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pre-review Python TeX Track: 3 (PE) Physics and Engineering waitlisted Submissions in the JOSS backlog due to reduced service mode.
Projects
None yet
Development

No branches or pull requests

2 participants