Skip to content

tfp-photonics/treams

Repository files navigation

Version PyPI License build docs doctests tests coverage

treams

The package treams provides a framework to simplify computations of the electromagnetic scattering of waves at finite and at periodic arrangements of particles based on the T-matrix method.

Installation

Installation using pip

To install the package with pip, use

pip install treams

This will make sure to also install all required dependencies (i.e. numpy and scipy). Please ignore the requirements.txt, as they only serve to instruct binder which packages to install to run the documentation notebooks interactively. If you're using the system wide installed version of python, you might consider the --user option.

Documentation

The documentation can be found at https://tfp-photonics.github.io/treams.

Publications

When using this code please cite:

D. Beutel, I. Fernandez-Corbaton, and C. Rockstuhl, treams – a T-matrix-based scattering code for nanophotonics, Comp. Phys. Commun. 297, 109076 (2024).

Other relevant publications are

Features

  • T-matrix calculations using a spherical or cylindrical wave basis set
  • Calculations in helicity and parity (TE/TM) basis
  • Scattering from clusters of particles
  • Scattering from particles and clusters arranged in 3d-, 2d-, and 1d-lattices
  • Calculation of light propagation in stratified media
  • Band calculation in crystal structures

Packages

 
 
 

Contributors