From f6ea89e44a97c5acc93f8891702ab987b8dd236c Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 2 May 2021 14:21:24 -0400 Subject: [PATCH] Small update to move info to top of documentation --- raytracing/zemax.py | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/raytracing/zemax.py b/raytracing/zemax.py index 51cb15c7..213d6131 100644 --- a/raytracing/zemax.py +++ b/raytracing/zemax.py @@ -11,17 +11,20 @@ class Surface(NamedTuple): spacing:float = 0 class ZMXReader: + """ + Zemax file (ZMX) reader for compound lenses. The reader is not + complete, but it can return a `MatrixGroup` that will behave like a + compound lens with the spherical interfaces and spacing between + elements. + + This only works with ZMX files, not ZMF files. The ZMX files are + text-based and the ZMF files are binary without documentation. + + It is not particularly robust: many parameters are currently ignored + and it could fail for files not from Thorlabs or Edmund (the only + files tested). + """ def __init__(self, filepath): - """ - Zemax file (ZMX) reader for compound lenses. The reader is not - complete, but it can return a `MatrixGroup` that will behave like a - compound lens with the spherical interfaces and spacing between - elements. - - It is not particularly robust. Many parameters are currently ignored - and it could fail for files not from Thorlabs or Edmund (the only - files tested). - """ self.filepath = filepath self.name = filepath self.lines = []