.. |release_badge| image:: https://img.shields.io/endpoint?url=https://gitlab.com/gyptis/gyptis/-/jobs/artifacts/master/raw/logobadge.json?job=badge
:target: https://gitlab.com/gyptis/gyptis/-/releases
:alt: Release
.. |GL_CI| image:: https://img.shields.io/gitlab/pipeline/gyptis/gyptis/master?logo=gitlab&labelColor=grey&style=for-the-badge
:target: https://gitlab.com/gyptis/gyptis/commits/master
:alt: pipeline status
.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/gyptis?logo=conda-forge&color=CD5C5C&logoColor=white&style=for-the-badge
:target: https://anaconda.org/conda-forge/gyptis
:alt: Conda (channel only)
.. |conda_dl| image:: https://img.shields.io/conda/dn/conda-forge/gyptis?logo=conda-forge&logoColor=white&style=for-the-badge
:alt: Conda
.. |conda_platform| image:: https://img.shields.io/conda/pn/conda-forge/gyptis?logo=conda-forge&logoColor=white&style=for-the-badge
:alt: Conda
.. |pip| image:: https://img.shields.io/pypi/v/gyptis?color=blue&logo=pypi&logoColor=e9d672&style=for-the-badge
:target: https://pypi.org/project/gyptis/
:alt: PyPI
.. |pip_dl| image:: https://img.shields.io/pypi/dm/gyptis?logo=pypi&logoColor=e9d672&style=for-the-badge
:alt: PyPI - Downloads
.. |pip_status| image:: https://img.shields.io/pypi/status/gyptis?logo=pypi&logoColor=e9d672&style=for-the-badge
:alt: PyPI - Status
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=e9d672&style=for-the-badge
:alt: Code style: black
.. |coverage| image:: https://img.shields.io/gitlab/coverage/gyptis/gyptis/master?logo=python&logoColor=e9d672&style=for-the-badge
:target: https://gitlab.com/gyptis/gyptis/commits/master
:alt: coverage report
.. |maintainability| image:: https://img.shields.io/codeclimate/maintainability/benvial/gyptis?logo=code-climate&style=for-the-badge
:target: https://codeclimate.com/github/benvial/gyptis
:alt: Code Climate maintainability
.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.4938573-5fadad?logo=google-scholar&logoColor=ffffff&style=for-the-badge
:target: https://doi.org/10.5281/zenodo.4938573
.. |licence| image:: https://img.shields.io/badge/license-MIT-blue?color=bb798f&logo=open-access&logoColor=white&style=for-the-badge
:target: https://gitlab.com/gyptis/gyptis/-/blob/master/LICENCE.txt
:alt: license
+----------------------+----------------------+----------------------+
| Release | |release_badge| |
+----------------------+----------------------+----------------------+
| Deployment | |pip| | |conda| |
+----------------------+----------------------+----------------------+
| Build Status | |GL_CI| |
+----------------------+----------------------+----------------------+
| Metrics | |coverage| | |maintainability| |
+----------------------+----------------------+----------------------+
| Activity | |pip_dl| | |conda_dl| |
+----------------------+----------------------+----------------------+
| Citation | |zenodo| |
+----------------------+----------------------+----------------------+
| License | |licence| |
+----------------------+----------------------+----------------------+
| Formatter | |black| |
+----------------------+----------------------+----------------------+
.. inclusion-marker-badges
GYPTIS
======
Computational Photonics in Python
---------------------------------
https://gyptis.gitlab.io
.. image:: https://gitlab.com/gyptis/gyptis/-/raw/master/docs/_assets/landing.png
:align: center
:alt: 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
------------
.. inclusion-marker-install-start
Conda
~~~~~
The easiest way is using `conda <https://www.anaconda.com/>`_.
First, add conda-forge to your channels with:
.. code-block:: bash
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:
.. code-block:: bash
conda install gyptis
Alternatively, we provide an `environment.yml <https://gitlab.com/gyptis/gyptis/-/blob/master/environment.yml>`_
file with all the dependencies for the master branch. First create the environment:
.. code-block:: bash
conda env create -f environment.yml
and then activate it with
.. code-block:: bash
conda activate gyptis
See the `github repository <https://github.com/conda-forge/gyptis-feedstock/>`_
where development happens for conda-forge.
Pipy
~~~~
The package is `available on pipy <https://pypi.org/project/gyptis/>`_.
To install, use:
.. code-block:: bash
pip install gyptis
.. note::
This does not install FeniCS, which should be built separately
(see `instructions <https://fenicsproject.org/download/>`_)
Docker
~~~~~~
Prebuilt container images are available at `DockerHub <https://hub.docker.com/r/gyptis/gyptis>`_
A quick way of testing is to get the installation script
.. code-block:: bash
curl -s https://gyptis.gitlab.io/get | bash
You will then be able to run the container with
.. code-block:: bash
gyptis run
Alternatively, you can pull the docker image
.. code-block:: bash
docker pull gyptis/gyptis:latest
To run the image, use
.. code-block:: bash
docker run -it gyptis/gyptis:latest
From source
~~~~~~~~~~~~
.. code-block:: bash
git clone https://gitlab.com/gyptis/gyptis.git
cd gyptis && pip install -e .
.. inclusion-marker-install-end
Documentation and examples
--------------------------
See the `documentation website <https://gyptis.gitlab.io>`_.
A good starting point is to look at `examples of application <https://gyptis.gitlab.io/examples/index.html>`_
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 <https://gitlab.com/gyptis/gyptis/-/blob/master/LICENSE.txt>`_.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/gyptis/gyptis",
"name": "gyptis",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "finite element method,diffraction,scattering,optics,photonics,metamaterials,modal analysis",
"author": "Benjamin Vial",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/57/46/cac4abcbc3eaa15b01f30f09f9906a0ebb102ef049c2e02d1d7d00af6b74/gyptis-1.0.2.tar.gz",
"platform": null,
"description": "\n\n.. |release_badge| image:: https://img.shields.io/endpoint?url=https://gitlab.com/gyptis/gyptis/-/jobs/artifacts/master/raw/logobadge.json?job=badge\n :target: https://gitlab.com/gyptis/gyptis/-/releases\n :alt: Release\n\n.. |GL_CI| image:: https://img.shields.io/gitlab/pipeline/gyptis/gyptis/master?logo=gitlab&labelColor=grey&style=for-the-badge\n :target: https://gitlab.com/gyptis/gyptis/commits/master\n :alt: pipeline status\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/gyptis?logo=conda-forge&color=CD5C5C&logoColor=white&style=for-the-badge \n :target: https://anaconda.org/conda-forge/gyptis\n :alt: Conda (channel only)\n\n.. |conda_dl| image:: https://img.shields.io/conda/dn/conda-forge/gyptis?logo=conda-forge&logoColor=white&style=for-the-badge\n :alt: Conda\n\n.. |conda_platform| image:: https://img.shields.io/conda/pn/conda-forge/gyptis?logo=conda-forge&logoColor=white&style=for-the-badge\n :alt: Conda\n\n\n.. |pip| image:: https://img.shields.io/pypi/v/gyptis?color=blue&logo=pypi&logoColor=e9d672&style=for-the-badge\n :target: https://pypi.org/project/gyptis/\n :alt: PyPI\n \n.. |pip_dl| image:: https://img.shields.io/pypi/dm/gyptis?logo=pypi&logoColor=e9d672&style=for-the-badge \n :alt: PyPI - Downloads\n \n.. |pip_status| image:: https://img.shields.io/pypi/status/gyptis?logo=pypi&logoColor=e9d672&style=for-the-badge \n :alt: PyPI - Status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=e9d672&style=for-the-badge\n :alt: Code style: black\n \n.. |coverage| image:: https://img.shields.io/gitlab/coverage/gyptis/gyptis/master?logo=python&logoColor=e9d672&style=for-the-badge\n :target: https://gitlab.com/gyptis/gyptis/commits/master\n :alt: coverage report \n\n.. |maintainability| image:: https://img.shields.io/codeclimate/maintainability/benvial/gyptis?logo=code-climate&style=for-the-badge \n :target: https://codeclimate.com/github/benvial/gyptis\n :alt: Code Climate maintainability\n\n.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.4938573-5fadad?logo=google-scholar&logoColor=ffffff&style=for-the-badge\n :target: https://doi.org/10.5281/zenodo.4938573\n \n.. |licence| image:: https://img.shields.io/badge/license-MIT-blue?color=bb798f&logo=open-access&logoColor=white&style=for-the-badge\n :target: https://gitlab.com/gyptis/gyptis/-/blob/master/LICENCE.txt\n :alt: license\n \n+----------------------+----------------------+----------------------+\n| Release | |release_badge| |\n+----------------------+----------------------+----------------------+\n| Deployment | |pip| | |conda| |\n+----------------------+----------------------+----------------------+\n| Build Status | |GL_CI| |\n+----------------------+----------------------+----------------------+\n| Metrics | |coverage| | |maintainability| |\n+----------------------+----------------------+----------------------+\n| Activity | |pip_dl| | |conda_dl| |\n+----------------------+----------------------+----------------------+\n| Citation | |zenodo| |\n+----------------------+----------------------+----------------------+\n| License | |licence| |\n+----------------------+----------------------+----------------------+\n| Formatter | |black| |\n+----------------------+----------------------+----------------------+\n\n\n\n\n\n.. inclusion-marker-badges\n\nGYPTIS\n======\n\nComputational Photonics in Python\n---------------------------------\n\nhttps://gyptis.gitlab.io\n\n.. image:: https://gitlab.com/gyptis/gyptis/-/raw/master/docs/_assets/landing.png\n :align: center\n :alt: landing\n\n\nGyptis is a package to solve Maxwell's equations with the finite element method. \nIt includes predefined models and setup commonly used in Photonics.\n\n\n\nInstallation\n------------\n\n.. inclusion-marker-install-start\n\nConda\n~~~~~\n\nThe easiest way is using `conda <https://www.anaconda.com/>`_. \nFirst, add conda-forge to your channels with:\n\n.. code-block:: bash\n \n conda config --add channels conda-forge\n conda config --set channel_priority strict\n\nOnce the conda-forge channel has been enabled, gyptis can be installed with:\n\n.. code-block:: bash\n \n conda install gyptis\n\n\nAlternatively, we provide an `environment.yml <https://gitlab.com/gyptis/gyptis/-/blob/master/environment.yml>`_ \nfile with all the dependencies for the master branch. First create the environment:\n\n.. code-block:: bash\n\n conda env create -f environment.yml\n\nand then activate it with \n\n.. code-block:: bash\n\n conda activate gyptis\n \n\nSee the `github repository <https://github.com/conda-forge/gyptis-feedstock/>`_ \nwhere development happens for conda-forge.\n \n\nPipy\n~~~~\n\nThe package is `available on pipy <https://pypi.org/project/gyptis/>`_. \nTo install, use:\n\n\n.. code-block:: bash\n\n pip install gyptis\n \n\n.. note::\n This does not install FeniCS, which should be built separately \n (see `instructions <https://fenicsproject.org/download/>`_) \n\n\nDocker\n~~~~~~\n\nPrebuilt container images are available at `DockerHub <https://hub.docker.com/r/gyptis/gyptis>`_\n\nA quick way of testing is to get the installation script\n\n.. code-block:: bash\n\n curl -s https://gyptis.gitlab.io/get | bash\n \n\nYou will then be able to run the container with \n\n.. code-block:: bash\n\n gyptis run\n\n\nAlternatively, you can pull the docker image\n\n.. code-block:: bash\n\n docker pull gyptis/gyptis:latest\n \n \nTo run the image, use\n\n.. code-block:: bash\n\n docker run -it gyptis/gyptis:latest\n \n \n\nFrom source\n~~~~~~~~~~~~\n\n.. code-block:: bash\n\n git clone https://gitlab.com/gyptis/gyptis.git\n cd gyptis && pip install -e .\n \n \n \n.. inclusion-marker-install-end\n\n\nDocumentation and examples\n--------------------------\n\nSee the `documentation website <https://gyptis.gitlab.io>`_. \nA good starting point is to look at `examples of application <https://gyptis.gitlab.io/examples/index.html>`_ \nfor typical problems encountered in photonics.\n\n\nContributing\n------------\n\nPull requests are welcome. For major changes, please open an issue first \nto discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n\nLicense\n-------\n\nMIT, see `LICENSE.txt <https://gitlab.com/gyptis/gyptis/-/blob/master/LICENSE.txt>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Computational Photonics in Python",
"version": "1.0.2",
"project_urls": {
"Code": "https://gitlab.com/gyptis/gyptis",
"Documentation": "https://gyptis.gitlab.io",
"Homepage": "https://gitlab.com/gyptis/gyptis",
"Issues": "https://gitlab.com/gyptis/gyptis/issues"
},
"split_keywords": [
"finite element method",
"diffraction",
"scattering",
"optics",
"photonics",
"metamaterials",
"modal analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3861b840ed086974ab1a177ebea5b8eff611ee1e5e959d5a9e633d1b081a6a76",
"md5": "b24429cd07a5e69db9d50310e61a94d9",
"sha256": "1354efba27c8e64b019ad7f85c6a59a05f3e6a0005f7ab1e0eb1a319145e2521"
},
"downloads": -1,
"filename": "gyptis-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b24429cd07a5e69db9d50310e61a94d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 89394,
"upload_time": "2023-11-29T18:09:55",
"upload_time_iso_8601": "2023-11-29T18:09:55.833301Z",
"url": "https://files.pythonhosted.org/packages/38/61/b840ed086974ab1a177ebea5b8eff611ee1e5e959d5a9e633d1b081a6a76/gyptis-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5746cac4abcbc3eaa15b01f30f09f9906a0ebb102ef049c2e02d1d7d00af6b74",
"md5": "a98192c47016131755f953c9fb302763",
"sha256": "d4f3ee789ac643e21f73eda3a4944fc7be39c62f6f3417524b2dbc18209e2a62"
},
"downloads": -1,
"filename": "gyptis-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "a98192c47016131755f953c9fb302763",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 76328,
"upload_time": "2023-11-29T18:09:58",
"upload_time_iso_8601": "2023-11-29T18:09:58.138769Z",
"url": "https://files.pythonhosted.org/packages/57/46/cac4abcbc3eaa15b01f30f09f9906a0ebb102ef049c2e02d1d7d00af6b74/gyptis-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 18:09:58",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "gyptis",
"gitlab_project": "gyptis",
"lcname": "gyptis"
}
JSON