search

NanoComp / mpb

MIT Photonic-Bands: computation of photonic band structures in periodic media
GNU General Public License v2.0
160 stars 87 forks source link

python docs for band symmetry methods #149

Closed thchr closed 1 year ago

thchr commented 2 years ago

In https://github.com/NanoComp/meep/pull/1930#issue-1126560198 I promised that I'd add Python docs for the associated functionality but never got around to it. This is just finally doing that.

At the same time, I fixed some formatting, notation, and language in the existing Scheme docs for this functionality.

PS. In case you'll find it amusing to see this functionality "in action", there's some examples in the readme of our unregistered and not-completely-aptly-named MPBUtils.jl package.

thchr commented 2 years ago

Small bump :).

This essentially just resyncs the Scheme & Python docs (and I added a warning to the Scheme docs about this not working under mbp-mpi/mpbi)

thchr commented 1 year ago

Hi @stevengj: does this seem acceptable?

As I wrote earlier, this just makes sure the feature is included in the Python documentation as well.

stevengj commented 1 year ago

Thanks !