欢迎阅读 ZOSPy 的文档!#
ZOSPy 是Ansys OpticStudio API 的包装器,它提供了一种更Python化、更直观的方式,使用.NET 连接通过Python与ZOS-API进行交互,如《开源软件杂志》论文所述。因此,它允许您用更少的编码进行更多的光学建模。
除了通过 ZOS-API 完全访问所有 OpticStudio 功能之外,ZOSPy 还提供以下功能:
zospy.analyses中几个 OpticStudio 分析的包装函数;轻松访问
zospy.solvers中的求解器;轻松访问
zospy.constants中的所有 API 常量;自动完成所有 ZOS-API 端点和常量;
解决与 Python.NET 3 和与 ZOS-API 交互相关的常见问题。
兼容性#
ZOSPy正式支持Python3.9 - 3.13。它可能适用于较旧的 Python 版本,但不提供对这些版本的支持。此外,还需要安装Ansys Zemax OpticStudio 。
请参阅下表以了解与不同版本的 Ansys Zemax OpticStudio 的兼容性。有关兼容性的更多信息,请参阅兼容性部分。
旧版本的 OpticStudio 尚未测试,但它们可能可以与 ZOSPy 一起使用。
表格图例
✔:此版本运行正常。
ℹ:所有 ZOSPy 分析的输出都与直接 OpticStudio 输出相匹配,但 OpticStudio 输出与参考版本(当前为OpticStudio 25 R1.01 )的输出存在差异。
⚠:ZOSPy 无法完全正常工作。
❌:ZOSPy 根本不起作用。
保修和责任#
代码按原样提供,不提供任何保证。它仅用于研究目的。不提供任何保证,也不能从中衍生任何权利,正如MIT 许可证中所述。
引用#
在发布使用此软件包获得的结果时,请引用我们在《开源软件杂志》上的论文:
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
联系#
如有任何疑问,请随时通过电子邮件zospy@mreye.nl联系我们,或访问mreye.nl了解我们的研究。
示例
Manage the connection with OpticStudio and interact with the optical system. |
|
OpticStudio Analyses. |
|
Constants for the ZOS-API. |
|
Custom object conversions between the CLR and Python. |
|
Utility functions for ZOSPy. |
|
OpticStudio Solvers. |