gyptis 0.1.4

Computational Photonics in Python

GYPTIS

Computational photonics in Python

https://gyptis.gitlab.io

Gyptis is a package to solve Maxwell’s equations with the finite element method. It is in early stage and currently being actively developed, so features might come and go.

Installation

Conda

The easiest way is using conda. We provide an environment.yml file with all the dependencies. First create the environment:

conda env create -f environment.yml

and then activate it with

conda activate gyptis

A conda-forge package is being developed and should be available soon.

Pipy

The package is available on pipy. To install, use:

pip install gyptis

Note

This does not install FeniCS, which should be built separately (see instructions)

Docker

Prebuilt container images are available at DockerHub

On quick way of testing is getting the installation script

curl -s https://gyptis.gitlab.io/get | bash

Or you can pull the docker image

docker pull gyptis/gyptis:latest

To run the image, use

docker run -it gyptis/gyptis:latest

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT, see LICENSE.txt.