diffinytrace 2.1__tar.gz

diffinytrace-2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Martin Pflaum
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diffinytrace-2.1/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

diffinytrace-2.1/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: diffinytrace
+Version: 2.1
+Author: Martin Pflaum
+Author-email: contact@martinpflaum.com
+Requires-Python: ==3.12
+License-File: LICENSE
+Requires-Dist: colour-science==0.4.7
+Requires-Dist: matplotlib==3.10.8
+Requires-Dist: numpy==2.3.5
+Requires-Dist: pandas==3.0.1
+Requires-Dist: Pillow==12.0.0
+Requires-Dist: plotly==6.6.0
+Requires-Dist: pvlib==0.15.0
+Requires-Dist: scikit_learn==1.8.0
+Requires-Dist: scipy==1.17.1
+Requires-Dist: tqdm==4.67.3
+Requires-Dist: nbformat==5.1.3
+Requires-Dist: ipykernel==7.2.0
+Requires-Dist: cadquery==2.7.0
+Requires-Dist: torchmetrics==1.9.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python

diffinytrace-2.1/README.md

@@ -0,0 +1,95 @@
+# DiffinyTrace
+
+**DiffinyTrace** is a Python library for differentiable ray tracing and optical system optimization using PyTorch. It enables automatic differentiation through optical systems, making it possible to optimize lens designs, mirror configurations, and other optical components using gradient-based methods.
+
+The source code is available at the [GitHub repository](https://github.com/martinpflaum/diffinytrace).
+
+## Key Features
+
+<div align="center">
+<img src="docs/_static/system_3D_plot.png" width="60%" alt="Transformation example">
+<p><strong>Flexible Transformations</strong> — apply general transformations such as rotations and translations to optical components, with full control over the parameters and their role in the transformation.</p>
+</div>
+
+<div align="center">
+<img src="docs/_static/cad_export.png" width="40%" alt="CAD export example">
+<p><strong>Seamless CAD Export</strong> — generate lenses and mirrors that can be exported to standard CAD file formats.</p>
+</div>
+
+<div align="center">
+<img src="docs/_static/bspline_plot1.png" width="80%" alt="B-spline surface example">
+<p><strong>Freeform Surfaces</strong> — design complex optical elements with advanced B-spline representations for maximum flexibility.</p>
+</div>
+
+* **Differentiable Ray Tracing**: Full automatic differentiation support through optical systems
+* **Constraint Optimization**: Advanced optimization with PyTorch and SciPy integration
+* **Illumination Design**: Algorithms for computing lens surfaces to achieve desired illumination profiles
+* **GPU Acceleration**: CUDA support for high-performance computations
+
+## Installation
+
+1. **Create a new Enviroment** via conda:
+   ```bash
+   conda create -n dit python==3.12
+   ```
+   activate enviroment via
+   ```bash
+   conda activate dit
+   ```
+   install pip
+   ```bash
+   conda install pip
+   ```
+   
+   
+2. **Install PyTorch**
+   
+   Check your cuda version with 
+   ```bash
+   nvcc --version
+   ```
+   
+   Diffinytrace only has been tested with 2.10.0+cu130. Make sure to install the appropriate version of PyTorch for your system. You can find the installation instructions on the [PyTorch website](https://pytorch.org/get-started/locally/). DiffinyTrace should work for both cpu and cuda versions.
+
+3. **Install DiffinyTrace**
+   Install all other dependencies and the library itself via:
+   ```bash
+   no pip package yet
+   ```
+   or directly in the folder via
+   ```bash
+   pip install -r requirements.txt
+   ```
+   
+
+## Basic Usage Example
+
+```python
+import diffinytrace as dit
+import torch
+NBK7 = dit.materials["NBK7"]
+
+wave_len = 1.024
+light_transform = dit.transforms.Offset(torch.tensor([0.0,0.0,0.0]))
+source = dit.source.CollimatedMonochromatic(light_transform,8.0,wave_len)
+
+plane_surface = dit.Plane()
+surface2 = dit.Aspheric(-1/50.)
+transf1 = dit.transforms.Distance(10.0,parent_transform=source)
+lens1 = dit.Lens(transf1,5.,plane_surface,surface2,NBK7,13.0)
+transf2 = dit.transforms.Distance(15.0,parent_transform=lens1)
+detector = dit.Detector(transf2,plane_surface,8.0)
+system = dit.SequentialOpticalSystem({"source":source, "lens":lens1, "detector":detector})
+
+x,weights = source.sample(10)
+O,D,wave_len,_,meta_data = system(x,["source","lens","detector"])
+dit.plotting.system2D.plot(system,meta_data)
+```
+
+## Documentation
+
+For comprehensive documentation, tutorials, and API reference, visit the [full documentation](https://diffinytrace.readthedocs.io/en/latest/index.html).
+
+## License
+
+DiffinyTrace is licensed under the MIT License. See the repository for full license details.

diffinytrace-2.1/diffinytrace/__init__.py

@@ -0,0 +1,122 @@
+# Copyright (c) 2025 Martin Pflaum
+# This file is part of the diffinytrace project, licensed under the MIT License.
+
+
+"""
+This module provides a collection of functions and classes for optical system design and analysis.
+It includes modules for ray tracing, surface definitions, optimization, and more.
+"""
+
+__all__ = [
+    # Submodules
+    "source",
+    "transforms",
+    "target_grid",
+    "utils",
+    "plotting",
+    "basis_functions",
+    "gaussian_smoother",
+    "optimize",
+    "integrators",
+    "export",
+    "render",
+    "constraints",
+    "spectrum",
+
+    # intersection
+    "cat_semi_functionals",
+    "get_functional_param_args",
+    "construct_surface_and_normal_func",
+    "construct_surface_and_normal_func_with_params",
+    "CustomAutogradRule_t",
+    "get_ray_intersection_length",
+
+    # surface
+    "Plane",
+    "Aspheric",
+    "Bspline",
+    "Legendre",
+    "bspline_n_after_refinement",
+
+    # element
+    "OpticalSystem",
+    "SequentialOpticalSystem",
+    "OpticalElement",
+    "OpticalSurface",
+    "LensSurfaceTransmissionEnter",
+    "LensSurfaceTransmissionLeave",
+    "Lens",
+    "Mirror",
+    "Detector",
+    "trace_to_detector",
+    "get_unused_params_mask",
+    "set_used_params_bounds_to_constant",
+    "set_unused_params_to_zero",
+    "set_unused_bspline_coeff_to_nearest",
+    "FresnelVirtualLens",
+
+    # config
+    "set_tolerance",
+    "get_tolerance",
+    "set_max_iterations",
+    "get_max_iterations",
+    "restore_default_settings",
+    "get_damping_factor",
+    "set_damping_factor",
+    "get_show_iteration_count",
+    "set_show_iteration_count",
+
+    # optimize
+    "minimize",
+    "make_parameter_from_input",
+    
+    # refractive_index
+    "materials",
+    "RefractiveIndex",
+
+    # autograd
+    "grad",
+]
+
+import os
+os.environ["KMP_DUPLICATE_LIB_OK"]="TRUE"
+import torch
+torch.set_default_dtype(torch.float64)
+
+from . import source
+from . import transforms
+from . import target_grid
+from . import gaussian_smoother
+
+from . import utils
+#from . import refractive_index
+from . import plotting
+from . import basis_functions
+from . import optimize
+from . import integrators
+from . import export
+from . import render
+from . import constraints
+from . import spectrum
+
+from .intersection import cat_semi_functionals,get_functional_param_args,\
+    construct_surface_and_normal_func,construct_surface_and_normal_func_with_params,\
+    CustomAutogradRule_t,get_ray_intersection_length
+
+from .surface import Plane,Aspheric,Bspline,Legendre,bspline_n_after_refinement
+
+from .element import OpticalSystem,SequentialOpticalSystem,OpticalElement,OpticalSurface,\
+    LensSurfaceTransmissionEnter,LensSurfaceTransmissionLeave,Lens,Mirror,Detector,trace_to_detector,\
+    get_unused_params_mask,set_used_params_bounds_to_constant,\
+    set_unused_params_to_zero,set_unused_bspline_coeff_to_nearest,\
+    FresnelVirtualLens
+
+from .config import set_tolerance,get_tolerance,set_max_iterations,\
+    get_max_iterations,restore_default_settings,get_damping_factor,set_damping_factor,\
+    get_show_iteration_count,set_show_iteration_count
+from .optimize import minimize,make_parameter_from_input
+
+from .refractive_index import materials
+from .refractive_index import RefractiveIndex
+from .utils.autograd import grad
+

diffinytrace-2.1/diffinytrace/basis_functions/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) 2025 Martin Pflaum
+# This file is part of the diffinytrace project, licensed under the MIT License.
+
+__all__ = [
+    "bspline",
+    "legendre",
+    "zernike",
+    "chebyshev"
+]
+
+from . import bspline
+from . import legendre
+from . import zernike
+from . import chebyshev