User guide

Getting started

• Installation
  • Using ZOSPy in a separate environment
• Simple example
• Frequently Asked Questions
  • How do I disconnect from OpticStudio?
  • How do I reconnect to OpticStudio?
  • Why do I get a ValueError: Cannot have more than one active ZOS instance?
• Compatibility
  • OpticStudio 25.1.1
  • OpticStudio 24.2.2
  • OpticStudio 24.1.3
  • OpticStudio 24.1.0

Using ZOSPy

• Connecting to OpticStudio
  • Connecting in standalone mode
  • Connecting in extension mode
  • Connecting to a specific version of OpticStudio
  • Difference between ZOS and OpticStudioSystem
  • Reconnecting to OpticStudio
• Creating an optical system
  • Example
  • Using solvers
  • Contributing solvers
• Performing analyses
  • Analysis wrapper structure
  • Examples
  • Accessing OpticStudio analyses directly
• Using ZOS-API constants
• Convenience functions
  • Example

Advanced usage

• Logging
• Custom object conversion between the ZOS-API and ZOSPy
  • OpticStudioInterfaceEncoder