[REVIEW]: easyunfold: A Python package for unfolding electronic band structures

[editorialbot]

Submitting author: !--author-handle-->@zhubonan<!--end-author-handle-- (Bonan Zhu) Repository: https://github.com/SMTG-UCL/easyunfold Branch with paper.md (empty if default branch): paper Version: v0.3.5 Editor: !--editor-->@mbarzegary<!--end-editor-- Reviewers: @srmnitc, @awvwgk Archive: 10.5281/zenodo.10510884

Status

Status badge code:

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

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

@srmnitc & @awvwgk, 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 @mbarzegary 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 @srmnitc

📝 Checklist for @awvwgk

[zhubonan]

@editorialbot check references

[editorialbot]

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

OK DOIs

- 10.1038/s41586-020-2649-2 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1109/MCSE.2007.55 is OK
- 10.1103/PhysRevB.85.085201 is OK
- 10.1038/s41467-022-32669-3 is OK
- 10.1021/jacs.2c13336 is OK
- 10.1038/s41566-021-00950-4 is OK
- 10.1038/s41597-020-00638-4 is OK
- 10.1038/sdata.2016.18 is OK
- 10.1016/j.commatsci.2017.07.030 is OK
- 10.1002/adts.201900015 is OK
- 10.1021/acs.jpclett.2c02436 is OK
- 10.1021/acs.jpcc.3c05204 is OK
- 10.21105/joss.00717 is OK
- 10.1088/2515-7655/aba081 is OK
- 10.1103/PhysRevB.54.11169 is OK
- 10.1016/0927-0256(96)00008-0 is OK
- 10.1524/zkri.220.5.567.65075 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

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

[Kevin-Mattheus-Moerman]

@zhubonan as an author (who happens to also be an editor) please refrain from using the editor commands here.

[Kevin-Mattheus-Moerman]

@editorialbot set 10.5281/zenodo.10510884 as archive

[editorialbot]

Done! archive is now 10.5281/zenodo.10510884

[Kevin-Mattheus-Moerman]

@zhubonan please edit the archive listed license to match your software license.

Note also that I updated the archive link here to use the one that relates to the new version v0.3.5.

[zhubonan]

@zhubonan as an author (who happens to also be an editor) please refrain from using the editor commands here.

Err sorry...

please edit the archive listed license to match your software license.

Sure, I have just updated the archive's licence to MIT to match the code.

[Kevin-Mattheus-Moerman]

@openjournals/dev can we make it that an author cannot run the editor command for the issue they are listed as author for (such that the commands do not work even if the submitting author happens to be a JOSS editor?)?

[Kevin-Mattheus-Moerman]

@zhubonan thanks for making those changes. I think all looks good now, so we can proceed.

[Kevin-Mattheus-Moerman]

@editorialbot accept

[editorialbot]

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

[editorialbot]

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

``` cff-version: "1.2.0" authors: - family-names: Zhu given-names: Bonan orcid: "https://orcid.org/0000-0001-5601-6130" - family-names: Kavanagh given-names: Seán R. orcid: "https://orcid.org/0000-0003-4577-9647" - family-names: Scanlon given-names: David orcid: "https://orcid.org/0000-0001-9174-8601" doi: 10.5281/zenodo.10510884 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Zhu given-names: Bonan orcid: "https://orcid.org/0000-0001-5601-6130" - family-names: Kavanagh given-names: Seán R. orcid: "https://orcid.org/0000-0003-4577-9647" - family-names: Scanlon given-names: David orcid: "https://orcid.org/0000-0001-9174-8601" date-published: 2024-01-15 doi: 10.21105/joss.05974 issn: 2475-9066 issue: 93 journal: Journal of Open Source Software publisher: name: Open Journals start: 5974 title: "easyunfold: A Python package for unfolding electronic band structures" type: article url: "https://joss.theoj.org/papers/10.21105/joss.05974" volume: 9 title: "easyunfold: A Python package for unfolding electronic band structures" ```

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

[editorialbot]

🐘🐘🐘 👉 Toot 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 :point_right: https://github.com/openjournals/joss-papers/pull/4910
1. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05974
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...

[Kevin-Mattheus-Moerman]

@zhubonan congratulations on this JOSS paper!!!

Thanks for editing @mbarzegary !!

And a special thanks to the reviewers: @srmnitc, @awvwgk !!

[editorialbot]

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

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.05974/status.svg)](https://doi.org/10.21105/joss.05974)

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

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

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://reviewers.joss.theoj.org/join
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

[arfon]

@openjournals/dev can we make it that an author cannot run the editor command for the issue they are listed as author for (such that the commands do not work even if the submitting author happens to be a JOSS editor?)?

I understand the request, but I think this is best handled with training/guidelines rather than code.