Computational Photonics in Python
Project description
Release |
||
Deployment |
||
Build Status |
||
Metrics |
||
Activity |
||
Citation |
||
License |
||
Formatter |
GYPTIS
Computational Photonics in Python
Gyptis is a package to solve Maxwell’s equations with the finite element method. It includes predefined models and setup commonly used in Photonics.
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
See the github repository where development happens for conda-forge.
Pipy
The package is available on pipy. To install, use:
pip install gyptis
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
From source
git clone https://gitlab.com/gyptis/gyptis.git
cd gyptis && pip install -e .
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.