{"id":21923945,"url":"https://github.com/magis-slac/gradoptics","last_synced_at":"2025-04-19T15:41:28.874Z","repository":{"id":37262458,"uuid":"393391934","full_name":"magis-slac/gradoptics","owner":"magis-slac","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-23T23:32:51.000Z","size":22396,"stargazers_count":10,"open_issues_count":2,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-11-16T21:06:42.954Z","etag":null,"topics":["differentiable","machine-learning","optics-simulation","pytorch","ray-tracing","simulator","tomography"],"latest_commit_sha":null,"homepage":"https://magis-slac.github.io/gradoptics","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magis-slac.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-06T13:53:16.000Z","updated_at":"2024-09-25T12:23:31.000Z","dependencies_parsed_at":"2023-12-28T00:24:58.331Z","dependency_job_id":"41bc3258-a4ad-4165-b557-5646ff77e498","html_url":"https://github.com/magis-slac/gradoptics","commit_stats":{"total_commits":197,"total_committers":7,"mean_commits":"28.142857142857142","dds":"0.35025380710659904","last_synced_commit":"20cece8599d51bd6c87d26b3367a781ca124fbe2"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magis-slac%2Fgradoptics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magis-slac%2Fgradoptics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magis-slac%2Fgradoptics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magis-slac%2Fgradoptics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magis-slac","download_url":"https://codeload.github.com/magis-slac/gradoptics/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226986535,"owners_count":17713649,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["differentiable","machine-learning","optics-simulation","pytorch","ray-tracing","simulator","tomography"],"created_at":"2024-11-28T21:13:17.267Z","updated_at":"2024-11-28T21:13:17.385Z","avatar_url":"https://github.com/magis-slac.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Tests](https://github.com/magis-slac/gradoptics/actions/workflows/main.yml/badge.svg)](https://github.com/magis-slac/gradoptics/actions)\n[![Build Status](https://travis-ci.com/magis-slac/gradoptics.svg?token=LBAvFbnCy9PEgexzsTUS\u0026branch=main)](https://travis-ci.com/magis-slac/gradoptics)\n[![Documentation Status](https://readthedocs.org/projects/gradoptics/badge/?version=latest)](https://gradoptics.readthedocs.io/en/latest/?badge=latest)\n[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/magis-slac/gradoptics/blob/master/README.md)\n![version](https://img.shields.io/badge/version-0.0.4-blue)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# Differentiable Optics via Ray Tracing\n[*gradoptics*](https://github.com/magis-slac/gradoptics) is a ray tracing based optical simulator built using PyTorch [[1]](#1) to enable automatic differentiation. \n\nThe API is designed similar to rendering softwares, and has been heavily inspired by *Physically Based Rendering* (Pharr, Jakob, Humphreys) [[2]](#2). \n\n\n## Getting Started\n[Getting Started](https://github.com/magis-slac/gradoptics/blob/main/docs/tutorials/Quick-Start.ipynb)\n\n\n## Installation\n\n\n```commandline\npip install gradoptics\n```\n\nThen, you should be ready to go!\n```python\nimport gradoptics as optics\n```\n\n## Work in progress\n- Currently, some optical element normals are aligned with the optical axis -\u003e more general orientations in progress\n- Currently, monochromatic -\u003e no chromatic aberrations\n\n## Project History\n\nThis project was started in 2020 by Michael Kagan and Maxime Vandegar at SLAC National Accelerator Laboratory.\n\n## Feedback and Contributions\n\nPlease use issues on GitHub for reporting bugs and suggesting features (including better documentation).\n\nWe appreciate all contributions. In general, we recommend using pull requests to make changes to [*gradoptics*](https://github.com/magis-slac/gradoptics).  \n\n#### Testing\n\nIf you modify [*gradoptics*](https://github.com/magis-slac/gradoptics), please use pytest for checking your code.\n\n```commandline\npytest tests/tests.py \n```\n\n\n## Support\n\n[*gradoptics*](https://github.com/magis-slac/gradoptics) was developed in the context of the MAGIS-100 experiment \n\n## References\n\u003ca id=\"1\"\u003e[1]\u003c/a\u003e \nA. 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.\n\n\u003ca id=\"1\"\u003e[2]\u003c/a\u003e \nMatt Pharr, Wenzel Jakob, and Greg Humphreys. 2016. Physically Based Rendering: From Theory to Implementation (3rd ed.). Morgan Kaufmann Publishers Inc. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagis-slac%2Fgradoptics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagis-slac%2Fgradoptics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagis-slac%2Fgradoptics/lists"}