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.2.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gradoptics-0.0.2-py3-none-any.whl (38.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gradoptics-0.0.2.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.2

File hashes

Hashes for gradoptics-0.0.2.tar.gz
Algorithm Hash digest
SHA256 6a4a45d7d34d4953de0054763522c8f849dd879e39df97456c42538bfa606df2
MD5 eeef5edf189bfbed35dd13fdf0f825a1
BLAKE2b-256 1bd748f63c0585b20b860a7df252ab56d92a62514e270ecf8df0087bb718ee5b

See more details on using hashes here.

File details

Details for the file gradoptics-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: gradoptics-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 38.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.2

File hashes

Hashes for gradoptics-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 41506b063d6e39c4fab2e474e2bff061e7734dbbd3c9094b0b4efb5b9d28b6d5
MD5 70bed77ae2ef25ca123a92103829f0fa
BLAKE2b-256 bc53e4826d94469a46e2e2944cf4b2e3f593d080807a6f61b120409dc447c8fd

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