.. refidx documentation main file

=========
refidx
=========

.. image:: https://img.shields.io/endpoint?url=https://gitlab.com/benvial/refidx/-/jobs/artifacts/main/raw/logobadge.json?job=badge&labelColor=8f8f8f
  :target: https://gitlab.com/benvial/refidx/-/releases
  :alt: Release
  


.. image:: https://img.shields.io/gitlab/pipeline-status/benvial/refidx?branch=main&logo=gitlab&labelColor=dedede&logoColor=ffffff&style=for-the-badge
  :target: https://gitlab.com/benvial/refidx/commits/main
  :alt: pipeline status
   
   
.. image:: https://img.shields.io/gitlab/coverage/benvial/refidx/main?logo=python&logoColor=e9d672&style=for-the-badge
 :target: https://benvial.gitlab.io/refidx/coverage.html
 :alt: coverage report 
 
.. image:: https://img.shields.io/pypi/v/refidx?logo=python&logoColor=e9d672&style=for-the-badge
  :target: https://pypi.org/project/refidx/
  :alt: pypi
  
.. image:: https://img.shields.io/pypi/dm/refidx?logo=python&logoColor=e9d672&style=for-the-badge
 :target: https://pypi.org/project/refidx/
 :alt: pypi-dl

.. image:: https://img.shields.io/badge/code%20style-black-dedede.svg?logo=python&logoColor=e9d672&style=for-the-badge
  :target: https://black.readthedocs.io/en/stable/
  :alt: Code style: black

.. image:: https://img.shields.io/badge/license-GPLv3-blue?color=5faa9c&logo=open-access&logoColor=white&style=for-the-badge
  :target: https://gitlab.com/benvial/refidx/-/blob/main/LICENSE.txt
  :alt: license 
  


Welcome! This is the documentation for ``refidx`` |release|, last updated on |today|.

``refidx`` is a package to get the refractive index of a material at a given wavelength
from the refractiveindex.info_ database.

.. _refractiveindex.info:
   https://refractiveindex.info/

.. toctree::
   :maxdepth: 2
   :caption: Quickstart
   :hidden:
   
   quickstart
   
   
.. toctree::
   :maxdepth: 2
   :caption: Examples
   :hidden:

   auto_examples/index

   
   
.. toctree::
  :maxdepth: 2
  :caption: API reference:
  :hidden:
  
  source/modules
  coverage
  idx