Skip to main content

Release

Release

Deployment

PyPI

Conda (channel only)

Build Status

pipeline status

Metrics

coverage report

Activity

PyPI - Downloads

Conda

Citation

zenodo

License

license

Formatter

Code style: black

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 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.

Metadata

Release files for gyptis 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gyptis 1.3.0
File Size Uploaded Provenance
gyptis-1.3.0.tar.gz 95.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for gyptis 1.3.0
File Interpreter ABI Platform
gyptis-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 209.2 kB

Release files / gyptis-1.3.0.tar.gz

Download URL gyptis-1.3.0.tar.gz
Size 95.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b9d193d157111cfb6359c807e2f78696e50fd78222935692d297c1033f1b66a4
BLAKE2b-256 checksum
How to use checksums
203f8179f37f37380e1f05d778bf9dc24038430fb66dc0223ef0aea154858f6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0

Release files / gyptis-1.3.0-py3-none-any.whl

Download URL gyptis-1.3.0-py3-none-any.whl
Size 114.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
87be2d76ce0b83dcd685b3d564ef78ff40bf0fff1b60ecee870db21a00c5a33c
BLAKE2b-256 checksum
How to use checksums
eb11977f05f32f5a05c7db485e03b2bbc7ce44af71da25ac5e17a0d1151d58ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0

Security for gyptis 1.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page