Skip to main content

Computational Photonics in Python

Project description

Release pipeline status Conda (channel only) Conda Conda PyPI PyPI - Downloads PyPI - Status Code style: black coverage report Code Climate maintainability https://img.shields.io/badge/DOI-10.5281/zenodo.4938573-5fadad?logo=google-scholar&logoColor=ffffff&style=for-the-badge license

GYPTIS

Computational Photonics in Python

https://gyptis.gitlab.io

landing

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. First, add conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, gyptis can be installed with:

conda install gyptis

Alternatively, we provide an environment.yml file with all the dependencies for the master branch. First create the environment:

conda env create -f environment.yml

and then activate it with

conda activate gyptis

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

A quick way of testing is to get the installation script

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

You will then be able to run the container with

gyptis run

Alternatively, you can pull the docker image

docker pull gyptis/gyptis:latest

To run the image, use

docker run -it gyptis/gyptis:latest

Documentation and examples

See the documentation website. A good starting point is to look at examples of application for typical problems encountered in photonics.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gyptis-0.4.1.tar.gz (61.6 kB view hashes)

Uploaded source

Built Distribution

gyptis-0.4.1-py3-none-any.whl (93.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page