Debian Codegraph @

texmf-dist/doc/latex/optikz/README.md

raw
1 README for optikz.sty
2
3 # optikz – Draw Optical Setups in TikZ
4
5 **Author**: Martin Beyer
6 **Released**: July 29, 2025
7 **License**: LaTeX Project Public License (LPPL Version 1.3c 2008-05-04)
8 **Contact**: [email protected]
9
10 See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for the details of the license.
11
12 ## Overview
13
14 `optikz` is a LaTeX package that provides a library of customizable optical components for drawing laser setups and optical systems using TikZ.
15
16 It includes a variety of elements such as:
17 - **Lenses** (convex, concave, etc.)
18 - **Mirrors** (flat, curved)
19 - **Detectors** (cameras, spectrometers, photodiodes)
20 - **Devices** (Faraday rotator, Pockels cell, microscope objective, laser head)
21 - **Other components** waveplates, splitters, parabolas, gratings
22 - **Rays and beams** rainbow beam for stretchers and compressors, single color beams
23
24 Each component can be easily customized with intuitive optional arguments to control angle, size, color, thickness, labels, and more.
25
26 ## Features
27
28 - Built entirely on TikZ – no external dependencies (other than xparse and xcolor)
29 - Consistent usage of arguments and minimal syntax
30 - Showcase of sophisticated setups and examples in the documentation
31 - Compatibility with TikZ coordinates
32 - Customizable styling (color, rotation, labels)
33 - Easily extendable and changeable
34
35 ## Usage
36
37 Include the package in your LaTeX document:
38
39 ```latex
40 \usepackage{optikz}