Package theia :: Package helpers :: Module interaction
[hide private]
[frames] | no frames]

Module interaction

source code

Module to define interaction functions for theia.

Variables [hide private]
  usage = 'Usage: theia [options] FNAME\n\nArguments:\n FNAME\t...
  lhelp = 'specify the FreeCAD library location. If none is spec...
  shelp = 'Exclude beams propagating inside optics from text out...
  welcome = ...
  errorRecursion = '\n\nIt looks like you reached the maximum re...
  errorAtSpecifiedLocation = 'theia: Error: The FreeCAD library ...
  errorWhereIs = 'theia: Error: Unix command \'whereis freecad\'...
  errorWhereIsNotFound = 'theia: Error: It seems that the Unix u...
  errorUnknown = 'theia: Error: %s was used as the source direct...
  __package__ = None
Variables Details [hide private]

usage

Value:
'''Usage: theia [options] FNAME

Arguments:
  FNAME\t\t .tia format input file name.'''

lhelp

Value:
'specify the FreeCAD library location. If none is specified, theia fin\
ds it using the Unix `whereis` command. If option \'-c\', \'--no-CAD\'\
  is used, the FreeCAD search and import are skipped as a whole.'

shelp

Value:
'Exclude beams propagating inside optics from text output, terminal ou\
tput and CAD rendering files. This also changes the way beams are refe\
renced to in these files and in the terminal output.'

welcome

Value:
u'''
	theia (C) 2017 Raphaël Duque
	License: GNU GPLv3+ <http://gnu.org/licenses/gpl.html>
	This is free software: you are free to change and redistribute it.
	There is ABSOLUTELY NO WARRANTY, to the extent permitted by law.
'''

errorRecursion

Value:
'''

It looks like you reached the maximum recursion depth of your Python
implementation (generally around 1000). The beam tracer builds the bea\
m tree
recursively and in your case the recursion went to far. The order and \
threshold
simulation parameters were made to prevent this situation. What you ca\
...

errorAtSpecifiedLocation

Value:
'''theia: Error: The FreeCAD library was not found at the specified lo\
cation %s. Usually it is in /usr/lib/freecad/lib. If you are not sure,\
 omit the \'-l\', \'--FREECAD-lib\' option and theia will find the lib\
rary on its own.
Aborting.'''

errorWhereIs

Value:
'''theia: Error: Unix command \'whereis freecad\' did not yield any di\
rectory. Please make sure you have FreeCAD installed and that library \
location is in your $PATH.
Aborting'''

errorWhereIsNotFound

Value:
'''theia: Error: It seems that the Unix utility `whereis ` is not inst\
alled, thus theia cannot find the FreeCAD libraries.
Either specify their location with the \'-l, --FreeCAD-libs\' option, \
or use the \'-c --no-CAD\' option to skip the CAD file writing step.''\
'

errorUnknown

Value:
'''theia: Error: %s was used as the source directory for the FreeCAD l\
ibrary but an error occured, make sure your FreeCAD build is correct.
Aborting.'''