0.1.2!

REQUIREMENTS

@@ -6,4 +6,4 @@ Compiling the documentation requires:
     pdflatex
 
 Full-fledged usage requires:
-    FreeCAD libraries (available in major GNU?Linux distros)
+    FreeCAD libraries (available in major GNU/Linux distros)

doc/src/api.ind

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

doc/src/api.tex

@@ -3,7 +3,7 @@
 % Include File
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 \documentclass{article}
 \usepackage{alltt, parskip, fancyhdr, boxedminipage}
@@ -109,6 +109,7 @@
 
 \include{theia-module}
 \include{theia.helpers-module}
+\include{theia.helpers.core-module}
 \include{theia.helpers.geometry-module}
 \include{theia.helpers.interaction-module}
 \include{theia.helpers.settings-module}

doc/src/quickref.tex

@@ -33,11 +33,12 @@
 \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}
-
+\begin{multicols}{3}
+\paragraph{Keys.} \tt{bo} (new coordinate origin), \tt{bm} (input beam), \tt{mr} (mirror), \tt{th}  (thin lens), \tt{tk} (thick lens), \tt{bd} (beam dump), \tt{gh} (ghost surface)
 \paragraph{Units.}(km, m = 1., cm, mm, um, nm), (kW, W = 1., mW, uW, nW), (THz, GHz, MHz, kHz, Hz = 1., mHz, uHz), (ppm = 1.e-6, rad = 1., deg), pi
 \paragraph{Functions.} sin, cos, tan, arcsin, arccos, arctan, sqrt, exp
 
+
 \paragraph{Notes.}\begin{itemize}
 \item \tt{Theta}, \tt{Phi} are spherical coordinates around $e_Z$ and \tt{Phi = 0.} $\leftrightarrow~ + e_X$
 \item All constructors can be called without arguments, all parameters have default values.

doc/src/theia-module.tex

@@ -3,7 +3,7 @@
 % Package theia
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -17,15 +17,15 @@ \section{Package theia}
 This is theia, a Python package for Gaussian ray tracing in 3D optical 
 setups.
 
-\textbf{Version:} 0.1.1
+\textbf{Version:} 0.1.2
 
 
 
-\textbf{Author:} R. Duque
+\textbf{Author:} Raphaël Duque
 
 
 
-\textbf{Copyright:} Copyright 2017, R. Duque
+\textbf{Copyright:} Copyright 2017, Raphaël Duque
 
 
 
@@ -50,6 +50,12 @@ \subsection{Modules}
 
   \begin{itemize}
 \setlength{\parskip}{0ex}
+    \item \textbf{core}: Defines some additional spice for theia.
+
+
+
+  \textit{(Section \ref{theia:helpers:core}, p.~\pageref{theia:helpers:core})}
+
     \item \textbf{geometry}: Geometry module for theia.
 
 

doc/src/theia.helpers-module.tex

@@ -3,7 +3,7 @@
 % Package theia.helpers
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -18,15 +18,15 @@ \section{Package theia.helpers}
 
 It provides it provides all sorts of generic functions for theia.
 
-\textbf{Version:} 0.1.1
+\textbf{Version:} 0.1.2
 
 
 
-\textbf{Author:} R. Duque
+\textbf{Author:} Raphaël Duque
 
 
 
-\textbf{Copyright:} Copyright 2017, R. Duque
+\textbf{Copyright:} Copyright 2017, Raphaël Duque
 
 
 
@@ -43,6 +43,12 @@ \subsection{Modules}
 
 \begin{itemize}
 \setlength{\parskip}{0ex}
+\item \textbf{core}: Defines some additional spice for theia.
+
+
+
+  \textit{(Section \ref{theia:helpers:core}, p.~\pageref{theia:helpers:core})}
+
 \item \textbf{geometry}: Geometry module for theia.
 
 

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

@@ -0,0 +1,119 @@
+%
+% API Documentation for theia
+% Module theia.helpers.core
+%
+% Generated by epydoc 3.0.1
+% [Mon Jul 24 12:23:27 2017]
+%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%                          Module Description                           %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}|(}
+\section{Module theia.helpers.core}
+
+    \label{theia:helpers:core}
+Defines some additional spice for theia.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%                               Functions                               %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+  \subsection{Functions}
+
+    \label{theia:helpers:core:gbeamInit}
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}!theia.helpers.core.gbeamInit \textit{(function)}}
+
+    \vspace{0.5ex}
+
+\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}
+
+    \raggedright \textbf{gbeamInit}(\textit{menu})
+
+    \vspace{-1.5ex}
+
+    \rule{\textwidth}{0.5\fboxrule}
+\setlength{\parskip}{2ex}
+    Pick in the menu.
+
+\setlength{\parskip}{1ex}
+    \end{boxedminipage}
+
+    \label{theia:helpers:core:hang}
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}!theia.helpers.core.hang \textit{(function)}}
+
+    \vspace{0.5ex}
+
+\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}
+
+    \raggedright \textbf{hang}()
+
+    \vspace{-1.5ex}
+
+    \rule{\textwidth}{0.5\fboxrule}
+\setlength{\parskip}{2ex}
+    The whole hangman game, from welcome to exit.
+
+\setlength{\parskip}{1ex}
+    \end{boxedminipage}
+
+    \label{theia:helpers:core:magazzu}
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}!theia.helpers.core.magazzu \textit{(function)}}
+
+    \vspace{0.5ex}
+
+\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}
+
+    \raggedright \textbf{magazzu}()
+
+\setlength{\parskip}{2ex}
+\setlength{\parskip}{1ex}
+    \end{boxedminipage}
+
+    \label{theia:helpers:core:pong}
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}!theia.helpers.core.pong \textit{(function)}}
+
+    \vspace{0.5ex}
+
+\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}
+
+    \raggedright \textbf{pong}()
+
+\setlength{\parskip}{2ex}
+\setlength{\parskip}{1ex}
+    \end{boxedminipage}
+
+    \label{theia:helpers:core:pendu}
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}!theia.helpers.core.pendu \textit{(function)}}
+
+    \vspace{0.5ex}
+
+\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}
+
+    \raggedright \textbf{pendu}()
+
+\setlength{\parskip}{2ex}
+\setlength{\parskip}{1ex}
+    \end{boxedminipage}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%                               Variables                               %%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+  \subsection{Variables}
+
+    \vspace{-1cm}
+\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
+\cline{1-2}
+\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
+\cline{1-2}
+\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
+\endlastfoot\raggedright \_\-\_\-p\-a\-c\-k\-a\-g\-e\-\_\-\_\- & \raggedright \textbf{Value:} 
+{\tt \texttt{'}\texttt{theia.helpers}\texttt{'}}&\\
+\cline{1-2}
+\end{longtable}
+
+    \index{theia \textit{(package)}!theia.helpers \textit{(package)}!theia.helpers.core \textit{(module)}|)}

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

@@ -3,7 +3,7 @@
 % Module theia.helpers.geometry
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -201,7 +201,7 @@ \section{Module theia.helpers.geometry}
 
     a,b: unit 3D vectors. [3D np.arrays]
 
-    Returns an np.array such that np.matmul(M,a) == b.
+    Returns an np.array such that np.dot(M,a) == b.
 
 \setlength{\parskip}{1ex}
     \end{boxedminipage}

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

@@ -3,7 +3,7 @@
 % Module theia.helpers.interaction
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -32,8 +32,11 @@ \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 l\-h\-e\-l\-p\- & \raggedright \textbf{Value:} 
+{\tt \texttt{'}\texttt{specify the FreeCAD library location. If none is specifi}\texttt{...}}&\\
+\cline{1-2}
 \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{...}}&\\
+{\tt \texttt{...}}&\\
 \cline{1-2}
 \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{...}}&\\

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

@@ -3,7 +3,7 @@
 % Module theia.helpers.settings
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

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

@@ -3,7 +3,7 @@
 % Module theia.helpers.tools
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

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

@@ -3,7 +3,7 @@
 % Module theia.helpers.units
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

doc/src/theia.main-module.tex

@@ -3,7 +3,7 @@
 % Module theia.main
 %
 % Generated by epydoc 3.0.1
-% [Tue Jul 11 10:03:01 2017]
+% [Mon Jul 24 12:23:27 2017]
 %
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%