[PRE REVIEW]: AutoBZ.jl: automatic, adaptive Brillouin zone integration using Wannier interpolation

[editorialbot]

Submitting author: !--author-handle-->@lxvm<!--end-author-handle-- (Lorenzo Van Munoz) Repository: https://github.com/lxvm/AutoBZ.jl Branch with paper.md (empty if default branch): joss Version: v0.5.4 Editor: !--editor-->@rkurchin<!--end-editor-- Reviewers: @mamunm, @Luthaf Managing EiC: Kevin M. Moerman

Status

Status badge code:

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

Author instructions

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

@lxvm 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]

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]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.07 s (1172.7 files/s, 130777.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Julia                           53            765           1119           3705
TOML                             4            288              1           1324
Markdown                        14            139              0            866
TeX                              1             17              0            222
YAML                             5              9              9            123
-------------------------------------------------------------------------------
SUM:                            77           1218           1129           6240
-------------------------------------------------------------------------------

Commit count by author:

   476  lxvm
    14  Lorenzo Van Munoz
     7  Lorenzo X. Van Muñoz
     4  phibeck
     1  Jason Kaye
     1  Sophie Beck
     1  jasonkaye

[editorialbot]

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

OK DOIs

- 10.1063/1.5144261 is OK
- 10.1016/j.cpc.2020.107778 is OK
- 10.21468/SciPostPhys.10.5.117 is OK
- 10.1016/j.cpc.2016.03.014 is OK
- 10.1137/141000671 is OK
- 10.1103/RevModPhys.68.13 is OK
- 10.1088/2399-6528/ab2937 is OK
- 10.4208/cicp.OA-2021-0094 is OK
- 10.21468/SciPostPhys.15.2.062 is OK
- 10.3389/fchem.2019.00106 is OK
- 10.1016/j.cpc.2007.11.016 is OK
- 10.1038/s41524-021-00498-5 is OK
- 10.1038/s41524-020-0312-y is OK

MISSING DOIs

- No DOI given, and none found for title: High-order and adaptive optical conductivity calcu...
- No DOI given, and none found for title: AutoBZCore.Jl: Wannier Interpolation and Intergrat...
- No DOI given, and none found for title: FourierSeriesEvaluators.Jl: Fourier Series Evaluat...
- No DOI given, and none found for title: HChebInterp.Jl: Multi-dimensional h-Adaptive Cheby...
- No DOI given, and none found for title: NonlinearSolve. jl: High-Performance and Robust So...

INVALID DOIs

- None

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 868

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

IFermi: A python library for Fermi surface generation and analysis Submitting author: @utf Handling editor: @danielskatz (Active) Reviewers: @arosen93, @lucydot Similarity score: 0.7291

HofstadterTools: A Python package for analyzing the Hofstadter model Submitting author: @bartandrews Handling editor: @RMeli (Active) Reviewers: @AlexBuccheri, @katherineding Similarity score: 0.7267

ModeCouplingTheory.jl: A solver for mode-coupling-theory-like integro-differential equations Submitting author: @IlianPihlajamaa Handling editor: @mstimberg (Active) Reviewers: @epspebble, @dawbarton Similarity score: 0.7177

SphericalScattering: A Julia Package for Electromagnetic Scattering from Spherical Objects Submitting author: @HoBeZwe Handling editor: @pdebuyl (Active) Reviewers: @iliarasskazov, @berquist Similarity score: 0.7169

Peacock.jl: Photonic crystals in Julia Submitting author: @sp94 Handling editor: @dpsanders (Retired) Reviewers: @mlxd, @nmoran Similarity score: 0.7140

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

@editorialbot invite @zhubonan as editor

[editorialbot]

Invitation to edit this submission sent!

[rkurchin]

(@zhubonan, if you don't want to take another one right now, I'm happy to edit for this one if needed!)

[lxvm]

@editorialbot commands

[editorialbot]

Hello @lxvm, here are the things you can ask me to do:

# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Get a link to the complete list of reviewers
@editorialbot list reviewers

[lxvm]

Hi, I would like to rename this submission to "AutoBZ.jl: automatic, adaptive Brillouin zone integration using Wannier interpolation". I have already done this in the main text, although perhaps the title of this issue could be updated? Thanks, Lorenzo

[zhubonan]

@rkurchin no problem, please feel free to take this one.

[rkurchin]

@editorialbot assign me as editor

[editorialbot]

Assigned! @rkurchin is now the editor

[rkurchin]

@lxvm renamed ✅

[rkurchin]

👋 @mamunm and/or @luthaf, would you be willing to review this submission for JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

[mamunm]

@rkurchin I'm willing to review this article. When is the deadline to submit my review report?

[rkurchin]

Great, thanks! I'll add you as a reviewer. Once we find at least one more reviewer, I will trigger the start of the review issue, which will have instructions for how to proceed. JOSS is a little different from a traditional journal, where ideally you don't submit a single "report" but rather work your way through a checklist in an interactive/conversational way, raising any concerns you have with the package authors along the way. Once the review gets started, hopefully it will become reasonably clear, but don't hesitate to let me know if you have any questions!

[rkurchin]

@editorialbot add @mamunm as reviewer

[editorialbot]

@mamunm added to the reviewers list!

[Luthaf]

Hey, I am happy to also review this package, but I'm currently on vacation and will only be able to get to it starting the last week of August/early September.

[rkurchin]

@Luthaf, that's alright – I'll plan to send you a ping to remind you at the end of the month. Thanks!

[rkurchin]

@editorialbot add @Luthaf as reviewer

[editorialbot]

@Luthaf added to the reviewers list!

[rkurchin]

@editorialbot start review

[editorialbot]

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/7080.