Wrapper around the Ansys Zemax OpticStudio API that provides a more intuitive way to interact with the ZOS-API through Python using a .NET connection, as described in this Journal of Open Source Software paper. It thereby allows you to do more optics modelling with less coding.
In addition to full access to all the OpticStudio fucntions through the ZOS-API, ZOSPy provides the following features:
- Wrapper functions for several OpticStudio analyses in
zospy.analyses; - Easy access to solvers in
zospy.solvers; - Easy access to all API constants in
zospy.constants; - Autocomplete for all ZOS-API endpoints and constants;
- Solves common problems related to Python.NET 3 and interaction with the ZOS-API.
The code is provided as is, without any warranty. It is solely intended for research purposes. No warranty is given and no rights can be derived from it, as is also stated in the MIT license.
ZOSPy is available on PyPi
pip install zospy
And through conda:
conda install conda-forge::zospy
ZOSPy officially supports Python 3.9 - 3.12. It may work with older Python versions, but support is not provided for these versions.
- Python for .NET 3.0.3
- pandas
- NumPy
- SemVer 3.0.2
ZOSPy is tested with the following versions of Python and Ansys Zemax OpticStudio:
| Zemax | 20.3.2 | 23.1.0 | 23.2.1 | 24.1.0 | 24.1.3 |
|---|---|---|---|---|---|
| Python 3.9 | ⚠ | ✔ | ✔ | ✔ | ⚠ |
| Python 3.10 | ⚠ | ✔ | ✔ | ✔ | ⚠ |
| Python 3.11 | ⚠ | ✔ | ✔ | ✔ | ⚠ |
| Python 3.12 | ⚠ | ✔ | ⚠ |
✔: This version works without problems. ⚠: This version works, but the output of analyses can differ slightly from the used reference version (currently OpticStudio 23 R1.01).
When publishing results obtained with this package, please cite our paper in the Journal of Open Source Software:
Vught, L. van, Haasjes, C. & Beenakker, J.W.M. (2024). ZOSPy: Optical ray tracing in Python through OpticStudio. Journal of Open Source Software, 9(96), 5756. https://doi.org/10.21105/joss.05756
Please read our contribution guidelines prior to opening a Pull Request.
The connection as extension to running software OpticStudio is initiated as:
import zospy as zp
zos = zp.ZOS()
oss = zos.connect("extension")Make sure that the OpticStudio software is set up to be connected to as extension through the API. Alternatively, a standalone OpticStudio application can be launched by changing the last line to:
oss = zos.connect("standalone")Solvers for the Lens Data Editor are available through zp.solvers. Every solver requires a surface as its first
parameter.
import zospy.solvers as solvers
surface = oss.LDE.GetSurfaceAt(2)
solvers.position(surface.ThicknessCell, from_surface=1, length=10)Implemented analyses are available though zp.analyses. The available analyses are grouped in files that correspond to
the analysis groups in OpticStudio (e.g. zp.analyses.mtfand zp.analyses.wavefront). Every analysis requires the
OpticStudioSystem oss as first parameter.
from zp.analyses.mtf import fft_through_focus_mtf
mtf = fft_through_focus_mtf(oss, sampling='64x64', deltafocus=0.1, oncomplete='Close')from zp.analyses.reports import cardinal_points
cp = cardinal_points(oss, surf1=3, surf2=4, oncomplete='Release')A full description of the available function parameters is provided in the docstrings.
After initiating the connection, all api constants are available through zp.constants (
e.g. zp.constants.Editors.LDE.SurfaceType). Note that these are only available after zos.wakeup() has been called,
as explained under Initiating connection.
Some convenience functions are available through zp.functions, e.g. to change a surface to a standard stuface:
newsurf = oss.LDE.InsertNewSurfaceAt(0)
zp.functions.lde.surface_change_type(newsurf, 'Standard')This example creates a simple optical system consisting of a single lens.
import matplotlib.pyplot as plt
import zospy as zp
zos = zp.ZOS()
oss = zos.connect()
# Create a new, empty system
oss.new()
# Set aperture and wavelength
oss.SystemData.Aperture.ApertureType = zp.constants.SystemData.ZemaxApertureType.FloatByStopSize
oss.SystemData.Wavelengths.GetWavelength(1).Wavelength = 0.543 # in μm
# Set the object at infinity
surface_object = oss.LDE.GetSurfaceAt(0)
surface_object.Thickness = float("inf")
# Add a dummy surface for visualization purposes
input_beam = oss.LDE.InsertNewSurfaceAt(1)
input_beam.Comment = "input beam"
input_beam.Thickness = 10
# Use a stop diameter of 4 mm
surface_stop = oss.LDE.GetSurfaceAt(2)
surface_stop.SemiDiameter = 2
# Add a lens with n = 1.5
lens_front = oss.LDE.InsertNewSurfaceAt(3)
lens_front.Comment = "lens front"
lens_front.Radius = 20
lens_front.Thickness = 1
zp.solvers.material_model(lens_front.MaterialCell, refractive_index=1.5)
lens_back = oss.LDE.InsertNewSurfaceAt(4)
lens_back.Comment = "lens back"
lens_back.Radius = -20
lens_back.Thickness = 19.792 # System is in focus
# Show the system in the 3D viewer
draw_3d = zp.analyses.systemviewers.viewer_3d(oss, surface_line_thickness="Thick", ray_line_thickness="Thick")
plt.imshow(draw_3d.Data)
plt.axis("off")
plt.show()
Some basic logging is implemented through the
standard python logging module (but still under development). The
following implementation examples assume that import logging has been executed.
- To enable logging output from all ZOSPy and other modules using logging.basicConfig:
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
- To enable logging output from all ZOSPy and other modules using a root logger:
fmt = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') sh = logging.StreamHandler() sh.setFormatter(fmt) sh.setLevel(logging.DEBUG) logger = logging.getLogger() logger.addHandler(sh)
- To enable logging output from only ZOSPy
logging.getLogger('zospy').addHandler(logging.StreamHandler()) logging.getLogger('zospy').setLevel(logging.INFO)
Feel free to contact us via e-mail at zospy@mreye.nl for any inquiries, or visit mreye.nl to discover our research.