Go to file
Marek Nečada 4e4da9d6ad Move some typedefs from groups.h to qpms_types.h
Former-commit-id: 2618edc301db95bbc383a170a9ad2047ab0275fd
2019-02-27 12:29:19 +02:00
besseltransforms Mathematica bessel transforms 2018-03-28 11:52:50 +03:00
misc Proceswfiles version with automatic file name sorting 2019-02-01 00:05:09 +02:00
notes File cleanup. 2019-02-18 15:01:15 +02:00
qpms Move some typedefs from groups.h to qpms_types.h 2019-02-27 12:29:19 +02:00
tests Rename ewald3_constants, move legacy code 2018-12-21 19:31:45 +00:00
.gitignore Doxygen for qpms_types.h; Doxyfile. 2019-02-19 17:49:18 +00:00
BUGS.rst Note smash stacking bug 2018-05-18 07:12:15 +03:00
Doxyfile Doxygen for qpms_types.h; Doxyfile. 2019-02-19 17:49:18 +00:00
README.rst Update setup script and instructions. 2019-02-27 10:44:58 +02:00
TODOs.rst Pseudovectorised version of qpms_p.vswf_yr() 2017-07-20 17:05:32 +03:00
setup.cfg Balíčkování 2016-03-27 12:56:54 +03:00
setup.py Update setup script and instructions. 2019-02-27 10:44:58 +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/index.html.