Skip to main content

Differentiable Optics via Ray Tracing

Project description

Tests Build Status Documentation Status Contributions welcome version License: MIT

Differentiable Optics via Ray Tracing

gradoptics is a ray tracing based optical simulator built using PyTorch [1] to enable automatic differentiation.

The API is designed similar to rendering softwares, and has been heavily inspired by Physically Based Rendering (Pharr, Jakob, Humphreys) [2].

Getting Started

Getting Started

Installation

pip install gradoptics

Then, you should be ready to go!

import gradoptics as optics

Work in progress

  • Currently, some optical element normals are aligned with the optical axis -> more general orientations in progress
  • Currently, monochromatic -> no chromatic aberrations

Project History

This project was started in 2020 by Michael Kagan and Maxime Vandegar at SLAC National Accelerator Laboratory.

Feedback and Contributions

Please use issues on GitHub for reporting bugs and suggesting features (including better documentation).

We appreciate all contributions. In general, we recommend using pull requests to make changes to gradoptics.

Testing

If you modify gradoptics, please use pytest for checking your code.

pytest tests/tests.py 

Support

gradoptics was developed in the context of the MAGIS-100 experiment

References

[1] A. Paszke, S. Gross, F. Massa, A. Lerer, J. Bradbury, G. Chanan, T. Killeen, Z. Lin, N. Gimelshein, L. Antiga, et al. PyTorch: An imperative style, high-performance deep learning library. In NeurIPS, 2019.

[2] Matt Pharr, Wenzel Jakob, and Greg Humphreys. 2016. Physically Based Rendering: From Theory to Implementation (3rd ed.). Morgan Kaufmann Publishers Inc.

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

gradoptics-0.0.4.tar.gz (37.5 kB view details)

Uploaded Source

File details

Details for the file gradoptics-0.0.4.tar.gz.

File metadata

  • Download URL: gradoptics-0.0.4.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.12

File hashes

Hashes for gradoptics-0.0.4.tar.gz
Algorithm Hash digest
SHA256 bc2dfcb67fbac73ceaf21b080c7eceaec52d3ecaad7ef1b6df0dcbe5a21dfac5
MD5 817e6ba7e56bb434b6b350e3a2599d13
BLAKE2b-256 e716837918ac8fa2262384dfeb44f6232db17790bb9f2aa2eae7cdb2d2188e58

See more details on using hashes here.

Supported by

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