lbolla / EMpy

Electromagnetic Python
MIT License
194 stars 83 forks source link

Added some docstrings to FD.py and a "guess" to VFDModeSolver #5

Closed DanHickstein closed 8 years ago

DanHickstein commented 8 years ago

I added some basic docstrings to FD.py that will hopefully help future users. Are there plans to set up documentation with Sphinx and readthedocs.org? If so, I can re-write with Sphinx-compatible cross-references between the functions.

I also added the capability to include a "guess" for the refractive index in VFDModeSolver so that it was similar to the original matlab version. I played with this a little bit, and in my situation, the modes of interest have the highest effective index anyway, so this did not change my results. I could see it being useful in certain situations.