Provisional Manual

These pages are a Sphinx conversion of KrakenOS/Docs/USER_MANUAL_KrakenOS_Provisional.pdf. The original manual is from 2021 and describes the core library model: surf objects collected into a system, exact sequential and non-sequential tracing, raykeeper data collection, paraxial tools, pupil generation, atmospheric refraction, display tools, STL solids, and examples.

The conversion keeps the technical content but normalizes wording, fixes obvious legacy spelling issues, and points readers toward the current UI where the same core features are exposed through scene/event-backed tools.

Focused UI screenshots in these pages are generated from the live Tk editor:

python -m KrakenOS.UI.capture_manual_ui_screenshots

• Installation And Prerequisites
  • Basic installation paths
  • Running the layout editor
  • Manual source
• Introduction To Fundamental Lens Design
  • Why “Lens Families” Exist
  • Photographic Lens Families
  • Machine Vision Lens Families
  • Photography vs. Machine Vision: Side by Side
  • Reading A Prescription In KrakenOS
  • Further Reading
• Core Model: Surfaces And Systems
  • Surface attributes
  • System methods and state
  • Glass catalogs
• Classes and Attributes
  • Table 1 — surf class attributes
  • Table 2 — system class implementations and attributes
• Working with the KrakenOS Library
  • 3.1 Ray generation
  • 3.2 Extraction of ray information
  • 3.3 Generation of the optical system graph
• Parax Tool
• PupilCalc Tool
  • Pupil parameters
  • Automatic ray generation
  • 5.1 Atmospheric refraction in PupilCalc
• Editable Table Workflow
  • Loading versus inserting
  • Insertion point
  • Surface and element clipboard
  • Surface right-click menu
  • Compact prescription columns
  • Optimization cell marker
  • Tolerance Monte Carlo report
  • Prisms and cube beam splitters
  • Tilt and decenter tolerance overlays
  • Validation
• Non-Sequential-First Design Goals
  • Goal 1: non-sequential tracing is the native model
  • Goal 2: 3D tracing is authoritative; 2D is only a slice
  • Goal 3: object and illumination source are separate scene entities
  • Goal 4: every surface interaction obeys physics law
  • Implementation checklist
• Tracing And Ray Data
  • Scene-first UI model
  • 2D slices, 3D scenes, and CAD envelopes
  • Sequential tracing special case
  • Non-sequential tracing
  • Scene source records
  • Launch sampling metadata
  • Scene target records
  • Possible next scene workflows
  • Optical STL prism check
  • Face-role metadata check
  • Face-anchor snap-to-ray check
  • Face-fit placement check
  • Path-frame face-fit check
  • Virtual internal plane check
  • Optical-solid hit-sequence check
  • Raykeeper data
  • Inspect Ray / Surface Physics
  • Multicore and batch tracing
• Zemax Rayfile Sources
  • Import workflow
  • Ray sampling
  • Example saved layout source record
  • Validation
  • Current limitations
  • Beam-splitter imaging example
• Pupil, Paraxial, And Analysis Tools
  • Paraxial tool
  • PupilCalc
  • Atmospheric refraction
  • Wavefront and aberration tools
  • Image-quality maps
• Gaussian Beam Propagation
  • Input conventions
  • Datasheet diameter/divergence flow
  • Report columns
  • Astigmatic and elliptical beams
  • Phase 8 branch-field propagation
  • Phase 8B oblique astigmatic q baseline
  • Cavity eigenmode flow
  • UI workflow
  • Folded laser scanner example
  • Python example
  • Scope and limitations
  • Source-mode field relevance
• Beam Splitters
  • Terminology
  • Current capability
  • Split modes
  • UI workflow
  • Path workflow tutorial
  • Two-path doublet example
  • Manual path assignment
  • Path Workbench workflow
  • Separate source and object status
  • Michelson detector/interferogram workflow
  • Twyman-Green example
  • Mach-Zehnder example
  • Automatic path graph
  • Saved metadata
  • Python example
  • Internal branch data
  • Path throughput report
  • Path-filtered detector analyses
  • Phase 2 source and path workflow
  • Future tilted/folded/non-sequential Gaussian optics
• Diffuse And BRDF Scattering
  • Surface Type
  • Guided Target Sampling
  • Examples
  • pySCATMECH Optional Backend
• Lens Fabrication Drawings
  • Surface Property Workflow
  • Supported Fields
  • Example In A Layout File
  • Reference Behaviour
• Display And Viewers
  • 2D display
  • 3D display
  • CAD/STL optical solids
  • STEP and CAD overlays
• Handling the 3D Viewer
• Manual Example Inventory
• Appendix — Examples
  • 7.1 Example — Ray
  • 7.2 Example — Perfect Lens
  • 7.3 Example — Doublet Lens 3D Color
  • 7.4 Example — Doublet Lens Tilt
  • 7.5 Example — Doublet Lens (Paraxial Calculations)
  • 7.6 Example — Doublet Lens Tilt Nulls
  • 7.7 Example — Doublet Lens NonSec
  • 7.8 Example — Doublet Lens Zernike
  • 7.9 Example — Doublet Lens Tilt NonSec
  • 7.10 Example — Doublet Lens Pupil
  • 7.11 Example — Doublet Lens Commands System
  • 7.12 Example — Doublet Lens Pupil + Seidel
  • 7.13 Example — Doublet Lens Cylinder
  • 7.14 Example — Axicon
  • 7.15 Example — Axicon and Cylinder
  • 7.16 Example — Flat Mirror 45 Deg
  • 7.17 Example — Parabolic Mirror Shift
  • 7.18 Example — Diffraction Grating in Transmission
  • 7.19 Example — Diffraction Grating in Reflection
  • 7.20 Example — Tel 2M Spyder Spot Diagram
  • 7.21 Example — Tel 2M Spyder Spot, M2 Tilt
  • 7.22 Example — Tel 2M Pupila
  • 7.23 Example — Tel 2M Error Map
  • 7.24 Example — Tel 2M Wavefront Fitting
  • 7.25 Example — Tel 2M STL Image Slicer
  • 7.26 Example — Tel 2M Atmospheric-Refraction Corrector
  • 7.27 Example — ExtraShape Micro Lens Array
  • 7.28 Example — ExtraShape Radial Sine
  • 7.29 Example — ExtraShape XY Cosines
  • 7.30 Example — MultiCore
  • 7.31 Example — Solid Objects STL Array
  • 7.32 Example — Source Distribution Function
• References