2016-03-27 12:56:54 +03:00
|
|
|
Quantum photonic multiple scattering
|
|
|
|
|
====================================
|
|
|
|
|
|
|
|
|
|
TODO description
|
2016-07-01 11:20:47 +03:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
============
|
2019-02-25 09:18:37 +02:00
|
|
|
The package depends on numpy, scipy, cython and GSL (>= 2.0).
|
|
|
|
|
The first three can be obtained by pip. If you have a recent enough OS,
|
|
|
|
|
you can get GSL easily from the repositories; on Debian and derivatives,
|
2019-02-25 09:52:23 +02:00
|
|
|
just run ``apt-get install libgsl-dev`` under root. Alternatively,
|
2019-02-25 09:18:37 +02:00
|
|
|
you can `get the source
|
|
|
|
|
<https://www.gnu.org/software/gsl/>`_ get the source and compile it yourself.
|
2016-07-01 11:20:47 +03:00
|
|
|
|
2019-02-25 09:18:37 +02:00
|
|
|
After all dependencies are installed, install qpms to your local python library using::
|
2016-07-01 11:20:47 +03:00
|
|
|
|
2019-02-25 09:18:37 +02:00
|
|
|
python3 setup.py install --user
|
2016-07-01 11:20:47 +03:00
|
|
|
|
2016-07-26 00:42:16 +03:00
|
|
|
|
|
|
|
|
Easiest installation ever
|
|
|
|
|
=========================
|
|
|
|
|
(Just skip those you have already installed.)
|
|
|
|
|
|
2019-02-25 09:18:37 +02:00
|
|
|
::
|
|
|
|
|
|
|
|
|
|
pip3 install --user numpy
|
|
|
|
|
pip3 install --user scipy
|
|
|
|
|
pip3 install --user cython
|
|
|
|
|
pip3 install --user git+https://github.com/moble/quaternion.git
|
|
|
|
|
pip3 install --user git+https://github.com/moble/spherical_functions.git
|
|
|
|
|
python3 setup.py install --user
|
|
|
|
|
|
2019-02-25 09:23:12 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
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``.
|
