.. |pypi-badge| image:: https://img.shields.io/pypi/v/ofiber?color=68CA66
:target: https://pypi.org/project/ofiber/
:alt: pypi
.. |github-badge| image:: https://img.shields.io/github/v/tag/scottprahl/ofiber?label=github&color=68CA66
:target: https://github.com/scottprahl/ofiber
:alt: github
.. |conda-badge| image:: https://img.shields.io/conda/vn/conda-forge/ofiber?label=conda&color=68CA66
:target: https://github.com/conda-forge/ofiber-feedstock
:alt: conda
.. |doi-badge| image:: https://zenodo.org/badge/122556263.svg
:target: https://zenodo.org/doi/10.5281/zenodo.8368598
:alt: doi
.. |license-badge| image:: https://img.shields.io/github/license/scottprahl/ofiber?color=68CA66
:target: https://github.com/scottprahl/ofiber/blob/master/LICENSE.txt
:alt: License
.. |test-badge| image:: https://github.com/scottprahl/ofiber/actions/workflows/test.yaml/badge.svg
:target: https://github.com/scottprahl/ofiber/actions/workflows/test.yaml
:alt: Testing
.. |readthedocs-badge| image:: https://readthedocs.org/projects/ofiber/badge?color=68CA66
:target: https://ofiber.readthedocs.io
:alt: Docs
.. |downloads-badge| image:: https://img.shields.io/pypi/dm/ofiber?color=68CA66
:target: https://pypi.org/project/ofiber/
:alt: Downloads
ofiber
=======
by Scott Prahl
|pypi-badge| |github-badge| |conda-badge| |doi-badge|
|license-badge| |test-badge| |readthedocs-badge| |downloads-badge|
Python code to calculate light propagation through optical fibers following
the approach presented in `Ghatak and Thyagarajan, An Introduction to Fiber Optics <https://doi.org/10.1017/CBO9781139174770>`_. Far-field fiber calculations are based on `Chen, Foundations for
Guided-Wave Optics <https://doi.org/10.1002/0470042222>`_.
Installation
-------------
Use ``pip``::
pip install ofiber
or ``conda``::
conda install -c conda-forge ofiber
Usage
-----
A few examples are shown below. For all examples, see `ofiber documentation <https://ofiber.readthedocs.io>`_
Symmetric planar waveguides
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/planarwaveguide.svg
:target: https://ofiber.readthedocs.io/en/latest/3-Planar-Waveguide-Modes.html
:align: center
:alt: Planar Waveguide
Cylindrical fibers with step index profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/stepindexmodes.svg
:target: https://ofiber.readthedocs.io/en/latest/4-Circular-Step-Index-Fiber.html
:align: center
:alt: Modes in Step Index Fiber
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/modeirradiance.svg
:target: https://ofiber.readthedocs.io/en/latest/4-Circular-Step-Index-Fiber.html
:align: center
:alt: Mode Irradiance
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/internalmodes.svg
:target: https://ofiber.readthedocs.io/en/latest/4-Circular-Step-Index-Fiber.html
:align: center
:alt: Internal Modes
Far-field emission for step index fibers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/farfieldirradiance.svg
:target: https://ofiber.readthedocs.io/en/latest/9-Far-field-irradiance.html
:align: center
:alt: Far-field Irradiance
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/theta01.svg
:target: https://ofiber.readthedocs.io/en/latest/9-Far-field-irradiance.html
:align: center
:alt: polar angle of the minimum of the central irradiance lobe
Fiber design
^^^^^^^^^^^^^
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/fiberdesign.svg
:target: https://ofiber.readthedocs.io/en/latest/6-Zero-Dispersion.html
:align: center
:alt: Fiber Design
.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/dispersion.svg
:target: https://ofiber.readthedocs.io/en/latest/6-Zero-Dispersion.html
:align: center
:alt: Dispersion
Google Colaboratory
^^^^^^^^^^^^^^^^^^^^
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/scottprahl/ofiber",
"name": "ofiber",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "refraction, Sellmeier, modes, dispersion, graded index, gradient index, single mode, multimode, step index, erbium, waveguide, planar, cylindrical",
"author": "Scott Prahl",
"author_email": "scott.prahl@oit.edu",
"download_url": "https://files.pythonhosted.org/packages/ca/ba/97dba896c988386dc52bcfe030c98bcca8e12f92010440f710b05957d73e/ofiber-0.8.1.tar.gz",
"platform": null,
"description": ".. |pypi-badge| image:: https://img.shields.io/pypi/v/ofiber?color=68CA66\n :target: https://pypi.org/project/ofiber/\n :alt: pypi\n.. |github-badge| image:: https://img.shields.io/github/v/tag/scottprahl/ofiber?label=github&color=68CA66\n :target: https://github.com/scottprahl/ofiber\n :alt: github\n.. |conda-badge| image:: https://img.shields.io/conda/vn/conda-forge/ofiber?label=conda&color=68CA66\n :target: https://github.com/conda-forge/ofiber-feedstock\n :alt: conda\n.. |doi-badge| image:: https://zenodo.org/badge/122556263.svg\n :target: https://zenodo.org/doi/10.5281/zenodo.8368598\n :alt: doi \n\n.. |license-badge| image:: https://img.shields.io/github/license/scottprahl/ofiber?color=68CA66\n :target: https://github.com/scottprahl/ofiber/blob/master/LICENSE.txt\n :alt: License\n.. |test-badge| image:: https://github.com/scottprahl/ofiber/actions/workflows/test.yaml/badge.svg\n :target: https://github.com/scottprahl/ofiber/actions/workflows/test.yaml\n :alt: Testing\n.. |readthedocs-badge| image:: https://readthedocs.org/projects/ofiber/badge?color=68CA66\n :target: https://ofiber.readthedocs.io\n :alt: Docs\n.. |downloads-badge| image:: https://img.shields.io/pypi/dm/ofiber?color=68CA66\n :target: https://pypi.org/project/ofiber/\n :alt: Downloads\n\nofiber\n=======\n\nby Scott Prahl\n\n|pypi-badge| |github-badge| |conda-badge| |doi-badge|\n\n|license-badge| |test-badge| |readthedocs-badge| |downloads-badge|\n\nPython code to calculate light propagation through optical fibers following\nthe approach presented in `Ghatak and Thyagarajan, An Introduction to Fiber Optics <https://doi.org/10.1017/CBO9781139174770>`_. Far-field fiber calculations are based on `Chen, Foundations for \nGuided-Wave Optics <https://doi.org/10.1002/0470042222>`_.\n\n\nInstallation\n-------------\n\nUse ``pip``::\n\n pip install ofiber\n\nor ``conda``::\n\n conda install -c conda-forge ofiber\n\nUsage\n-----\n\nA few examples are shown below. For all examples, see `ofiber documentation <https://ofiber.readthedocs.io>`_\n\nSymmetric planar waveguides\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/planarwaveguide.svg\n :target: https://ofiber.readthedocs.io/en/latest/3-Planar-Waveguide-Modes.html\n :align: center\n :alt: Planar Waveguide\n \nCylindrical fibers with step index profiles\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/stepindexmodes.svg\n :target: https://ofiber.readthedocs.io/en/latest/4-Circular-Step-Index-Fiber.html\n :align: center\n :alt: Modes in Step Index Fiber\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/modeirradiance.svg\n :target: https://ofiber.readthedocs.io/en/latest/4-Circular-Step-Index-Fiber.html\n :align: center\n :alt: Mode Irradiance\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/internalmodes.svg\n :target: https://ofiber.readthedocs.io/en/latest/4-Circular-Step-Index-Fiber.html\n :align: center\n :alt: Internal Modes\n\nFar-field emission for step index fibers\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/farfieldirradiance.svg\n :target: https://ofiber.readthedocs.io/en/latest/9-Far-field-irradiance.html\n :align: center\n :alt: Far-field Irradiance\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/theta01.svg\n :target: https://ofiber.readthedocs.io/en/latest/9-Far-field-irradiance.html\n :align: center\n :alt: polar angle of the minimum of the central irradiance lobe\n\nFiber design\n^^^^^^^^^^^^^\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/fiberdesign.svg\n :target: https://ofiber.readthedocs.io/en/latest/6-Zero-Dispersion.html\n :align: center\n :alt: Fiber Design\n\n.. image:: https://raw.githubusercontent.com/scottprahl/ofiber/master/docs/dispersion.svg\n :target: https://ofiber.readthedocs.io/en/latest/6-Zero-Dispersion.html\n :align: center\n :alt: Dispersion\n\nGoogle Colaboratory\n^^^^^^^^^^^^^^^^^^^^\n\nUse a Jupyter notebook immediately by clicking the Google Colaboratory button below\n\n.. image:: https://colab.research.google.com/assets/colab-badge.svg\n :target: https://colab.research.google.com/github/scottprahl/ofiber/blob/master\n :alt: Colab\n\n\nLicense\n-------\n\n``ofiber`` is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Light Propagation in Optical Fibers",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/scottprahl/ofiber"
},
"split_keywords": [
"refraction",
" sellmeier",
" modes",
" dispersion",
" graded index",
" gradient index",
" single mode",
" multimode",
" step index",
" erbium",
" waveguide",
" planar",
" cylindrical"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c9e0d3ee833c3e9527e34f56fffd38beffed32020097b8a235d32faa81af8d04",
"md5": "5a4cf3741806a349906742d20ba320d0",
"sha256": "6a5515790f3ae69f02a0c3843a6f2b30f5e57d58a999449cb49c6c2f85c4057b"
},
"downloads": -1,
"filename": "ofiber-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a4cf3741806a349906742d20ba320d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31389,
"upload_time": "2024-05-05T20:04:42",
"upload_time_iso_8601": "2024-05-05T20:04:42.843858Z",
"url": "https://files.pythonhosted.org/packages/c9/e0/d3ee833c3e9527e34f56fffd38beffed32020097b8a235d32faa81af8d04/ofiber-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "caba97dba896c988386dc52bcfe030c98bcca8e12f92010440f710b05957d73e",
"md5": "6bc3a648480fb944697ca9cbc1feaede",
"sha256": "860bc58aba6290fbb89d0ee135976243d4d564eaf87b8fd8a2ca85e0a0d95318"
},
"downloads": -1,
"filename": "ofiber-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "6bc3a648480fb944697ca9cbc1feaede",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31813,
"upload_time": "2024-05-05T20:04:44",
"upload_time_iso_8601": "2024-05-05T20:04:44.431158Z",
"url": "https://files.pythonhosted.org/packages/ca/ba/97dba896c988386dc52bcfe030c98bcca8e12f92010440f710b05957d73e/ofiber-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-05 20:04:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scottprahl",
"github_project": "ofiber",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "scipy",
"specs": []
}
],
"lcname": "ofiber"
}
JSON
