Clarifications for the JOSS paper

[dpsanders]

• In the first paragraph you state that the package is for "studying photonic crystals" but not what you study about them.

• In the statement of need you then refer to eigensolutions of a crystal, but it's not clear which object you are calculating eigenproperties of.

• You mix "eigensolutions" and "eigenmodes".

• At the end of the paragraph you talk about photonic bands. Thus it just seems like some rearranging is required. But perhaps more mathematical detail about the system should be included?

• In the first reference, "hgte" should presumably be "HgTe"

• Physical review letters -> Physical Review Letters (capitalisation)

• Please check the details of the remaining references. Journals should have initial letters of each word capitalised.

Thanks!

[dpsanders]

• The Rumpf paper has no information other than a title.

[dpsanders]

• The Joannopoulos book has the wrong title.

[dpsanders]

• "Innovació n" -- remove space

[sp94]

Hi @dpsanders, thanks for taking the time to go through this

Main text

In the first paragraph you state that the package is for "studying photonic crystals" but not what you study about them.

Now reads "for solving Maxwell's equations using the Plane Wave Expansion Method in order to predict the optical properties of photonic crystals"

In the statement of need you then refer to eigensolutions of a crystal, but it's not clear which object you are calculating eigenproperties of.

Instead of "eigensolutions of a crystal" I now say "eigensolutions of Maxwell's equations for photonic crystals" to make this clearer

You mix "eigensolutions" and "eigenmodes".

I have changed the paper to say "eigensolutions" when I mean both eigenvalue+eigenmode

At the end of the paragraph you talk about photonic bands. Thus it just seems like some rearranging is required. But perhaps more mathematical detail about the system should be included?

I think "bands" may be extra jargon, so I have removed it. eg It now says "topological photonic crystals" instead of "band topology in photonic crystals". I also split the statement of need into two paragraphs to make it clearer where the comparison to existing software begins. Does it still seem like rearranging is required?

References

• hgte -> HgTE
• Physical review letters -> Physical Review Letters (capitalisation)
• Please check the details of the remaining references. Journals should have initial letters of each word capitalised.
• The Rumpf paper has no information other than a title.
  • The Rumpf reference is a PhD thesis so I have changed its bibtype to pdfthesis and added the university
• The Joannopoulos book has the wrong title.
  • added full title and edition
• "Innovació n" -- remove space

[dpsanders]

Thanks.

Another question: Have you asked for permission to include the figure from the PNAS paper? If not I think it should be removed.

[sp94]

Hi, we asked for permission already. Here is what they said when I told them we wanted to use in JOSS and the readme:

Thank you for checking. Yes, this qualifies as non-commercial use. Express permission from PNAS is not required if all of the following conditions hold true:

• The PNAS article published in 1993 to present under our standard exclusive license (we started offering two other licenses in Fall 2017)

• The requested material (whether figure, table, text extract) is original to the PNAS article (it does not contain previously published material, nor was adapted from an earlier source)

• The intended use is for noncommercial or educational purposes

If the article published between 1993 and 2008: Please include a complete citation for the original PNAS article when reusing the material, and include "Copyright (YEAR) National Academy of Sciences, U.S.A." as a copyright note.

If the article published from 2009 to present: Please include a complete citation for the original PNAS article when reusing the material (do not include a copyright note).

The paper was published 2003 so we included the full citation and also the copyright notice in the caption

[dpsanders]

OK that's great, thanks!

[sp94]

Hi @dpsanders, is there anything else to do before closing this issue?