Metadata-Version: 2.1
Name: ofiber
Version: 0.8.0
Summary: Light Propagation in Optical Fibers
Home-page: https://github.com/scottprahl/ofiber
Author: Scott Prahl
Author-email: scott.prahl@oit.edu
License: MIT
Keywords: refraction,Sellmeier,modes,dispersion,graded index,gradient index,single mode,multimode,step index,erbium,waveguide,planar,cylindrical
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

ofiber
======

by Scott Prahl

.. image:: https://img.shields.io/pypi/v/ofiber?color=68CA66
   :target: https://pypi.org/project/ofiber/
   :alt: pypi

.. image:: https://img.shields.io/github/v/tag/scottprahl/ofiber?label=github&color=68CA66
   :target: https://github.com/scottprahl/ofiber
   :alt: github

.. image:: https://img.shields.io/conda/vn/conda-forge/ofiber?label=conda&color=68CA66
   :target: https://github.com/conda-forge/ofiber-feedstock
   :alt: conda

.. image:: https://zenodo.org/badge/122556263.svg
   :target: https://zenodo.org/badge/latestdoi/122556263
   :alt: doi  

|

.. image:: https://img.shields.io/github/license/scottprahl/ofiber?color=68CA66
   :target: https://github.com/scottprahl/ofiber/blob/master/LICENSE.txt
   :alt: License

.. image:: https://github.com/scottprahl/ofiber/actions/workflows/test.yaml/badge.svg
   :target: https://github.com/scottprahl/ofiber/actions/workflows/test.yaml
   :alt: Testing

.. image:: https://readthedocs.org/projects/ofiber/badge?color=68CA66
   :target: https://ofiber.readthedocs.io
   :alt: Docs

.. image:: https://img.shields.io/pypi/dm/ofiber?color=68CA66
   :target: https://pypi.org/project/ofiber/
   :alt: Downloads


-----

A set of Python modules to calculate light propagation through optical fibers following
the approach presented in `Ghatak and Thyagarajan <https://doi.org/10.1017/CBO9781139174770>`_, *An Introduction to Fiber Optics,*
Cambridge University Press (1980).

For examples and use cases, see <https://ofiber.readthedocs.io>

Installation
------------

Use ``pip``::

    pip install ofiber

or ``conda``::

    conda install -c conda-forge pygrin

or use a Jupyter notebook immediately by clicking the Google Colaboratory button below

.. image:: https://colab.research.google.com/assets/colab-badge.svg
  :target: https://colab.research.google.com/github/scottprahl/ofiber/blob/master
  :alt: Colab

License
-------

``ofiber`` is licensed under the terms of the MIT license.
