OpticSim.jl is a Julia package for geometric optics (ray tracing) simulation and optimization of complex optical systems developed by the Microsoft Research Interactive Media Group and the Microsoft Hardware Architecture Incubation Team (HART).
It is designed to allow optical engineers to create optical systems procedurally and then to simulate and optimize them. Unlike Zemax, Code V, or other interactive optical design systems OpticSim.jl has limited support for interactivity, primarily in the tools for visualizing optical systems.
A large variety of surface types are supported, and these can be composed into complex 3D objects through the use of constructive solid geometry (CSG). A complete catalog of optical materials is provided through the complementary GlassCat submodule.
This software provides extensive control over the modelling, simulation, visualization and optimization of optical systems. It is especially suited for designs that have a procedural architecture.
Install the Julia programming language from the official download page.
OpticSim.jl is optimized for use with Julia 1.7.x; using other versions will probably not work.
The system will automatically download glass catalog (.agf) files from some manufacturers when the package is built for the first time. These files are in an industry standard format and can be downloaded from many optical glass manufacturers.
Here are links to several publicly available glass files:
- NIKON (automatically downloaded)
- NHG (you have to manually download)
- OHARA (automatically downloaded)
- HOYA (automatically downloaded)
- SUMITA (automatically downloaded)
- SCHOTT (automatically downloaded)
OpticSim.jl will generate a glass database from the available files in
deps/downloads/glasscat/ and store it in the file
AGFClassCat.jl. See GlassCat for a detailed description, including instructions on how to add more catalogs.
Run this example to check that everything installed properly:
using OpticSim Vis.draw(SphericalLens(OpticSim.GlassCat.SCHOTT.N_BK7, 0.0, 10.0, 10.0, 5.0, 5.0)) Vis.save("assets/test_install.png") # hide nothing # hide
If you are using Julia 1.5, we recommend compiling a custom Julia system image for the OpticSim.jl package to reduce startup time and improve first-time performance.
With VSCode, you can create a sysimage by opening the commant palette (CTRL-shift-P) and selecting
Tasks: Run Build Task, julia: Build custom sysimage for current environment.
Alternatively, we provide a Julia script that will build the sysimage using a representative workload. To do this, activate a Julia environment which has OpticSim installed and run
By default, the sysimage is located in the current working directory. On Linux, it will be called
JuliaSysimage.so; on Windows, the extension will be
.dll. A custom path can be used instead which is passed as an argument to
To use the generated system image, run Julia with the
julia --project=[your_project] --sysimage=[path_to_sysimage]
If OpticSim.jl is installed in the base project, then there is no need for the
--project flag in the above command. If your current working directory is OpticSim.jl, then you can use the
--project flag without needing to specify an argument.