search

phys201 / Hamiltonian-photonic-crystal

Build the Hamiltonian model to reproduce the band structure measured on photonic crytal
GNU General Public License v3.0
0 stars 1 forks source link

Documentation should document the package #24

Open vnmanoharan opened 1 year ago

vnmanoharan commented 1 year ago

Your documentation notebook should be an evolving document with instructions for the current state of the package. You've organized it more like a homework assignment, with answers to each week's prompts, but it should be focused on users of the package, not the course staff.

thaodinh98 commented 1 year ago

I rewrote the documentation with more details on how to use the package. Can you please check and let us know if there are things needed changes/improvements in documentation notebook?