Skip to main content

No project description provided

Project description

Tests Documentation Status codecov Maintainability Stars License: MIT

Optiland

Table of Contents
  1. Introduction
  2. Documentation
  3. Installation
  4. Functionalities
  5. Learning Guide
  6. Roadmap
  7. License
  8. Contact

Introduction

Optiland is a Python-based, open-source lens design and analysis framework. With a simple and intuitive Python interface, Optiland enables the design, optimization, and analysis of complex optical systems, from paraxial and real raytracing to polarization, coatings, and wavefront analyses. It supports 2D/3D visualization, comprehensive tolerancing, local and global optimization, and freeform optics, among other features. Built on the speed of NumPy and SciPy, Optiland delivers computational efficiency and flexibility across a wide range of optical tasks.

Get started immediately with Optiland Tutorial #1, see the extensive Learning Guide, or read the full documentation at Read the Docs.

U.S. patent 2959100

Python code to generate this 3D visualization:

from optiland.samples.objectives import ReverseTelephoto
lens = ReverseTelephoto()
lens.draw3D()

Documentation

The full documentation for Optiland is hosted on Read the Docs.

Explore the Example Gallery for a wide range of lens designs and analyses created with Optiland.

Installation

You can install the package using pip. To do so, follow these steps:

  1. Open a terminal or command prompt.

  2. Run the following command to install the package:

    pip install optiland
    

Functionalities

  • Lens entry
  • 2D/3D visualization
  • Paraxial and aberration analyses
  • Real and paraxial ray tracing, including aspherics and freeforms
  • Polarization ray tracing
  • Real analysis functions (spot diagrams, ray aberration fans, OPD fans, distortion, PSF, MTF, etc.)
  • Glass and material catalogue (based on refractiveindex.info)
  • Design optimization (local and global)
  • Wavefront and Zernike analysis
  • Tolerancing, including sensitivity analysis and Monte Carlo methods
  • Coating and surface scatter (BSDF) analysis
  • Zemax file import

The code itself is in constant flux and new functionalities are always being added.

Learning Guide

This guide gives a step-by-step approach to learning how to use Optiland.

  1. Introduction to Optiland
  2. Real Raytracing & Analysis
  3. Aberrations
  4. Optical Path Difference (OPD), Point Spread Functions (PSF) & Modulation Transfer Function (MTF)
  5. Optimization
  6. Coatings & Polarization
  7. Advanced Optical Design
  8. Tolerancing
  9. Lens Catalogue Integration
  10. Extending Optiland
  11. Machine Learning in Optical Design
    • Tutorial 11a - Reinforcement Learning for Lens Design - Update in progress (target completion: Jan. 2025)

Roadmap

Optiland is continually evolving to provide new functionalities for optical design and analysis. Below are some of the planned features and enhancements we aim to implement in future versions:

  • GUI (based on Qt Quick)
  • Multiple Configurations (Zoom Lenses)
  • Thin Film Design and Optimization
  • Diffractive Optical Elements
  • Jones Pupils
  • Apodization Support
  • Additional Freeforms (Superconic, Zernike, etc.)
  • Image Simulation
  • Huygens PSF & MTF
  • Interferogram Analysis
  • Additional Tutorials/Examples
  • Insert your idea here...

Community Contributions

We welcome suggestions for additional features! If there's something you'd like to see in Optiland, feel free to open an issue or discussion.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Kramer Harrison - kdanielharrison@gmail.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optiland-0.1.7.tar.gz (7.7 MB view details)

Uploaded Source

Built Distribution

optiland-0.1.7-py3-none-any.whl (9.8 MB view details)

Uploaded Python 3

File details

Details for the file optiland-0.1.7.tar.gz.

File metadata

  • Download URL: optiland-0.1.7.tar.gz
  • Upload date:
  • Size: 7.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for optiland-0.1.7.tar.gz
Algorithm Hash digest
SHA256 7e8d5106ec5e01d9c20c1c89269555fe2a7f3230e9e6210d41dde8a588033ebd
MD5 c135d6c0f3d27e75f271a19f95477e4d
BLAKE2b-256 00f8447d4caae1daa272b9dd1c1185aa5b534b3bdbad8ec411d9736e85059ea6

See more details on using hashes here.

Provenance

The following attestation bundles were made for optiland-0.1.7.tar.gz:

Publisher: release.yml on HarrisonKramer/optiland

Attestations:

File details

Details for the file optiland-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: optiland-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 9.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for optiland-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8470e45e549819697e61584e8b65367bd4e377892900ced0bdecfb641fcb9de1
MD5 bdb2c2be2a3e8ee1ffd2735b6388ffe2
BLAKE2b-256 9802cd4b64b9e0409940f162014d6ed9ee78bf1629fbd06301118d9253b66014

See more details on using hashes here.

Provenance

The following attestation bundles were made for optiland-0.1.7-py3-none-any.whl:

Publisher: release.yml on HarrisonKramer/optiland

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page