0.1.1!

CALENDAR

@@ -2,4 +2,4 @@
 29.05.17:   0.1.0 doc
 08.06.17:   0.1.0 alpha
 13.06.17:   0.1.0
-12.07.17:   0.1.1
+10.07.17:   0.1.1

doc/src/api.ind

@@ -1,43 +1,51 @@
 \begin{theindex}
 
-  \item theia \textit{(package)}, \hyperpage{4--5}
-    \subitem theia.helpers \textit{(package)}, \hyperpage{6}
+  \item theia \textit{(package)}, \hyperpage{5--6}
+    \subitem theia.helpers \textit{(package)}, \hyperpage{7}
       \subsubitem theia.helpers.geometry \textit{(module)}, 
-		\hyperpage{7--9}
+		\hyperpage{8--10}
       \subsubitem theia.helpers.interaction \textit{(module)}, 
-		\hyperpage{10}
-      \subsubitem theia.helpers.settings \textit{(module)}, 
 		\hyperpage{11}
+      \subsubitem theia.helpers.settings \textit{(module)}, 
+		\hyperpage{12}
       \subsubitem theia.helpers.tools \textit{(module)}, 
-		\hyperpage{12--14}
-      \subsubitem theia.helpers.units \textit{(module)}, \hyperpage{15}
-    \subitem theia.main \textit{(module)}, \hyperpage{16}
-      \subsubitem theia.main.main \textit{(function)}, \hyperpage{16}
-    \subitem theia.optics \textit{(package)}, \hyperpage{17}
+		\hyperpage{13--15}
+      \subsubitem theia.helpers.units \textit{(module)}, \hyperpage{16}
+    \subitem theia.main \textit{(module)}, \hyperpage{17}
+      \subsubitem theia.main.main \textit{(function)}, \hyperpage{17}
+    \subitem theia.optics \textit{(package)}, \hyperpage{18}
       \subsubitem theia.optics.beam \textit{(module)}, 
-		\hyperpage{18--21}
+		\hyperpage{19--22}
       \subsubitem theia.optics.beamdump \textit{(module)}, 
-		\hyperpage{22--24}
+		\hyperpage{23--25}
       \subsubitem theia.optics.component \textit{(module)}, 
-		\hyperpage{25--27}
+		\hyperpage{26--28}
+      \subsubitem theia.optics.ghost \textit{(module)}, 
+		\hyperpage{29--31}
       \subsubitem theia.optics.lens \textit{(module)}, 
-		\hyperpage{28--31}
+		\hyperpage{32--35}
       \subsubitem theia.optics.mirror \textit{(module)}, 
-		\hyperpage{32--36}
+		\hyperpage{36--40}
       \subsubitem theia.optics.optic \textit{(module)}, 
-		\hyperpage{37--39}
+		\hyperpage{41--43}
       \subsubitem theia.optics.thicklens \textit{(module)}, 
-		\hyperpage{40--42}
+		\hyperpage{44--46}
       \subsubitem theia.optics.thinlens \textit{(module)}, 
-		\hyperpage{43--45}
-    \subitem theia.rendering \textit{(package)}, \hyperpage{46}
-    \subitem theia.running \textit{(package)}, \hyperpage{47}
+		\hyperpage{47--49}
+    \subitem theia.rendering \textit{(package)}, \hyperpage{50}
+      \subsubitem theia.rendering.features \textit{(module)}, 
+		\hyperpage{51--55}
+      \subsubitem theia.rendering.shapes \textit{(module)}, 
+		\hyperpage{56}
+      \subsubitem theia.rendering.writer \textit{(module)}, 
+		\hyperpage{57}
+    \subitem theia.running \textit{(package)}, \hyperpage{58}
       \subsubitem theia.running.parser \textit{(module)}, 
-		\hyperpage{48--49}
+		\hyperpage{59--60}
       \subsubitem theia.running.simulation \textit{(module)}, 
-		\hyperpage{50--52}
-    \subitem theia.tree \textit{(package)}, \hyperpage{53}
+		\hyperpage{61--63}
+    \subitem theia.tree \textit{(package)}, \hyperpage{64}
       \subsubitem theia.tree.beamtree \textit{(module)}, 
-		\hyperpage{54--55}
+		\hyperpage{65--67}
 
 \end{theindex}

doc/src/api.tex

@@ -3,7 +3,7 @@
 % Include File
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 \documentclass{article}
 \usepackage{alltt, parskip, fancyhdr, boxedminipage}
@@ -119,12 +119,16 @@
 \include{theia.optics.beam-module}
 \include{theia.optics.beamdump-module}
 \include{theia.optics.component-module}
+\include{theia.optics.ghost-module}
 \include{theia.optics.lens-module}
 \include{theia.optics.mirror-module}
 \include{theia.optics.optic-module}
 \include{theia.optics.thicklens-module}
 \include{theia.optics.thinlens-module}
 \include{theia.rendering-module}
+\include{theia.rendering.features-module}
+\include{theia.rendering.shapes-module}
+\include{theia.rendering.writer-module}
 \include{theia.running-module}
 \include{theia.running.parser-module}
 \include{theia.running.simulation-module}

doc/src/quickref.tex

@@ -9,10 +9,16 @@
 \title{theia Quick Reference}
 
 \begin{document}
+\begin{center}
+\large \tt{theia} Quick Reference (v. 0.1.1)
+\end{center}
 
-\begin{tabular}{| p{.6cm} | p{7cm}| p{6cm} | p{5cm} |}
+
+
+\begin{tabular}{| p{.6cm} | p{8cm}| p{8cm} | p{8cm} |}
 \hline
 \textbf{Key} & \textbf{Input Order} & \textbf{Defaults} & \textbf{Remarks} \\ \hline \hline
+\tt{bo} & \tt{X}, \tt{Y}, \tt{Z} (origin of bench) & \tt{X}, \tt{Y}, \tt{Z}~=~0 & This will shift all the coordinates of the following optics and beams (until the next \tt{bo} line) by the amounts given here. If you want to signify that you're back in the general coordinate system, you can put in a blank \tt{bo} line.\\ \hline
 
 \tt{bm} & \tt{Wx}, \tt{Wy} (waist sizes), \tt{WDistx}, \tt{WDisty} (waist positions from beam origin), \tt{Wl}, \tt{P}, \tt{X}, \tt{Y}, \tt{Z} (position of origin in space), \tt{Theta}, \tt{Phi} (orientation), \tt{Alpha} (rotation of eigenbase for orthogonal beams), \tt{Ref}  & \tt{Wx}~=~1.mm, \tt{Wy}~=~1.mm, \tt{WDistx}~=~0., \tt{WDisty}~=~0., \tt{Wl}~=~1064.nm, \tt{P}~=~1.W, \tt{X}~=~0., \tt{Y}~=~0., \tt{Z}~=~0., \tt{Theta}~=~pi/2., \tt{Phi}~=~0., \tt{Alpha}~=~0., \tt{Ref}~=~None & \tt{Alpha = 0.} $\leftrightarrow$ eigen X is $\perp$ to beam direction and has maximum $Z$ component. If direction is $\pm e_Z$ then eigen X is $\pm e_X$\\ \hline
 
@@ -24,6 +30,7 @@
 
 \tt{bd} & \tt{X}, \tt{Y}, \tt{Z} (position of center of HR), \tt{Theta}, \tt{Phi} (orientation of HR Norm, pointing out), \tt{Diameter},  \tt{Thickness}, \tt{Ref} & \tt{X}~=~0., \tt{Y}~=~0., \tt{Z}~=~0., \tt{Theta}~=~pi/2., \tt{Phi}~=~0., \tt{Diameter}~=~5.cm,  \tt{Thickness}~=~2.cm,  \tt{Ref}~=~None & \\ \hline
 
+\tt{gh} & \tt{X}, \tt{Y}, \tt{Z} (position of center of HR), \tt{Theta}, \tt{Phi} (orientation of HR Norm, pointing out), \tt{Diameter}, \tt{Ref} & \tt{X}~=~0., \tt{Y}~=~0., \tt{Z}~=~0., \tt{Theta}~=~pi/2., \tt{Phi}~=~0., \tt{Diameter}~=~5.cm, \tt{Ref}~=~None & This component does not affect the beams, but just allows to have a new entry in the output file for the beam emerging from the ghost surface. It does not have a 3D rendering object associated. \\ \hline
 \end{tabular}
 
 \begin{multicols}{2}

doc/src/theia-module.tex

@@ -3,7 +3,7 @@
 % Package theia
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -17,7 +17,7 @@ \section{Package theia}
 This is theia, a Python package for Gaussian ray tracing in 3D optical 
 setups.
 
-\textbf{Version:} 0.1.0
+\textbf{Version:} 0.1.1
 
 
 
@@ -113,6 +113,12 @@ \subsection{Modules}
 
   \textit{(Section \ref{theia:optics:component}, p.~\pageref{theia:optics:component})}
 
+    \item \textbf{ghost}: Defines the Ghost class for theia.
+
+
+
+  \textit{(Section \ref{theia:optics:ghost}, p.~\pageref{theia:optics:ghost})}
+
     \item \textbf{lens}: Defines the Lens class for theia.
 
 
@@ -150,6 +156,27 @@ \subsection{Modules}
 
   \textit{(Section \ref{theia:rendering}, p.~\pageref{theia:rendering})}
 
+  \begin{itemize}
+\setlength{\parskip}{0ex}
+    \item \textbf{features}: Features module or theia, to represent objects as FreeCAD Python features.
+
+
+
+  \textit{(Section \ref{theia:rendering:features}, p.~\pageref{theia:rendering:features})}
+
+    \item \textbf{shapes}: Shapes module for theia, provides shape-calculating for 3D rendering.
+
+
+
+  \textit{(Section \ref{theia:rendering:shapes}, p.~\pageref{theia:rendering:shapes})}
+
+    \item \textbf{writer}: Writer module for theia, to write CAD content to files.
+
+
+
+  \textit{(Section \ref{theia:rendering:writer}, p.~\pageref{theia:rendering:writer})}
+
+  \end{itemize}
 \item \textbf{running}: This is the running sub-package of theia.
 
 

doc/src/theia.helpers-module.tex

@@ -3,7 +3,7 @@
 % Package theia.helpers
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -18,7 +18,7 @@ \section{Package theia.helpers}
 
 It provides it provides all sorts of generic functions for theia.
 
-\textbf{Version:} 0.1.0
+\textbf{Version:} 0.1.1
 
 
 

doc/src/theia.helpers.geometry-module.tex

@@ -3,7 +3,7 @@
 % Module theia.helpers.geometry
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

doc/src/theia.helpers.interaction-module.tex

@@ -3,7 +3,7 @@
 % Module theia.helpers.interaction
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -32,12 +32,21 @@ \section{Module theia.helpers.interaction}
 \endlastfoot\raggedright u\-s\-a\-g\-e\- & \raggedright \textbf{Value:} 
 {\tt \texttt{'}\texttt{Usage: theia [options] FNAME{\textbackslash}n{\textbackslash}nArguments:{\textbackslash}n  FNAME{\textbackslash}t{\textbackslash}t }\texttt{...}}&\\
 \cline{1-2}
-\raggedright w\-e\-l\-c\-o\-m\-e\-S\-t\-r\-i\-n\-g\- & \raggedright \textbf{Value:} 
+\raggedright w\-e\-l\-c\-o\-m\-e\- & \raggedright \textbf{Value:} 
 {\tt \texttt{'}\texttt{{\textbackslash}n{\textbackslash}ttheia Copyright (C) 2017 R. Duque{\textbackslash}n{\textbackslash}tLicense: GNU GP}\texttt{...}}&\\
 \cline{1-2}
-\raggedright r\-e\-c\-u\-r\-s\-i\-o\-n\-E\-r\-r\-o\-r\-S\-t\-r\-i\-n\-g\- & \raggedright \textbf{Value:} 
+\raggedright e\-r\-r\-o\-r\-R\-e\-c\-u\-r\-s\-i\-o\-n\- & \raggedright \textbf{Value:} 
 {\tt \texttt{'}\texttt{{\textbackslash}n{\textbackslash}nIt looks like you reached the maximum recursion dept}\texttt{...}}&\\
 \cline{1-2}
+\raggedright e\-r\-r\-o\-r\-A\-t\-S\-p\-e\-c\-i\-f\-i\-e\-d\-L\-o\-c\-a\-t\-i\-o\-n\- & \raggedright \textbf{Value:} 
+{\tt \texttt{'}\texttt{theia: Error: The FreeCAD library was not found at the s}\texttt{...}}&\\
+\cline{1-2}
+\raggedright e\-r\-r\-o\-r\-W\-h\-e\-r\-e\-I\-s\- & \raggedright \textbf{Value:} 
+{\tt \texttt{'}\texttt{theia: Error: Unix command {\textbackslash}'whereis freecad{\textbackslash}' did not y}\texttt{...}}&\\
+\cline{1-2}
+\raggedright e\-r\-r\-o\-r\-U\-n\-k\-n\-o\-w\-n\- & \raggedright \textbf{Value:} 
+{\tt \texttt{'}\texttt{theia: Error: \%s was used as the source directory for th}\texttt{...}}&\\
+\cline{1-2}
 \raggedright \_\-\_\-p\-a\-c\-k\-a\-g\-e\-\_\-\_\- & \raggedright \textbf{Value:} 
 {\tt None}&\\
 \cline{1-2}

doc/src/theia.helpers.settings-module.tex

@@ -3,7 +3,7 @@
 % Module theia.helpers.settings
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

doc/src/theia.helpers.tools-module.tex

@@ -3,7 +3,7 @@
 % Module theia.helpers.tools
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

doc/src/theia.helpers.units-module.tex

@@ -3,7 +3,7 @@
 % Module theia.helpers.units
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

doc/src/theia.main-module.tex

@@ -3,7 +3,7 @@
 % Module theia.main
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

doc/src/theia.optics-module.tex

@@ -3,7 +3,7 @@
 % Package theia.optics
 %
 % Generated by epydoc 3.0.1
-% [Tue Jun 13 14:30:45 2017]
+% [Tue Jul 11 10:03:01 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -19,7 +19,7 @@ \section{Package theia.optics}
 It provides the necessary classes and functions in order to calculate the 
 gaussian beams of the setup.
 
-\textbf{Version:} 0.1.0
+\textbf{Version:} 0.1.1
 
 
 
@@ -62,6 +62,12 @@ \subsection{Modules}
 
   \textit{(Section \ref{theia:optics:component}, p.~\pageref{theia:optics:component})}
 
+\item \textbf{ghost}: Defines the Ghost class for theia.
+
+
+
+  \textit{(Section \ref{theia:optics:ghost}, p.~\pageref{theia:optics:ghost})}
+
 \item \textbf{lens}: Defines the Lens class for theia.