Go to file
Marek Nečada 86b87c955c Fix the alternative order modematrix implementation
Former-commit-id: 7daaf636ca803565e2a72b03e1ce184ece24e4c0
2019-03-17 23:32:51 +00:00
besseltransforms Mathematica bessel transforms 2018-03-28 11:52:50 +03:00
misc Fix lowest SV index finding 2019-03-14 01:34:04 +02:00
notes File cleanup. 2019-02-18 15:01:15 +02:00
qpms Fix the alternative order modematrix implementation 2019-03-17 23:32:51 +00:00
tests Fix the alternative order modematrix implementation 2019-03-17 23:32:51 +00:00
.gitignore scatsystem.h new prototype drafts and misc. 2019-03-07 07:10:43 +00:00
BUGS.rst Note smash stacking bug 2018-05-18 07:12:15 +03:00
Doxyfile Doxyfile and README updates. 2019-02-27 13:00:46 +02:00
README.rst Doxyfile and README updates. 2019-02-27 13:00:46 +02:00
TODOs.rst scatsys orbit base generator 2019-03-07 04:46:19 +00:00
setup.cfg Balíčkování 2016-03-27 12:56:54 +03:00
setup.py Some useful ScatteringSystem class functionality. 2019-03-13 22:35:35 +02:00

README.rst

Quantum photonic multiple scattering

TODO description

Installation

The package depends on several python modules and GSL (>= 2.0). The python module dependencies should be installed automatically when running the installation script. If you have a recent enough OS, you can get GSL easily from the repositories; on Debian and derivatives, just run apt-get install libgsl-dev under root. Alternatively, you can get the source get the source and compile it yourself.

After GSL is installed, you can install qpms to your local python library using:

python3 setup.py install --user

If GSL is not installed the standard library path on your system, you might need to pass it to the installation script using the LD_LIBRARY_PATH environment variable.

Documentation

Documentation of QPMS is a work in progress. Most of the newer code is documented using doxygen comments. To build the documentation, just run doxygen in the root directory; the documentation will then be found in docs/html/index.html.

Of course, the prerequisite of this is having doxygen installed. If you don't, you will probably find it easily in your OS's repositories. On Debian and derivatives, simply run apt-get install doxygen under root.