Data

Tools

Indexes

Applications

Experiments

Open Source Science

protis

Plane Wave Expansion method for photonic crystals. Mirror of https://gitlab.com/protis/protis

https://github.com/benvial/protis

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.9%) to scientific vocabulary

Keywords

computational-electromagnetics photonic-crystals plane-wave-expansion
Last synced: 6 months ago · JSON representation

Repository

Plane Wave Expansion method for photonic crystals. Mirror of https://gitlab.com/protis/protis

Basic Info
  • Host: GitHub
  • Owner: benvial
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://protis.gitlab.io
  • Size: 3.79 MB
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 2
  • Open Issues: 0
  • Releases: 0
Topics
computational-electromagnetics photonic-crystals plane-wave-expansion
Created about 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Zenodo

README.rst 

.. |release_badge| image:: https://img.shields.io/endpoint?url=https://gitlab.com/protis/protis/-/jobs/artifacts/main/raw/logobadge.json?job=badge
  :target: https://gitlab.com/protis/protis/-/releases
  :alt: Release

.. |GL_CI| image:: https://img.shields.io/gitlab/pipeline/protis/protis/main?logo=gitlab&labelColor=grey&style=for-the-badge
  :target: https://gitlab.com/protis/protis/commits/main
  :alt: pipeline status

.. .. |conda| image:: https://img.shields.io/conda/vn/conda-forge/protis?logo=conda-forge&color=CD5C5C&logoColor=white&style=for-the-badge   
..   :target: https://anaconda.org/conda-forge/protis
..   :alt: Conda (channel only)

.. .. |conda_dl| image:: https://img.shields.io/conda/dn/conda-forge/protis?logo=conda-forge&logoColor=white&style=for-the-badge
..   :alt: Conda

.. .. |conda_platform| image:: https://img.shields.io/conda/pn/conda-forge/protis?logo=conda-forge&logoColor=white&style=for-the-badge
..   :alt: Conda


.. |pip| image:: https://img.shields.io/pypi/v/protis?color=blue&logo=pypi&logoColor=e9d672&style=for-the-badge
  :target: https://pypi.org/project/protis/
  :alt: PyPI
  
.. |pip_dl| image:: https://img.shields.io/pypi/dm/protis?logo=pypi&logoColor=e9d672&style=for-the-badge   
  :alt: PyPI - Downloads
   
.. |pip_status| image:: https://img.shields.io/pypi/status/protis?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/protis/protis/main?logo=python&logoColor=e9d672&style=for-the-badge
  :target: https://gitlab.com/protis/protis/commits/main
  :alt: coverage report 
  
.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.6636140-dd7d54?logo=google-scholar&logoColor=dd7d54&style=for-the-badge
  :target: https://doi.org/10.5281/zenodo.6636140
 
.. |licence| image:: https://img.shields.io/badge/license-GPLv3-blue?color=dd7d54&logo=open-access&logoColor=dd7d54&style=for-the-badge
  :target: https://gitlab.com/protis/protis/-/blob/main/LICENCE.txt
  :alt: license

+----------------------+----------------------+----------------------+
| Release              |            |release_badge|                  |
+----------------------+----------------------+----------------------+
| Deployment           |                   |pip|                     |
+----------------------+----------------------+----------------------+
| Build Status         |            |GL_CI|                          |
+----------------------+----------------------+----------------------+
| Metrics              |                |coverage|                   |
+----------------------+----------------------+----------------------+
| Activity             |                  |pip_dl|                   |
+----------------------+----------------------+----------------------+
| Citation             |           |zenodo|                          |
+----------------------+----------------------+----------------------+
| License              |           |licence|                         |
+----------------------+----------------------+----------------------+
| Formatter            |           |black|                           |
+----------------------+----------------------+----------------------+



.. inclusion-marker-badges

=============================================================
protis: Plane wave expansion method for photonic crystals
=============================================================


.. inclusion-marker-install-start

Installation
============

From pypi
---------

The package is available on `pypi `_.
To install, simply use:

.. code-block:: bash

  pip install protis


From sources
-------------

Sources are available on `gitlab `_. First
clone the repository and install with ``pip``:

.. code-block:: bash

  git clone https://gitlab.com/protis/protis.git
  cd protis
  pip install -e .


.. inclusion-marker-install-end


Documentation
=============

The reference documentation and examples can be found on the
`project website `_.


License
=======


.. inclusion-marker-license-start

This software is published under the `GPLv3 license `_.


.. inclusion-marker-license-end

Owner

  • Name: Benjamin Vial
  • Login: benvial
  • Kind: user
  • Location: London
  • Company: @imperial

I am a Research Associate interested in wave physics, metamaterials and numerical methods.

GitHub Events

Total
  • Watch event: 4
  • Push event: 13
Last Year
  • Watch event: 4
  • Push event: 13

Dependencies

dev/requirements.txt pypi
  • black * development
  • build * development
  • flake8 * development
  • isort * development
  • pip * development
  • pydocstyle * development
  • pylint * development
  • pylint-json2html * development
  • python-gitlab * development
  • radon * development
  • setuptools * development
  • twine * development
  • wheel * development
doc/requirements.txt pypi
  • beautifulsoup4 *
  • ipyvtklink *
  • jupyter-sphinx *
  • matplotlib *
  • memory_profiler *
  • numpydoc *
  • pydata-sphinx-theme *
  • pythreejs *
  • sphinx *
  • sphinx-copybutton *
  • sphinx-thebe *
  • sphinx_gallery *
  • sphinxcontrib-bibtex *
  • sphinxcontrib-jquery *
  • sphinxcontrib-svg2pdfconverter *
environment.yml pypi
pyproject.toml pypi
test/requirements.txt pypi
  • coverage * test
  • pytest * test
  • pytest-cov * test
  • pytest-datadir * test
  • pytest-sugar * test
  • pytest-xdist * test