meodin 0.1.2

Optical Design Integrated Network

ODIN is a demo Python package for optical engineers. We believe in a straightforward path to great design and tolerancing. Let the best wavefront win😄

Requirements

• Python 3.x, ZOSAPI, NumPy, clr, os, winreg, random

Math Module

Interferometry Math Utilities

Lightweight Python helpers for common interferometry conversions. Convert surface irregularity and optical power between fringes, millimeters, and radius of curvature.

Features

• Irregularity conversion: fringes ↔ millimeters
• Optical power conversion: fringes ↔ millimeters
• Supports concave (CC) and convex (CX) surfaces
• NumPy-only dependency
• Simple random value generator for simulation/testing

Main Class

Math()

• Main interface for using Math functions.

Functions

irrFrToMm(fringes, wavelength_nm)

• Convert surface irregularity from fringes to millimeters.

irrMmToFr(irregularity_mm, wavelength_nm)

• Convert surface irregularity from millimeters to fringes.

powFrToMm(diameter_mm, nominal_radius_mm, surface_type, fringes, wavelength_nm)

• Convert power in fringes to corrected radius in millimeters.

powMmToFr(diameter_mm, nominal_radius_mm, surface_type, power_mm, wavelength_nm)

• Convert power in millimeters to fringes.

randomValue(distribution="uniform")

• Generate a random value between -1 and 1.
  • Distributions: uniform, gauss, parabolic

ZOSpy Module

A demo Python wrapper for Zemax OpticStudio (ZOS-API)

ZOSpy – OpticStudio Automation Utilities

Lightweight Python interface for connecting to Zemax OpticStudio, manipulating lens data, merit functions, and running tolerancing analyses via ZOS-API.

Features

• Offline ZMX file read/write/edit without OpticStudio
• Connect to OpticStudio (Interactive or Standalone)
• Open, save, and modify ZMX/ZOS files
• Lens Data Editor (LDE) surface and parameter control
• Merit Function Editor (MFE) access
• Local optimization control
• Monte Carlo tolerancing utilities

Main Class

ZOSpy()

• Main interface for connecting to and controlling OpticStudio.

File Handling

readOfflineZmx(pathToZmx)

• Read a .zmx file as text into memory.

writeOfflineZmx(pathToZmxWithNewName)

• Write modified offline .zmx content to file.

openFile(path)

• Open a ZMX or ZOS file in OpticStudio.

saveFile()

• Save the current system.

saveAsFile(pathWithName)

• Save the system under a new name.

Connections

connectOS()

• Connect via Interactive Extension.

connectOSSA()

• Connect via Standalone Application.

disconnectOS()

• Close OpticStudio and release the connection.

OfflineLDE

OfflineLDE.getParameter(surface, parameter)

• Read a surface parameter from offline ZMX text.

OfflineLDE.setParameter(surface, parameter, value)

• Modify a surface parameter in offline ZMX text.

LDE (Lens Data Editor)

LDE.getSurfaceByComment(comment)

• Find a surface index by comment.

LDE.addSurfaceAfter(surface)
LDE.addSurfaceBefore(surface)

• Add new surfaces relative to an existing one.

LDE.removeSurfaces(first_surface, last_surface)

• Remove a range of surfaces.

LDE.setSurfaceType(surface, type)

• Change the surface type.

LDE.setParameter(surface, parameter, value)

• Set a surface parameter.

LDE.getParameter(surface, parameter)

• Get a surface parameter value.

LDE.ignoreSurface(surface, bool)

• Enable or ignore a surface.

LDE.setUiUpdate(bool)

• Enable or disable live UI updates.

LDE.removeAllVariable()

• Remove all variables from the system.

LDE.setCoordinateBreakToElement(surface_1, surface_2, color)

• Group surfaces into an element using coordinate breaks.

MFE (Merit Function Editor)

MFE.loadMeritFunction(path)

• Load a merit function file.

MFE.calculateMeritFunction()

• alculate the current merit function.

MFE.getTarget(line)
MFE.setTarget(line, target)

• Get or set merit function targets.

MFE.getWeight(line)
MFE.setWeight(line, weight)

• Get or set merit function weights.

MFE.getValue(line)

• Read a merit function value.

Tolerancing

Tolerancing.getMonteCarlo()

• Run a single Monte Carlo tolerancing analysis.

Tolerancing.runMonteCarlos(cores, ScriptIndex, NumberOfRuns, NumberToSave)

• Run multiple Monte Carlo simulations.

Tolerancing.getData(column)

• Extract a column of Monte Carlo result data.