Metadata-Version: 2.4
Name: dreams
Version: 0.2.0
Summary: Differentiable T-matrix based electromagnetic scattering framework.
Keywords: python
Author: Jan David Fischbach
Author-email: Nigar Asadova <nigar.asadova@kit.edu>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: treams
Requires-Dist: jax
Requires-Dist: nlopt
Requires-Dist: equinox>=0.11.10
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest-regressions ; extra == "dev"
Requires-Dist: pandas ; extra == "dev"
Requires-Dist: line-profiler>=4.2.0 ; extra == "dev"
Requires-Dist: jupytext ; extra == "docs"
Requires-Dist: autodoc_pydantic ; extra == "docs"
Requires-Dist: matplotlib ; extra == "docs"
Requires-Dist: jupyter-book==0.15.1 ; extra == "docs"
Requires-Dist: sphinx-click ; extra == "docs"
Provides-Extra: dev
Provides-Extra: docs

# dreams 

A differentiable T-matrix-based framework for
multiple-scattering problems in nanophotonics.

It implements the T-matrix formalism in
[jax](https://github.com/google/jax), following the implementation of
[treams](https://github.com/tfp-photonics/treams).

## Installation

To install the package with pip, use

```bash
pip install dreams
```

For the development version, clone the repository:

```bash
git clone https://github.com/tfp-photonics/dreams.git
cd dreams
pip install -e ".[dev]"
```

## Usage

The tutorial is available in the documentation:
https://tfp-photonics.github.io/dreams/


## Features

- inverse design of multiple-scattering systems
- optimization of scatterer positions and radii
- support for finite and periodic arrangements

