README.md

   1 QPMS README
   2 ===========
   3
   4 QPMS is a toolkit for frequency-domain simulations of photonic systems
   5 consisting of compact objects (particles) inside a homogeneous medium. Scattering
   6 properties of the individual particles are described by their T-matrices
   7 (which can be obtained e.g. with the `scuff-tmatrix` tool from
   8 the [SCUFF-EM] suite).
   9
  10 QPMS handles the multiple scattering of electromagnetic radiation between
  11 the particles. The system can consist either of a finite number of particles
  12 or an infinite number of periodically arranged lattices (with finite number
  13 of particles in a single unit cell).
  14
  15 Features
  16 ========
  17
  18 Finite systems
  19 --------------
  20  * Computing multipole excitations *and fields (TODO)* scattered from nanoparticle
  21    clusters illuminated by plane, spherical or *cylindrical (TODO)* waves.
  22  * Finding eigenmodes.
  23  * *Calculating cross sections (TODO).*
  24  * Reducing numerical complexity of the computations by exploiting
  25    symmetries of the cluster (decomposition to irreducible representations).
  26
  27 Infinite systems (lattices)
  28 ---------------------------
  29  * 2D-periodic systems supported. (TODO 1D and 3D.)
  30  * *Calculation of transmission and reflection properties (TODO).*
  31  * Finding eigenmodes and calculating dispersion relations.
  32  * *Calculation of far-field radiation patterns of an excited array (TODO).*
  33  * Reducing numerical complexity of the computations by exploiting
  34    symmetries of the lattice (decomposition to irreducible representations).
  35
  36
  37 Installation
  38 ============
  39 The package depends on several python modules, a BLAS/LAPACK library with
  40 the respective C bindings (incl. the `lapacke.h` and `cblas.h` headers;
  41 [OpenBLAS][OpenBLAS] does have it all and is recommended) and GSL (>= 2.0).
  42 The python module dependencies should be installed automatically when running
  43 the installation script. If you have a recent enough OS,
  44 you can get GSL easily from the repositories; on Debian and derivatives,
  45 just run `apt-get install libgsl-dev` under root. Alternatively,
  46 you can [get the source and compile it yourself][GSL].
  47
  48 You also need a fresh enough version of [cmake][].
  49
  50 After GSL is installed, you can install qpms to your local python library using
  51
  52 ```{.sh}
  53   cmake -DCMAKE_INSTALL_PREFIX=${YOUR_PREFIX} .
  54   make install
  55   python3 setup.py install --user
  56 ```
  57 Above, replace `${YOUR_PREFIX}` with the path to where you want to install the shared library;
  58 you will also need to make sure that the linker can find it;
  59 on Linux, this means the path `${YOUR_PREFIX}/lib` is included in your
  60 `LIBRARY_PATH` and `LD_LIBRARY_PATH` environment variables. The same applies
  61 to the GSL and OpenBLAS dependencies: they must be installed where the
  62 installation scripts and linker can find them (setting the `C_INCLUDE_PATH` environment
  63 variable might be necessary as well).
  64
  65 Special care might need to be taken when installing QPMS in cluster environments.
  66 Specific installation instructions for Aalto University's Triton cluster
  67 can be found in a [separate document][TRITON-README].
  68
  69 Documentation
  70 =============
  71
  72 Documentation of QPMS is a work in progress. Most of the newer code
  73 is documented using [doxygen][] comments. To build the documentation, just run
  74 `doxygen`
  75 in the root directory; the documentation will then be found in
  76 `docs/html/index.html`.
  77
  78 Of course, the prerequisite of this is having doxygen installed.
  79 If you don't, you will probably find it easily in your OS's
  80 repositories. On Debian and derivatives, simply run `apt-get install doxygen`
  81 under root.
  82
  83
  84 Tutorials
  85 ---------
  86
  87   * [Infinite system (lattice) tutorial][tutorial-infinite]
  88   * [Finite system tutorial][tutorial-finite]
  89
  90 [SCUFF-EM]: https://homerreid.github.io/scuff-em-documentation/
  91 [OpenBLAS]: https://www.openblas.net/
  92 [GSL]: https://www.gnu.org/software/gsl/
  93 [cmake]: https://cmake.org
  94 [TRITON-README]: README.Triton.md
  95 [tutorial-finite]: finite_systems.md
  96 [tutorial-infinite]: lattices.md
  97 [doxygen]: http://doxygen.nl/