Skip to main content

lpmodes: Python Package for Simulation Multimode Fibres

The lpmodes package is a toolkit for finding, simulating, and manipulating linearly polarized (LP) modes in step index multimode optical fibers.

Functions are provided to determine the allowed modes, compute their properties, and simulate coupling and propagation of beams.

A GUI, lpmodes_gui, allows modes to be solved, visualised and exported.

Example modes

Full documentation is on Read the docs.

Also see the examples in the examples folder.

Package Features

Functions are provided to:

  • Find all allowed modes for step index fibres (weakly guided approximation)
  • Export mode parameters as CSV
  • Calculate fraction of power in core for all modes
  • Plot amplitude or intensity of modes as numpy arrays
  • Generate a single plot of all modes as a matplotlib figure
  • Simulate coupling arbitary beams into the fibre (functions for generation of plane waves and Gaussian beams are provided)
  • Calculate coupling efficiency
  • Propagate coupled fields along a length of fibre, and visualise output amplitude and intensity

GUI

A graphical user interface allow modes to be solved, visualised and exported.

lpmodes GUI screenshot

Parameters of the fibre (NAs, core radius) and wavelength are defined in the top left. Clicking 'Find Modes' then finds solutions. The table in the centre is updated with the mode details. Power in core is not calculated immediately as this is more time consuming, click 'Find Power in Core' button to update this. Select a line of the table to display an image of that mode on the right. There are options on the left to choose the image grid size, the physical size of the image as a multiple of the core size, whether to display the amplitude or the intensity, and whether to display a circle showing the core size. The data can be exported as CSV, or the current mode image or all mode images saved as tifs using buttons on the left.

Contributing

Development is currently mainly by Mike Hughes' lab in the Applied Optics Group, Physics & Astronomy, University of Kent. I'm happy to collaborate with academic users to help your use case, and if you would like help using lpmodes for commercial purposes, consultancy is available, please contact Mike Hughes.

Help testing and developing the package is welcome, and I'm happy for this to become a more collaborate effort and share credit, please get in touch.

Requirements

  • Numpy
  • Scipy
  • Matplotlib
  • PyQT5 (GUI only)
  • PIL (GUI only)

Metadata

Release files for lpmodes 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lpmodes 1.0.1
File Size Uploaded
lpmodes-1.0.1.tar.gz 31.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lpmodes 1.0.1
File Interpreter ABI Platform
lpmodes-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 60.9 kB

Release files / lpmodes-1.0.1.tar.gz

Download URL lpmodes-1.0.1.tar.gz
Size 31.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2dee11fa590ae45527c75c647016e00311234f0a99c4fe5001ff6bed767c2699
BLAKE2b-256 checksum
How to use checksums
a00bdfe0ac19494dd33e960527441fcc1da8da832d3f3931fae6f71401f6d973
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release files / lpmodes-1.0.1-py3-none-any.whl

Download URL lpmodes-1.0.1-py3-none-any.whl
Size 29.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
689cb9c21de0e0c57827d19096ac85f4cd09495e83734e68b6266e34bd4b807c
BLAKE2b-256 checksum
How to use checksums
3ab7dcbbb5865fe241b395bfbec94b8f91849bc2dcf9bd6d41830cff608914c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page