3.1.2.12. opengate.helpers

3.1.2.12.1. Module Contents

3.1.2.12.1.1. Functions

fatal(s)
warning(s)
raise_except(s)
assert_equal_dic(d1, d2[, name])
g4_units(→ float)
g4_best_unit(value, unit_type)
assert_key(key, d)
assert_keys(keys, d)
indent(amount, text[, ch])	Prefix the text with indent spaces
assert_unique_element_name(elements, name)
make_builders(class_names)	Consider a list of Classname. For each, it build a key/value, with:
read_mac_file_to_commands(filename)
check_filename_type(filename)
get_random_folder_name([size, create])
import_gaga_phsp()
import_garf()
get_rnd_seed(seed)
DDF()	Debug print current Function name
DD(arg)	Debug print variable name and its value
print_dic(dic)
print_opengate_info()	Print information about OpenGate and the environment

3.1.2.12.1.2. Attributes

color_error
color_warning
color_ok

opengate.helpers.color_error

opengate.helpers.color_warning

opengate.helpers.color_ok

opengate.helpers.fatal(s)

opengate.helpers.warning(s)

opengate.helpers.raise_except(s)

opengate.helpers.assert_equal_dic(d1, d2, name='')

opengate.helpers.g4_units(name: str) → float

opengate.helpers.g4_best_unit(value, unit_type)

opengate.helpers.assert_key(key: str, d: box.Box)

opengate.helpers.assert_keys(keys: list, d: box.Box)

opengate.helpers.indent(amount, text, ch=' ')

Prefix the text with indent spaces https://stackoverflow.com/questions/8234274/how-to-indent-the-contents-of-a-multi-line-string

opengate.helpers.assert_unique_element_name(elements, name)

opengate.helpers.make_builders(class_names)

Consider a list of Classname. For each, it build a key/value, with: - the type of the class as key - and a lambda function that create an object of this class as value

opengate.helpers.read_mac_file_to_commands(filename)

opengate.helpers.check_filename_type(filename)

opengate.helpers.get_random_folder_name(size=8, create=True)

opengate.helpers.import_gaga_phsp()

opengate.helpers.import_garf()

opengate.helpers.get_rnd_seed(seed)

opengate.helpers.DDF()

Debug print current Function name

opengate.helpers.DD(arg)

Debug print variable name and its value

opengate.helpers.print_dic(dic)

opengate.helpers.print_opengate_info()

Print information about OpenGate and the environment