From: Christian Van Wambeke Date: Wed, 2 May 2018 14:46:55 +0000 (+0200) Subject: fix utilsSat check_config_has_application log_res_step X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=288efce5937ce910e1fcdcffb4e4f042a813bd39;p=tools%2Fsat.git fix utilsSat check_config_has_application log_res_step --- diff --git a/commands/application.py b/commands/application.py index 186a178..32b2e1e 100644 --- a/commands/application.py +++ b/commands/application.py @@ -42,7 +42,7 @@ class Command(_BaseCommand): | Warning: | It works only for SALOME 6. | Use the 'launcher' command for newer versions of SALOME - | + | | Examples: | >> sat application SALOME-6.6.0 """ @@ -96,8 +96,9 @@ Note: this command will ssh to retrieve information to each machine in the l logger = self.getLogger() options = self.getOptions() - # check for product - UTS.check_config_has_application( config ) + # check for APPLICATION + rc = UTS.check_config_has_application(config) + if not rc.isOk(): return rc application = config.VARS.application logger.info(_("Building application for
%s\n") % application) diff --git a/commands/check.py b/commands/check.py index 3910f88..a3d8b84 100644 --- a/commands/check.py +++ b/commands/check.py @@ -19,6 +19,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand CHECK_PROPERTY = "has_unit_tests" @@ -71,8 +72,7 @@ Optional: products to configure. # check that the command has been called with an application - src.check_config_has_application( config ) - + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -139,16 +139,6 @@ def get_products_list(options, cfg, logger): return products_infos -def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20)) - logger.info("\r%s%s" % (header, step)) - -def log_res_step(logger, res): - if res == 0: - logger.debug("\n") - else: - logger.debug("\n") - def check_all_products(config, products_infos, logger): """ Execute the proper configuration commands @@ -215,7 +205,7 @@ is not defined in the definition of %(name)\n""") % p_name logger.warning(msg) if ignored or not cmd_found: - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.debug("==== %s %s\n" % (p_name, "IGNORED")) if not cmd_found: return 1 @@ -226,16 +216,16 @@ is not defined in the definition of %(name)\n""") % p_name builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) len_end_line = 20 # Launch the check - log_step(logger, header, "CHECK") + UTS.log_step(logger, header, "CHECK") res = builder.check(command=command) - log_res_step(logger, res) + UTS.log_res_step(logger, res) # Log the result if res > 0: diff --git a/commands/clean.py b/commands/clean.py index 155fa0c..aad8fb5 100644 --- a/commands/clean.py +++ b/commands/clean.py @@ -21,6 +21,7 @@ import re import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand # Compatibility python 2/3 for input function @@ -92,7 +93,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Verify the --properties option if options.properties: diff --git a/commands/compile.py b/commands/compile.py index bd58844..3df0c2f 100644 --- a/commands/compile.py +++ b/commands/compile.py @@ -21,6 +21,7 @@ import os import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS import src.pyconf as PYCONF from src.salomeTools import _BaseCommand @@ -118,7 +119,7 @@ class Command(_BaseCommand): return 0 # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Print some informations nameApp = str(config.VARS.application) @@ -371,18 +372,6 @@ def check_dependencies(config, p_name_p_info): l_depends_not_installed.append(p_name_father) return l_depends_not_installed -def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 30)) - logger.info("\r%s%s" % (header, step)) - logger.debug("\n==== %s \n" % step) - -def log_res_step(logger, res): - if res == 0: - logger.debug("\n") - else: - logger.debug("\n") - - def compile_all_products(sat, config, options, products_infos, logger): """ Execute the proper configuration commands @@ -411,20 +400,20 @@ def compile_all_products(sat, config, options, products_infos, logger): "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.info("\n") continue # Do nothing if the product is native if src.product.product_is_native(p_info): - log_step(logger, header, "native") + UTS.log_step(logger, header, "native") logger.info("\n") continue # Clean the build and the install directories # if the corresponding options was called if options.clean_all: - log_step(logger, header, "CLEAN BUILD AND INSTALL") + UTS.log_step(logger, header, "CLEAN BUILD AND INSTALL") sat.clean(config.VARS.application + " --products " + p_name + " --build --install", @@ -435,7 +424,7 @@ def compile_all_products(sat, config, options, products_infos, logger): # Clean the the install directory # if the corresponding option was called if options.clean_install and not options.clean_all: - log_step(logger, header, "CLEAN INSTALL") + UTS.log_step(logger, header, "CLEAN INSTALL") sat.clean(config.VARS.application + " --products " + p_name + " --install", @@ -460,7 +449,7 @@ def compile_all_products(sat, config, options, products_infos, logger): # Check if the dependencies are installed l_depends_not_installed = check_dependencies(config, p_name_info) if len(l_depends_not_installed) > 0: - log_step(logger, header, "") + UTS.log_step(logger, header, "") msg = _("the following products are mandatory:\n") for prod_name in l_depends_not_installed: msg += "%s\n" % prod_name @@ -491,7 +480,7 @@ def compile_all_products(sat, config, options, products_infos, logger): else: # Clean the build directory if the compilation and tests succeed if options.clean_build_after: - log_step(logger, header, "CLEAN BUILD") + UTS.log_step(logger, header, "CLEAN BUILD") sat.clean(config.VARS.application + " --products " + p_name + " --build", @@ -575,7 +564,7 @@ def compile_product(sat, p_name_info, config, options, logger, header, len_end): if options.check: # Do the unit tests (call the check command) - log_step(logger, header, "CHECK") + UTS.log_step(logger, header, "CHECK") res_check = sat.check( config.VARS.application + " --products " + p_name, verbose = 0, @@ -615,11 +604,11 @@ def compile_product_cmake_autotools(sat, # Logging and sat command call for configure step len_end_line = len_end - log_step(logger, header, "CONFIGURE") + UTS.log_step(logger, header, "CONFIGURE") res_c = sat.configure(config.VARS.application + " --products " + p_name, verbose = 0, logger_add_link = logger) - log_res_step(logger, res_c) + UTS.log_res_step(logger, res_c) res += res_c if res_c > 0: @@ -633,10 +622,10 @@ def compile_product_cmake_autotools(sat, # it is executed during make step scrit_path_display = UTS.label( p_info.compil_script) - log_step(logger, header, "SCRIPT " + scrit_path_display) + UTS.log_step(logger, header, "SCRIPT " + scrit_path_display) len_end_line = len(scrit_path_display) else: - log_step(logger, header, "MAKE") + UTS.log_step(logger, header, "MAKE") make_arguments = config.VARS.application + " --products " + p_name # Get the make_flags option if there is any if options.makeflags: @@ -644,21 +633,21 @@ def compile_product_cmake_autotools(sat, res_m = sat.make(make_arguments, verbose = 0, logger_add_link = logger) - log_res_step(logger, res_m) + UTS.log_res_step(logger, res_m) res += res_m if res_m > 0: error_step = "MAKE" else: # Logging and sat command call for make install step - log_step(logger, header, "MAKE INSTALL") + UTS.log_step(logger, header, "MAKE INSTALL") res_mi = sat.makeinstall(config.VARS.application + " --products " + p_name, verbose = 0, logger_add_link = logger) - log_res_step(logger, res_mi) + UTS.log_res_step(logger, res_mi) res += res_mi if res_mi > 0: @@ -691,12 +680,12 @@ def compile_product_script(sat, # Logging and sat command call for the script step scrit_path_display = UTS.label(p_info.compil_script) - log_step(logger, header, "SCRIPT " + scrit_path_display) + UTS.log_step(logger, header, "SCRIPT " + scrit_path_display) len_end_line = len_end + len(scrit_path_display) res = sat.script(config.VARS.application + " --products " + p_name, verbose = 0, logger_add_link = logger) - log_res_step(logger, res) + UTS.log_res_step(logger, res) return res, len_end_line, error_step diff --git a/commands/config.py b/commands/config.py index 38b58a1..48da2ca 100644 --- a/commands/config.py +++ b/commands/config.py @@ -21,6 +21,7 @@ import os import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand import src.configManager as CFGMGR import src.system as SYSS @@ -148,7 +149,7 @@ If a name is given the new config file takes the given name.""")) # to ~/.salomeTools/Applications/LOCAL_.pyconf elif options.copy: # product is required - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # get application file path source = config.VARS.application + '.pyconf' diff --git a/commands/configure.py b/commands/configure.py index e26d0a8..597cd57 100644 --- a/commands/configure.py +++ b/commands/configure.py @@ -20,6 +20,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -75,7 +76,7 @@ class Command(_BaseCommand): # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -143,18 +144,6 @@ def get_products_list(options, cfg, logger): return products_infos -def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20)) - logger.info("\r%s%s" % (header, step)) - logger.debug("\n==== %s \n" % UTS.info(step)) - logger.flush() - -def log_res_step(logger, res): - if res == 0: - logger.debug("") - else: - logger.debug("") - def configure_all_products(config, products_infos, conf_option, logger): """ Execute the proper configuration commands @@ -200,7 +189,7 @@ def configure_product(p_name_info, conf_option, config, logger): "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.info("\n") return 0 @@ -209,26 +198,26 @@ def configure_product(p_name_info, conf_option, config, logger): builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute buildconfigure, configure if the product is autotools # Execute cmake if the product is cmake res = 0 if src.product.product_is_autotools(p_info): - log_step(logger, header, "BUILDCONFIGURE") + UTS.log_step(logger, header, "BUILDCONFIGURE") res_bc = builder.build_configure() - log_res_step(logger, res_bc) + UTS.log_res_step(logger, res_bc) res += res_bc - log_step(logger, header, "CONFIGURE") + UTS.log_step(logger, header, "CONFIGURE") res_c = builder.configure(conf_option) - log_res_step(logger, res_c) + UTS.log_res_step(logger, res_c) res += res_c if src.product.product_is_cmake(p_info): - log_step(logger, header, "CMAKE") + UTS.log_step(logger, header, "CMAKE") res_cm = builder.cmake(conf_option) - log_res_step(logger, res_cm) + UTS.log_res_step(logger, res_cm) res += res_cm # Log the result diff --git a/commands/environ.py b/commands/environ.py index 04f288c..c9735de 100644 --- a/commands/environ.py +++ b/commands/environ.py @@ -78,7 +78,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command was called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() if options.products is None: environ_info = None diff --git a/commands/job.py b/commands/job.py index e40bbdf..1afc149 100644 --- a/commands/job.py +++ b/commands/job.py @@ -20,6 +20,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## diff --git a/commands/launcher.py b/commands/launcher.py index e19b987..abed056 100644 --- a/commands/launcher.py +++ b/commands/launcher.py @@ -25,6 +25,7 @@ import stat import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -67,7 +68,7 @@ class Command(_BaseCommand): options = self.getOptions() # Verify that the command was called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Determine the launcher name (from option, profile section or by default "salome") if options.name: diff --git a/commands/make.py b/commands/make.py index 3c2f2db..ec3dff5 100644 --- a/commands/make.py +++ b/commands/make.py @@ -70,7 +70,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -138,19 +138,6 @@ def get_products_list(options, cfg, logger): return products_infos -def log_step(logger, header, step): - msg = "\r%s%s" % (header, " " * 20) - msg += "\r%s%s" % (header, step) - logger.info(msg) - logger.debug("\n==== %s \n" % UTS.info(step)) - -def log_res_step(logger, res): - if res == 0: - logger.debug("\n") - else: - logger.debug("\n") - - def make_all_products(config, products_infos, make_option, logger): """ Execute the proper configuration commands @@ -195,7 +182,7 @@ def make_product(p_name_info, make_option, config, logger): if ("properties" in p_info and \ "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") return 0 # Instantiate the class that manages all the construction commands @@ -203,21 +190,21 @@ def make_product(p_name_info, make_option, config, logger): builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute buildconfigure, configure if the product is autotools # Execute cmake if the product is cmake len_end_line = 20 nb_proc, make_opt_without_j = get_nb_proc(p_info, config, make_option) - log_step(logger, header, "MAKE -j" + str(nb_proc)) + UTS.log_step(logger, header, "MAKE -j" + str(nb_proc)) if src.architecture.is_windows(): res = builder.wmake(nb_proc, make_opt_without_j) else: res = builder.make(nb_proc, make_opt_without_j) - log_res_step(logger, res) + UTS.log_res_step(logger, res) # Log the result if res > 0: diff --git a/commands/makeinstall.py b/commands/makeinstall.py index ad3344d..221881f 100644 --- a/commands/makeinstall.py +++ b/commands/makeinstall.py @@ -20,6 +20,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -67,7 +68,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -131,17 +132,6 @@ def get_products_list(options, cfg, logger): return products_infos -def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20), 3) - logger.info("\r%s%s" % (header, step), 3) - logger.debug("\n==== %s \n" % UTS.info(step), 4) - -def log_res_step(logger, res): - if res == 0: - logger.debug("\n") - else: - logger.debug("\n") - def makeinstall_all_products(config, products_infos, logger): """ Execute the proper configuration commands @@ -185,7 +175,7 @@ def makeinstall_product(p_name_info, config, logger): if ("properties" in p_info and \ "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") return RCO.ReturnCode("OK", "product %s is not compilable" % p_name) # Instantiate the class that manages all the construction commands @@ -193,17 +183,17 @@ def makeinstall_product(p_name_info, config, logger): builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute buildconfigure, configure if the product is autotools # Execute cmake if the product is cmake res = 0 if not src.product.product_has_script(p_info): - log_step(logger, header, "MAKE INSTALL") + UTS.log_step(logger, header, "MAKE INSTALL") res_m = builder.install() - log_res_step(logger, res_m) + UTS.log_res_step(logger, res_m) res += res_m # Log the result diff --git a/commands/patch.py b/commands/patch.py index d99a3e5..631079e 100644 --- a/commands/patch.py +++ b/commands/patch.py @@ -70,7 +70,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Print some informations logger.info("Patching sources of the application %s\n" % \ diff --git a/commands/prepare.py b/commands/prepare.py index e6eca54..1c23d64 100644 --- a/commands/prepare.py +++ b/commands/prepare.py @@ -22,6 +22,7 @@ import re import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -75,7 +76,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() products_infos = self.get_products_list(options, config, logger) diff --git a/commands/profile.py b/commands/profile.py index cd0988e..80b427c 100644 --- a/commands/profile.py +++ b/commands/profile.py @@ -22,6 +22,7 @@ import subprocess import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS import src.pyconf as PYCONF from src.salomeTools import _BaseCommand diff --git a/commands/script.py b/commands/script.py index 1cd12ab..20e8789 100644 --- a/commands/script.py +++ b/commands/script.py @@ -20,6 +20,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -72,7 +73,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -143,17 +144,6 @@ def get_products_list(options, cfg, logger): return products_infos -def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20)) - logger.info("\r%s%s" % (header, step)) - logger.debug("\n==== %s \n" % UTS.info(step)) - -def log_res_step(logger, res): - if res == 0: - logger.debug("\n") - else: - logger.debug("\n") - def run_script_all_products(config, products_infos, nb_proc, logger): """Execute the script in each product build directory. @@ -201,7 +191,7 @@ def run_script_of_product(p_name_info, nb_proc, config, logger): "compilation" in p_info.properties and \ p_info.properties.compilation == "no" if ( test1 or (not src.product.product_has_script(p_info)) ): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.info("\n") return 0 @@ -210,17 +200,17 @@ def run_script_of_product(p_name_info, nb_proc, config, logger): builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute the script len_end_line = 20 script_path_display = UTS.label(p_info.compil_script) - log_step(logger, header, "SCRIPT " + script_path_display) + UTS.log_step(logger, header, "SCRIPT " + script_path_display) len_end_line += len(script_path_display) res = builder.do_script_build(p_info.compil_script, number_of_proc=nb_proc) - log_res_step(logger, res) + UTS.log_res_step(logger, res) # Log the result if res > 0: diff --git a/commands/shell.py b/commands/shell.py index ccfeafe..dd723f1 100644 --- a/commands/shell.py +++ b/commands/shell.py @@ -22,6 +22,7 @@ import subprocess import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## diff --git a/commands/source.py b/commands/source.py index e547b59..f3f9c23 100644 --- a/commands/source.py +++ b/commands/source.py @@ -22,6 +22,7 @@ import shutil import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand import src.system as SYSS @@ -70,7 +71,7 @@ class Command(_BaseCommand): options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Print some informations logger.info(_('Getting sources of the application %s\n') % \ diff --git a/doc/README b/doc/README index f5ccaa7..446cec1 100644 --- a/doc/README +++ b/doc/README @@ -2,6 +2,11 @@ # needs sphinx-build # to make doc html +cd sat5_1 + +# to make doc html apidoc on commands dir ok +export PYTHONPATH=`pwd` + cd doc make html firefox build/html/index.html & diff --git a/doc/build/doctrees/apidoc_commands/commands.doctree b/doc/build/doctrees/apidoc_commands/commands.doctree index 3d55679..df7ad6e 100644 Binary files a/doc/build/doctrees/apidoc_commands/commands.doctree and b/doc/build/doctrees/apidoc_commands/commands.doctree differ diff --git a/doc/build/doctrees/apidoc_commands/modules.doctree b/doc/build/doctrees/apidoc_commands/modules.doctree index 2c42178..bdb4eb3 100644 Binary files a/doc/build/doctrees/apidoc_commands/modules.doctree and b/doc/build/doctrees/apidoc_commands/modules.doctree differ diff --git a/doc/build/doctrees/apidoc_src/modules.doctree b/doc/build/doctrees/apidoc_src/modules.doctree index bcbbc7c..c319c1f 100644 Binary files a/doc/build/doctrees/apidoc_src/modules.doctree and b/doc/build/doctrees/apidoc_src/modules.doctree differ diff --git a/doc/build/doctrees/apidoc_src/src.colorama.doctree b/doc/build/doctrees/apidoc_src/src.colorama.doctree index ff45f4e..f78b303 100644 Binary files a/doc/build/doctrees/apidoc_src/src.colorama.doctree and b/doc/build/doctrees/apidoc_src/src.colorama.doctree differ diff --git a/doc/build/doctrees/apidoc_src/src.doctree b/doc/build/doctrees/apidoc_src/src.doctree index 05020b4..4a993d8 100644 Binary files a/doc/build/doctrees/apidoc_src/src.doctree and b/doc/build/doctrees/apidoc_src/src.doctree differ diff --git a/doc/build/doctrees/apidoc_src/src.example.doctree b/doc/build/doctrees/apidoc_src/src.example.doctree index 62fe49b..996d8c2 100644 Binary files a/doc/build/doctrees/apidoc_src/src.example.doctree and b/doc/build/doctrees/apidoc_src/src.example.doctree differ diff --git a/doc/build/doctrees/commands/application.doctree b/doc/build/doctrees/commands/application.doctree index 503e3f7..3b04188 100644 Binary files a/doc/build/doctrees/commands/application.doctree and b/doc/build/doctrees/commands/application.doctree differ diff --git a/doc/build/doctrees/commands/clean.doctree b/doc/build/doctrees/commands/clean.doctree index 843bf82..e0c7a49 100644 Binary files a/doc/build/doctrees/commands/clean.doctree and b/doc/build/doctrees/commands/clean.doctree differ diff --git a/doc/build/doctrees/commands/compile.doctree b/doc/build/doctrees/commands/compile.doctree index 482cdac..7f269a6 100644 Binary files a/doc/build/doctrees/commands/compile.doctree and b/doc/build/doctrees/commands/compile.doctree differ diff --git a/doc/build/doctrees/commands/config.doctree b/doc/build/doctrees/commands/config.doctree index 326cbf2..14d0439 100644 Binary files a/doc/build/doctrees/commands/config.doctree and b/doc/build/doctrees/commands/config.doctree differ diff --git a/doc/build/doctrees/commands/environ.doctree b/doc/build/doctrees/commands/environ.doctree index 4c8bac5..9690c50 100644 Binary files a/doc/build/doctrees/commands/environ.doctree and b/doc/build/doctrees/commands/environ.doctree differ diff --git a/doc/build/doctrees/commands/generate.doctree b/doc/build/doctrees/commands/generate.doctree index c4a454c..5289d9b 100644 Binary files a/doc/build/doctrees/commands/generate.doctree and b/doc/build/doctrees/commands/generate.doctree differ diff --git a/doc/build/doctrees/commands/launcher.doctree b/doc/build/doctrees/commands/launcher.doctree index b399e57..e0485e2 100644 Binary files a/doc/build/doctrees/commands/launcher.doctree and b/doc/build/doctrees/commands/launcher.doctree differ diff --git a/doc/build/doctrees/commands/log.doctree b/doc/build/doctrees/commands/log.doctree index 2273389..9365cc2 100644 Binary files a/doc/build/doctrees/commands/log.doctree and b/doc/build/doctrees/commands/log.doctree differ diff --git a/doc/build/doctrees/commands/package.doctree b/doc/build/doctrees/commands/package.doctree index 2e696d2..6f8576a 100644 Binary files a/doc/build/doctrees/commands/package.doctree and b/doc/build/doctrees/commands/package.doctree differ diff --git a/doc/build/doctrees/commands/prepare.doctree b/doc/build/doctrees/commands/prepare.doctree index ba7e36d..487a08a 100644 Binary files a/doc/build/doctrees/commands/prepare.doctree and b/doc/build/doctrees/commands/prepare.doctree differ diff --git a/doc/build/doctrees/configuration.doctree b/doc/build/doctrees/configuration.doctree index bb51e37..de73cda 100644 Binary files a/doc/build/doctrees/configuration.doctree and b/doc/build/doctrees/configuration.doctree differ diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle index 4959cb6..7f8fdb3 100644 Binary files a/doc/build/doctrees/environment.pickle and b/doc/build/doctrees/environment.pickle differ diff --git a/doc/build/doctrees/index.doctree b/doc/build/doctrees/index.doctree index df9b1bf..47dd8c7 100644 Binary files a/doc/build/doctrees/index.doctree and b/doc/build/doctrees/index.doctree differ diff --git a/doc/build/doctrees/installation_of_sat.doctree b/doc/build/doctrees/installation_of_sat.doctree index 639a0ac..5dd5e82 100644 Binary files a/doc/build/doctrees/installation_of_sat.doctree and b/doc/build/doctrees/installation_of_sat.doctree differ diff --git a/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree b/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree index 00fe84e..7c1b914 100644 Binary files a/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree and b/doc/build/doctrees/release_notes/release_notes_5.0.0.doctree differ diff --git a/doc/build/doctrees/usage_of_sat.doctree b/doc/build/doctrees/usage_of_sat.doctree index b0d176f..6af9b50 100644 Binary files a/doc/build/doctrees/usage_of_sat.doctree and b/doc/build/doctrees/usage_of_sat.doctree differ diff --git a/doc/build/doctrees/write_command.doctree b/doc/build/doctrees/write_command.doctree index b4f417e..f9d77bb 100644 Binary files a/doc/build/doctrees/write_command.doctree and b/doc/build/doctrees/write_command.doctree differ diff --git a/doc/build/html/.buildinfo b/doc/build/html/.buildinfo index e2e4145..83f65b3 100644 --- a/doc/build/html/.buildinfo +++ b/doc/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 5297f00c73a42e7ad92f1035fc2613c1 +config: d7bdbf2f29518819f629c0dfc8f7331a tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc/build/html/_modules/commands.html b/doc/build/html/_modules/commands.html index fc8ec8d..53af5f7 100644 --- a/doc/build/html/_modules/commands.html +++ b/doc/build/html/_modules/commands.html @@ -1,41 +1,28 @@ + - + - commands — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -154,12 +141,14 @@
@@ -170,8 +159,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/application.html b/doc/build/html/_modules/commands/application.html index e30d8d4..f16108f 100644 --- a/doc/build/html/_modules/commands/application.html +++ b/doc/build/html/_modules/commands/application.html @@ -1,41 +1,28 @@ + - + - commands.application — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -88,7 +75,7 @@ | Warning: | It works only for SALOME 6. | Use the 'launcher' command for newer versions of SALOME - | + | | Examples: | >> sat application SALOME-6.6.0 """ @@ -98,21 +85,26 @@
[docs] def getParser(self): """Define all options for command 'sat application <options>'""" parser = self.getParserWithHelp() - parser.add_option('n', 'name', 'string', 'name', + parser.add_option( + 'n', 'name', 'string', 'name', _("""\ Optional: The name of the application (default is APPLICATION.virtual_app.name or runAppli)""") ) - parser.add_option('c', 'catalog', 'string', 'catalog', + parser.add_option( + 'c', 'catalog', 'string', 'catalog', _('Optional: The resources catalog to use') ) - parser.add_option('t', 'target', 'string', 'target', + parser.add_option( + 't', 'target', 'string', 'target', _("""\ Optional: The directory where to create the application (default is APPLICATION.workdir)""") ) - parser.add_option('', 'gencat', 'string', 'gencat', + parser.add_option( + '', 'gencat', 'string', 'gencat', _("""\ Optional: Create a resources catalog for the specified machines (separated with ',') -NOTICE: this command will ssh to retrieve information to each machine in the list""") ) - parser.add_option('m', 'module', 'list2', 'modules', +Note: this command will ssh to retrieve information to each machine in the list""") ) + parser.add_option( + 'm', 'module', 'list2', 'modules', _("Optional: the restricted list of module(s) to include in the application") ) return parser
@@ -137,8 +129,9 @@ logger = self.getLogger() options = self.getOptions() - # check for product - src.check_config_has_application( config ) + # check for APPLICATION + rc = UTS.check_config_has_application(config) + if not rc.isOk(): return rc application = config.VARS.application logger.info(_("Building application for <header>%s<reset>\n") % application) @@ -571,12 +564,14 @@
@@ -587,8 +582,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/check.html b/doc/build/html/_modules/commands/check.html index 80be4f5..d4a8c96 100644 --- a/doc/build/html/_modules/commands/check.html +++ b/doc/build/html/_modules/commands/check.html @@ -1,41 +1,28 @@ + - + - commands.check — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -65,6 +52,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand CHECK_PROPERTY = "has_unit_tests" @@ -117,8 +105,7 @@ # check that the command has been called with an application - src.check_config_has_application( config ) - + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -185,16 +172,6 @@ return products_infos
-
[docs]def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20)) - logger.info("\r%s%s" % (header, step))
- -
[docs]def log_res_step(logger, res): - if res == 0: - logger.debug("<OK>\n") - else: - logger.debug("<KO>\n")
-
[docs]def check_all_products(config, products_infos, logger): """ Execute the proper configuration commands @@ -261,7 +238,7 @@ logger.warning(msg) if ignored or not cmd_found: - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.debug("==== %s %s\n" % (p_name, "IGNORED")) if not cmd_found: return 1 @@ -272,16 +249,16 @@ builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) len_end_line = 20 # Launch the check - log_step(logger, header, "CHECK") + UTS.log_step(logger, header, "CHECK") res = builder.check(command=command) - log_res_step(logger, res) + UTS.log_res_step(logger, res) # Log the result if res > 0: @@ -318,12 +295,14 @@
@@ -334,8 +313,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/clean.html b/doc/build/html/_modules/commands/clean.html index 5f5470e..f6e4abb 100644 --- a/doc/build/html/_modules/commands/clean.html +++ b/doc/build/html/_modules/commands/clean.html @@ -1,41 +1,28 @@ + - + - commands.clean — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -67,6 +54,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand # Compatibility python 2/3 for input function @@ -138,7 +126,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Verify the --properties option if options.properties: @@ -300,12 +288,14 @@
@@ -316,8 +306,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/compile.html b/doc/build/html/_modules/commands/compile.html index 49f1452..899e163 100644 --- a/doc/build/html/_modules/commands/compile.html +++ b/doc/build/html/_modules/commands/compile.html @@ -1,41 +1,28 @@ + - + - commands.compile — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -67,6 +54,7 @@ import os import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS import src.pyconf as PYCONF from src.salomeTools import _BaseCommand @@ -164,7 +152,7 @@ return 0 # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Print some informations nameApp = str(config.VARS.application) @@ -417,18 +405,6 @@ l_depends_not_installed.append(p_name_father) return l_depends_not_installed
-
[docs]def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 30)) - logger.info("\r%s%s" % (header, step)) - logger.debug("\n==== %s \n" % step)
- -
[docs]def log_res_step(logger, res): - if res == 0: - logger.debug("<OK>\n") - else: - logger.debug("<KO>\n")
- -
[docs]def compile_all_products(sat, config, options, products_infos, logger): """ Execute the proper configuration commands @@ -457,20 +433,20 @@ "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.info("\n") continue # Do nothing if the product is native if src.product.product_is_native(p_info): - log_step(logger, header, "native") + UTS.log_step(logger, header, "native") logger.info("\n") continue # Clean the build and the install directories # if the corresponding options was called if options.clean_all: - log_step(logger, header, "CLEAN BUILD AND INSTALL") + UTS.log_step(logger, header, "CLEAN BUILD AND INSTALL") sat.clean(config.VARS.application + " --products " + p_name + " --build --install", @@ -481,7 +457,7 @@ # Clean the the install directory # if the corresponding option was called if options.clean_install and not options.clean_all: - log_step(logger, header, "CLEAN INSTALL") + UTS.log_step(logger, header, "CLEAN INSTALL") sat.clean(config.VARS.application + " --products " + p_name + " --install", @@ -506,7 +482,7 @@ # Check if the dependencies are installed l_depends_not_installed = check_dependencies(config, p_name_info) if len(l_depends_not_installed) > 0: - log_step(logger, header, "") + UTS.log_step(logger, header, "") msg = _("the following products are mandatory:\n") for prod_name in l_depends_not_installed: msg += "%s\n" % prod_name @@ -537,7 +513,7 @@ else: # Clean the build directory if the compilation and tests succeed if options.clean_build_after: - log_step(logger, header, "CLEAN BUILD") + UTS.log_step(logger, header, "CLEAN BUILD") sat.clean(config.VARS.application + " --products " + p_name + " --build", @@ -621,7 +597,7 @@ if options.check: # Do the unit tests (call the check command) - log_step(logger, header, "CHECK") + UTS.log_step(logger, header, "CHECK") res_check = sat.check( config.VARS.application + " --products " + p_name, verbose = 0, @@ -661,11 +637,11 @@ # Logging and sat command call for configure step len_end_line = len_end - log_step(logger, header, "CONFIGURE") + UTS.log_step(logger, header, "CONFIGURE") res_c = sat.configure(config.VARS.application + " --products " + p_name, verbose = 0, logger_add_link = logger) - log_res_step(logger, res_c) + UTS.log_res_step(logger, res_c) res += res_c if res_c > 0: @@ -679,10 +655,10 @@ # it is executed during make step scrit_path_display = UTS.label( p_info.compil_script) - log_step(logger, header, "SCRIPT " + scrit_path_display) + UTS.log_step(logger, header, "SCRIPT " + scrit_path_display) len_end_line = len(scrit_path_display) else: - log_step(logger, header, "MAKE") + UTS.log_step(logger, header, "MAKE") make_arguments = config.VARS.application + " --products " + p_name # Get the make_flags option if there is any if options.makeflags: @@ -690,21 +666,21 @@ res_m = sat.make(make_arguments, verbose = 0, logger_add_link = logger) - log_res_step(logger, res_m) + UTS.log_res_step(logger, res_m) res += res_m if res_m > 0: error_step = "MAKE" else: # Logging and sat command call for make install step - log_step(logger, header, "MAKE INSTALL") + UTS.log_step(logger, header, "MAKE INSTALL") res_mi = sat.makeinstall(config.VARS.application + " --products " + p_name, verbose = 0, logger_add_link = logger) - log_res_step(logger, res_mi) + UTS.log_res_step(logger, res_mi) res += res_mi if res_mi > 0: @@ -737,12 +713,12 @@ # Logging and sat command call for the script step scrit_path_display = UTS.label(p_info.compil_script) - log_step(logger, header, "SCRIPT " + scrit_path_display) + UTS.log_step(logger, header, "SCRIPT " + scrit_path_display) len_end_line = len_end + len(scrit_path_display) res = sat.script(config.VARS.application + " --products " + p_name, verbose = 0, logger_add_link = logger) - log_res_step(logger, res) + UTS.log_res_step(logger, res) return res, len_end_line, error_step
@@ -791,12 +767,14 @@ @@ -807,8 +785,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/config.html b/doc/build/html/_modules/commands/config.html index 051bfd6..a71b088 100644 --- a/doc/build/html/_modules/commands/config.html +++ b/doc/build/html/_modules/commands/config.html @@ -1,41 +1,28 @@ + - + - commands.config — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -67,6 +54,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand import src.configManager as CFGMGR import src.system as SYSS @@ -194,7 +182,7 @@ # to ~/.salomeTools/Applications/LOCAL_<application>.pyconf elif options.copy: # product is required - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # get application file path source = config.VARS.application + '.pyconf' @@ -299,12 +287,14 @@
@@ -315,8 +305,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/configure.html b/doc/build/html/_modules/commands/configure.html index f12afc7..7b88bcb 100644 --- a/doc/build/html/_modules/commands/configure.html +++ b/doc/build/html/_modules/commands/configure.html @@ -1,41 +1,28 @@ + - + - commands.configure — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -66,6 +53,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -121,7 +109,7 @@ # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -189,18 +177,6 @@ return products_infos
-
[docs]def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20)) - logger.info("\r%s%s" % (header, step)) - logger.debug("\n==== %s \n" % UTS.info(step)) - logger.flush()
- -
[docs]def log_res_step(logger, res): - if res == 0: - logger.debug("<OK>") - else: - logger.debug("<KO>")
-
[docs]def configure_all_products(config, products_infos, conf_option, logger): """ Execute the proper configuration commands @@ -246,7 +222,7 @@ "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.info("\n") return 0 @@ -255,26 +231,26 @@ builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute buildconfigure, configure if the product is autotools # Execute cmake if the product is cmake res = 0 if src.product.product_is_autotools(p_info): - log_step(logger, header, "BUILDCONFIGURE") + UTS.log_step(logger, header, "BUILDCONFIGURE") res_bc = builder.build_configure() - log_res_step(logger, res_bc) + UTS.log_res_step(logger, res_bc) res += res_bc - log_step(logger, header, "CONFIGURE") + UTS.log_step(logger, header, "CONFIGURE") res_c = builder.configure(conf_option) - log_res_step(logger, res_c) + UTS.log_res_step(logger, res_c) res += res_c if src.product.product_is_cmake(p_info): - log_step(logger, header, "CMAKE") + UTS.log_step(logger, header, "CMAKE") res_cm = builder.cmake(conf_option) - log_res_step(logger, res_cm) + UTS.log_res_step(logger, res_cm) res += res_cm # Log the result @@ -311,12 +287,14 @@
@@ -327,8 +305,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/environ.html b/doc/build/html/_modules/commands/environ.html index 33c8a08..79b60e4 100644 --- a/doc/build/html/_modules/commands/environ.html +++ b/doc/build/html/_modules/commands/environ.html @@ -1,41 +1,28 @@ + - + - commands.environ — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -124,7 +111,7 @@ options = self.getOptions() # check that the command was called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() if options.products is None: environ_info = None @@ -242,12 +229,14 @@
@@ -258,8 +247,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/find_duplicates.html b/doc/build/html/_modules/commands/find_duplicates.html index d9c8ace..28a4ff8 100644 --- a/doc/build/html/_modules/commands/find_duplicates.html +++ b/doc/build/html/_modules/commands/find_duplicates.html @@ -1,41 +1,28 @@ + - + - commands.find_duplicates — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -365,12 +352,14 @@
@@ -381,8 +370,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/generate.html b/doc/build/html/_modules/commands/generate.html index 5c3a06d..33e0657 100644 --- a/doc/build/html/_modules/commands/generate.html +++ b/doc/build/html/_modules/commands/generate.html @@ -1,41 +1,28 @@ + - + - commands.generate — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -468,12 +455,14 @@
@@ -484,8 +473,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/init.html b/doc/build/html/_modules/commands/init.html index 9169006..115479d 100644 --- a/doc/build/html/_modules/commands/init.html +++ b/doc/build/html/_modules/commands/init.html @@ -1,41 +1,28 @@ + - + - commands.init — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -248,12 +235,14 @@
@@ -264,8 +253,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/job.html b/doc/build/html/_modules/commands/job.html index 2f1d01f..56ff48f 100644 --- a/doc/build/html/_modules/commands/job.html +++ b/doc/build/html/_modules/commands/job.html @@ -1,41 +1,28 @@ + - + - commands.job — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -66,6 +53,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -250,12 +238,14 @@
@@ -266,8 +256,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/jobs.html b/doc/build/html/_modules/commands/jobs.html index c973c17..d735783 100644 --- a/doc/build/html/_modules/commands/jobs.html +++ b/doc/build/html/_modules/commands/jobs.html @@ -1,41 +1,28 @@ + - + - commands.jobs — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -1895,12 +1882,14 @@
@@ -1911,8 +1900,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/launcher.html b/doc/build/html/_modules/commands/launcher.html index 606f015..fc76d9b 100644 --- a/doc/build/html/_modules/commands/launcher.html +++ b/doc/build/html/_modules/commands/launcher.html @@ -1,41 +1,28 @@ + - + - commands.launcher — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -71,6 +58,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -113,7 +101,7 @@ options = self.getOptions() # Verify that the command was called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Determine the launcher name (from option, profile section or by default "salome") if options.name: @@ -339,12 +327,14 @@
@@ -355,8 +345,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/log.html b/doc/build/html/_modules/commands/log.html index e3bf54c..45e47ff 100644 --- a/doc/build/html/_modules/commands/log.html +++ b/doc/build/html/_modules/commands/log.html @@ -1,41 +1,28 @@ + - + - commands.log — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -457,12 +444,14 @@
@@ -473,8 +462,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/make.html b/doc/build/html/_modules/commands/make.html index 19d6658..0e65c99 100644 --- a/doc/build/html/_modules/commands/make.html +++ b/doc/build/html/_modules/commands/make.html @@ -1,41 +1,28 @@ + - + - commands.make — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -116,7 +103,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -184,19 +171,6 @@ return products_infos
-
[docs]def log_step(logger, header, step): - msg = "\r%s%s" % (header, " " * 20) - msg += "\r%s%s" % (header, step) - logger.info(msg) - logger.debug("\n==== %s \n" % UTS.info(step))
- -
[docs]def log_res_step(logger, res): - if res == 0: - logger.debug("<OK>\n") - else: - logger.debug("<KO>\n")
- -
[docs]def make_all_products(config, products_infos, make_option, logger): """ Execute the proper configuration commands @@ -241,7 +215,7 @@ if ("properties" in p_info and \ "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") return 0 # Instantiate the class that manages all the construction commands @@ -249,21 +223,21 @@ builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute buildconfigure, configure if the product is autotools # Execute cmake if the product is cmake len_end_line = 20 nb_proc, make_opt_without_j = get_nb_proc(p_info, config, make_option) - log_step(logger, header, "MAKE -j" + str(nb_proc)) + UTS.log_step(logger, header, "MAKE -j" + str(nb_proc)) if src.architecture.is_windows(): res = builder.wmake(nb_proc, make_opt_without_j) else: res = builder.make(nb_proc, make_opt_without_j) - log_res_step(logger, res) + UTS.log_res_step(logger, res) # Log the result if res > 0: @@ -325,12 +299,14 @@
@@ -341,8 +317,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/makeinstall.html b/doc/build/html/_modules/commands/makeinstall.html index 97ef899..7843d3a 100644 --- a/doc/build/html/_modules/commands/makeinstall.html +++ b/doc/build/html/_modules/commands/makeinstall.html @@ -1,41 +1,28 @@ + - + - commands.makeinstall — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -66,6 +53,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -113,7 +101,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -177,17 +165,6 @@ return products_infos
-
[docs]def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20), 3) - logger.info("\r%s%s" % (header, step), 3) - logger.debug("\n==== %s \n" % UTS.info(step), 4)
- -
[docs]def log_res_step(logger, res): - if res == 0: - logger.debug("<OK>\n") - else: - logger.debug("<KO>\n")
-
[docs]def makeinstall_all_products(config, products_infos, logger): """ Execute the proper configuration commands @@ -231,7 +208,7 @@ if ("properties" in p_info and \ "compilation" in p_info.properties and \ p_info.properties.compilation == "no"): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") return RCO.ReturnCode("OK", "product %s is not compilable" % p_name) # Instantiate the class that manages all the construction commands @@ -239,17 +216,17 @@ builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute buildconfigure, configure if the product is autotools # Execute cmake if the product is cmake res = 0 if not src.product.product_has_script(p_info): - log_step(logger, header, "MAKE INSTALL") + UTS.log_step(logger, header, "MAKE INSTALL") res_m = builder.install() - log_res_step(logger, res_m) + UTS.log_res_step(logger, res_m) res += res_m # Log the result @@ -286,12 +263,14 @@
@@ -302,8 +281,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/package.html b/doc/build/html/_modules/commands/package.html index 20e5969..b5531d0 100644 --- a/doc/build/html/_modules/commands/package.html +++ b/doc/build/html/_modules/commands/package.html @@ -1,41 +1,28 @@ + - + - commands.package — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -147,7 +134,7 @@ project_file_paths : [$VARS.salometoolsway + $VARS.sep + \"..\" + $VAR | 2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools. | 3- The project archive. It contains a project (give the project file path as argument). | 4- The salomeTools archive. It contains salomeTools. - | + | | examples: | >> sat package SALOME --binaries --sources """ @@ -1431,12 +1418,14 @@ The procedure to do it is:
@@ -1447,8 +1436,8 @@ The procedure to do it is: ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/patch.html b/doc/build/html/_modules/commands/patch.html index a27fdaf..800b79c 100644 --- a/doc/build/html/_modules/commands/patch.html +++ b/doc/build/html/_modules/commands/patch.html @@ -1,41 +1,28 @@ + - + - commands.patch — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -116,7 +103,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Print some informations logger.info("Patching sources of the application %s\n" % \ @@ -274,12 +261,14 @@
@@ -290,8 +279,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/prepare.html b/doc/build/html/_modules/commands/prepare.html index d3818a8..2dd89d7 100644 --- a/doc/build/html/_modules/commands/prepare.html +++ b/doc/build/html/_modules/commands/prepare.html @@ -1,41 +1,28 @@ + - + - commands.prepare — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -68,6 +55,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -121,7 +109,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() products_infos = self.get_products_list(options, config, logger) @@ -273,12 +261,14 @@
@@ -289,8 +279,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/profile.html b/doc/build/html/_modules/commands/profile.html index e1dc3d3..ea37ed0 100644 --- a/doc/build/html/_modules/commands/profile.html +++ b/doc/build/html/_modules/commands/profile.html @@ -1,41 +1,28 @@ + - + - commands.profile — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -68,6 +55,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS import src.pyconf as PYCONF from src.salomeTools import _BaseCommand @@ -337,12 +325,14 @@
@@ -353,8 +343,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/run.html b/doc/build/html/_modules/commands/run.html index 5b136e1..6dde4f9 100644 --- a/doc/build/html/_modules/commands/run.html +++ b/doc/build/html/_modules/commands/run.html @@ -1,41 +1,28 @@ + - + - commands.run — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -173,12 +160,14 @@
@@ -189,8 +178,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/script.html b/doc/build/html/_modules/commands/script.html index 7bfbc82..aae6ddf 100644 --- a/doc/build/html/_modules/commands/script.html +++ b/doc/build/html/_modules/commands/script.html @@ -1,41 +1,28 @@ + - + - commands.script — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -66,6 +53,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -118,7 +106,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Get the list of products to treat products_infos = get_products_list(options, config, logger) @@ -189,17 +177,6 @@ return products_infos
-
[docs]def log_step(logger, header, step): - logger.info("\r%s%s" % (header, " " * 20)) - logger.info("\r%s%s" % (header, step)) - logger.debug("\n==== %s \n" % UTS.info(step))
- -
[docs]def log_res_step(logger, res): - if res == 0: - logger.debug("<OK>\n") - else: - logger.debug("<KO>\n")
-
[docs]def run_script_all_products(config, products_infos, nb_proc, logger): """Execute the script in each product build directory. @@ -247,7 +224,7 @@ "compilation" in p_info.properties and \ p_info.properties.compilation == "no" if ( test1 or (not src.product.product_has_script(p_info)) ): - log_step(logger, header, "ignored") + UTS.log_step(logger, header, "ignored") logger.info("\n") return 0 @@ -256,17 +233,17 @@ builder = src.compilation.Builder(config, logger, p_info) # Prepare the environment - log_step(logger, header, "PREPARE ENV") + UTS.log_step(logger, header, "PREPARE ENV") res_prepare = builder.prepare() - log_res_step(logger, res_prepare) + UTS.log_res_step(logger, res_prepare) # Execute the script len_end_line = 20 script_path_display = UTS.label(p_info.compil_script) - log_step(logger, header, "SCRIPT " + script_path_display) + UTS.log_step(logger, header, "SCRIPT " + script_path_display) len_end_line += len(script_path_display) res = builder.do_script_build(p_info.compil_script, number_of_proc=nb_proc) - log_res_step(logger, res) + UTS.log_res_step(logger, res) # Log the result if res > 0: @@ -302,12 +279,14 @@
@@ -318,8 +297,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/shell.html b/doc/build/html/_modules/commands/shell.html index 9a57f59..5d10967 100644 --- a/doc/build/html/_modules/commands/shell.html +++ b/doc/build/html/_modules/commands/shell.html @@ -1,41 +1,28 @@ + - + - commands.shell — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -68,6 +55,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand ######################################################################## @@ -157,12 +145,14 @@
@@ -173,8 +163,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/source.html b/doc/build/html/_modules/commands/source.html index f2027bd..c652e08 100644 --- a/doc/build/html/_modules/commands/source.html +++ b/doc/build/html/_modules/commands/source.html @@ -1,41 +1,28 @@ + - + - commands.source — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -68,6 +55,7 @@ import src.debug as DBG import src.returnCode as RCO +import src.utilsSat as UTS from src.salomeTools import _BaseCommand import src.system as SYSS @@ -116,7 +104,7 @@ options = self.getOptions() # check that the command has been called with an application - src.check_config_has_application( config ) + UTS.check_config_has_application(config).raiseIfKo() # Print some informations logger.info(_('Getting sources of the application %s\n') % \ @@ -604,12 +592,14 @@
@@ -620,8 +610,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/template.html b/doc/build/html/_modules/commands/template.html index c5b3010..8540167 100644 --- a/doc/build/html/_modules/commands/template.html +++ b/doc/build/html/_modules/commands/template.html @@ -1,41 +1,28 @@ + - + - commands.template — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -589,12 +576,14 @@
@@ -605,8 +594,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/commands/test.html b/doc/build/html/_modules/commands/test.html index 1bbdb42..e23efeb 100644 --- a/doc/build/html/_modules/commands/test.html +++ b/doc/build/html/_modules/commands/test.html @@ -1,41 +1,28 @@ + - + - commands.test — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -805,12 +792,14 @@
@@ -821,8 +810,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/index.html b/doc/build/html/_modules/index.html index 49f8ec2..379d15b 100644 --- a/doc/build/html/_modules/index.html +++ b/doc/build/html/_modules/index.html @@ -1,40 +1,28 @@ + - + - Overview: module code — salomeTools 5.0.0dev documentation - - - + - + - - - +
@@ -118,12 +106,14 @@
@@ -134,8 +124,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/ElementTree.html b/doc/build/html/_modules/src/ElementTree.html index ecc849f..42c9f4c 100644 --- a/doc/build/html/_modules/src/ElementTree.html +++ b/doc/build/html/_modules/src/ElementTree.html @@ -1,41 +1,28 @@ + - + - src.ElementTree — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -1353,12 +1340,14 @@
@@ -1369,8 +1358,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/architecture.html b/doc/build/html/_modules/src/architecture.html index e486727..6a1e6a1 100644 --- a/doc/build/html/_modules/src/architecture.html +++ b/doc/build/html/_modules/src/architecture.html @@ -1,41 +1,28 @@ + - + - src.architecture — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -211,12 +198,14 @@
@@ -227,8 +216,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/catchAll.html b/doc/build/html/_modules/src/catchAll.html index 1475128..b93e96c 100644 --- a/doc/build/html/_modules/src/catchAll.html +++ b/doc/build/html/_modules/src/catchAll.html @@ -1,41 +1,28 @@ + - + - src.catchAll — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -187,12 +174,14 @@
@@ -203,8 +192,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/colorama/ansi.html b/doc/build/html/_modules/src/colorama/ansi.html index 5d8e975..073e05b 100644 --- a/doc/build/html/_modules/src/colorama/ansi.html +++ b/doc/build/html/_modules/src/colorama/ansi.html @@ -1,41 +1,28 @@ + - + - src.colorama.ansi — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -166,12 +153,14 @@
@@ -182,8 +171,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/colorama/ansitowin32.html b/doc/build/html/_modules/src/colorama/ansitowin32.html index 5fb649b..cf84913 100644 --- a/doc/build/html/_modules/src/colorama/ansitowin32.html +++ b/doc/build/html/_modules/src/colorama/ansitowin32.html @@ -1,41 +1,28 @@ + - + - src.colorama.ansitowin32 — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -300,12 +287,14 @@
@@ -316,8 +305,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/colorama/initialise.html b/doc/build/html/_modules/src/colorama/initialise.html index 1062ef2..47c5418 100644 --- a/doc/build/html/_modules/src/colorama/initialise.html +++ b/doc/build/html/_modules/src/colorama/initialise.html @@ -1,41 +1,28 @@ + - + - src.colorama.initialise — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -101,8 +88,8 @@ sys.stderr = orig_stderr
-@contextlib.contextmanager -
[docs]def colorama_text(*args, **kwargs): +
[docs]@contextlib.contextmanager +def colorama_text(*args, **kwargs): init(*args, **kwargs) try: yield @@ -146,12 +133,14 @@
@@ -162,8 +151,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/colorama/win32.html b/doc/build/html/_modules/src/colorama/win32.html index f86854c..4473680 100644 --- a/doc/build/html/_modules/src/colorama/win32.html +++ b/doc/build/html/_modules/src/colorama/win32.html @@ -1,41 +1,28 @@ + - + - src.colorama.win32 — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -218,12 +205,14 @@
@@ -234,8 +223,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/colorama/winterm.html b/doc/build/html/_modules/src/colorama/winterm.html index ba78903..6107d22 100644 --- a/doc/build/html/_modules/src/colorama/winterm.html +++ b/doc/build/html/_modules/src/colorama/winterm.html @@ -1,41 +1,28 @@ + - + - src.colorama.winterm — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -226,12 +213,14 @@
@@ -242,8 +231,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/coloringSat.html b/doc/build/html/_modules/src/coloringSat.html index 86b5dc8..1f891cf 100644 --- a/doc/build/html/_modules/src/coloringSat.html +++ b/doc/build/html/_modules/src/coloringSat.html @@ -1,41 +1,28 @@ + - + - src.coloringSat — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -56,6 +43,9 @@ "{}".format() is not choosen because "{}" are present in log messages of contents of python dict (as JSON) etc. +usage: +>> import src.coloringSat as COLS + example: >> log("this is in <green>color green<reset>, OK is in blue: <blue>OK?") """ @@ -273,12 +263,14 @@
@@ -289,8 +281,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/compilation.html b/doc/build/html/_modules/src/compilation.html index c7f6e70..da493d8 100644 --- a/doc/build/html/_modules/src/compilation.html +++ b/doc/build/html/_modules/src/compilation.html @@ -1,41 +1,28 @@ + - + - src.compilation — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -554,12 +541,14 @@
@@ -570,8 +559,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/configManager.html b/doc/build/html/_modules/src/configManager.html index e789a1b..7bcba4d 100644 --- a/doc/build/html/_modules/src/configManager.html +++ b/doc/build/html/_modules/src/configManager.html @@ -1,41 +1,28 @@ + - + - src.configManager — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -919,12 +906,14 @@
@@ -935,8 +924,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/debug.html b/doc/build/html/_modules/src/debug.html index c4c907d..d2ec698 100644 --- a/doc/build/html/_modules/src/debug.html +++ b/doc/build/html/_modules/src/debug.html @@ -1,41 +1,28 @@ + - + - src.debug — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -82,7 +69,8 @@ import traceback import StringIO as SIO import pprint as PP - +import src.coloringSat as COLS + _debug = [False] #support push/pop for temporary activate debug outputs _user = os.environ['USER'] @@ -95,17 +83,31 @@ padding = amount * ch return ''.join(padding + line for line in text.splitlines(True))
+
[docs]def isTypeConfig(var): + """To know if var is instance from Config/pyconf""" + typ = str(type(var)) + # print "isTypeConfig" ,type, dir(var) + if ".pyconf.Config" in typ: return True + if ".pyconf.Mapping" in typ: return True + if ".pyconf.Sequence" in typ: return True + # print "NOT isTypeConfig %s" % typ + return False
+
[docs]def write(title, var="", force=None, fmt="\n#### DEBUG: %s:\n%s\n"): """write sys.stderr a message if _debug[-1]==True or optionaly force=True""" if _debug[-1] or force: - if '.Config' in str(type(var)): - sys.stderr.write(fmt % (title, indent(getStrConfigDbg(var)))) - if 'loggingSat.UnittestStream' in str(type(var)): - sys.stderr.write(fmt % (title, indent(var.getLogs()))) - elif type(var) is not str: - sys.stderr.write(fmt % (title, indent(PP.pformat(var)))) - else: - sys.stderr.write(fmt % (title, indent(var))) + typ = str(type(var)) + if isTypeConfig(var): + sys.stderr.write(fmt % (title, indent(COLS.toColor(getStrConfigDbg(var))))) + return + if 'loggingSat.UnittestStream' in typ: + sys.stderr.write(fmt % (title, indent(var.getLogs()))) + return + if type(var) is not str: + sys.stderr.write(fmt % (title, indent(PP.pformat(var)))) + return + sys.stderr.write(fmt % (title, indent(var))) + return return
[docs]def tofix(title, var="", force=None): @@ -252,7 +254,7 @@ aStream.write("<blue>%s%s.%s<reset> : '%s'\n" % (indstr, path, key, str(value))) continue try: - aStream.write("!!! TODO fix that %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value))) + aStream.write("<red>!!! TODO fix that<reset> %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value))) except Exception as e: aStream.write("<blue>%s%s.%s<reset> : <red>!!! %s<reset>\n" % (indstr, path, key, e.message))
@@ -275,12 +277,14 @@ @@ -291,8 +295,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/environment.html b/doc/build/html/_modules/src/environment.html index fd1937e..bbc7a24 100644 --- a/doc/build/html/_modules/src/environment.html +++ b/doc/build/html/_modules/src/environment.html @@ -1,41 +1,28 @@ + - + - src.environment — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -886,12 +873,14 @@
@@ -902,8 +891,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/environs.html b/doc/build/html/_modules/src/environs.html index ca6294f..ea83aee 100644 --- a/doc/build/html/_modules/src/environs.html +++ b/doc/build/html/_modules/src/environs.html @@ -1,41 +1,28 @@ + - + - src.environs — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -146,12 +133,14 @@
@@ -162,8 +151,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/example/essai_logging_1.html b/doc/build/html/_modules/src/example/essai_logging_1.html index e410e8c..b98752b 100644 --- a/doc/build/html/_modules/src/example/essai_logging_1.html +++ b/doc/build/html/_modules/src/example/essai_logging_1.html @@ -1,41 +1,28 @@ + - + - src.example.essai_logging_1 — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -135,12 +122,14 @@
@@ -151,8 +140,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/example/essai_logging_2.html b/doc/build/html/_modules/src/example/essai_logging_2.html index f721734..3a526e9 100644 --- a/doc/build/html/_modules/src/example/essai_logging_2.html +++ b/doc/build/html/_modules/src/example/essai_logging_2.html @@ -1,41 +1,28 @@ + - + - src.example.essai_logging_2 — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -132,12 +119,14 @@
@@ -148,8 +137,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/exceptionSat.html b/doc/build/html/_modules/src/exceptionSat.html index 3c1280d..c1aa343 100644 --- a/doc/build/html/_modules/src/exceptionSat.html +++ b/doc/build/html/_modules/src/exceptionSat.html @@ -1,41 +1,28 @@ + - + - src.exceptionSat — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -90,12 +77,14 @@
@@ -106,8 +95,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/fileEnviron.html b/doc/build/html/_modules/src/fileEnviron.html index 64836dd..a5c2608 100644 --- a/doc/build/html/_modules/src/fileEnviron.html +++ b/doc/build/html/_modules/src/fileEnviron.html @@ -1,41 +1,28 @@ + - + - src.fileEnviron — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -882,12 +869,14 @@
@@ -898,8 +887,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/fork.html b/doc/build/html/_modules/src/fork.html index 2fcc928..733de00 100644 --- a/doc/build/html/_modules/src/fork.html +++ b/doc/build/html/_modules/src/fork.html @@ -1,41 +1,28 @@ + - + - src.fork — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -225,12 +212,14 @@
@@ -241,8 +230,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/loggingSat.html b/doc/build/html/_modules/src/loggingSat.html index 66e0df5..1e9e1bf 100644 --- a/doc/build/html/_modules/src/loggingSat.html +++ b/doc/build/html/_modules/src/loggingSat.html @@ -1,41 +1,28 @@ + - + - src.loggingSat — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -265,12 +252,14 @@
@@ -281,8 +270,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/options.html b/doc/build/html/_modules/src/options.html index 9a2a783..68b7c63 100644 --- a/doc/build/html/_modules/src/options.html +++ b/doc/build/html/_modules/src/options.html @@ -1,41 +1,28 @@ + - + - src.options — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -344,12 +331,14 @@
@@ -360,8 +349,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/product.html b/doc/build/html/_modules/src/product.html index 0e4af83..25d0bc0 100644 --- a/doc/build/html/_modules/src/product.html +++ b/doc/build/html/_modules/src/product.html @@ -1,41 +1,28 @@ + - + - src.product — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -62,7 +49,7 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -"""\ +""" Contains the methods relative to the product notion of salomeTools """ @@ -79,7 +66,8 @@
[docs]def get_product_config(config, product_name, with_install_dir=True): """ - Get the specific configuration of a product from the global configuration + Get the specific configuration of a product + from the global configuration :param config: (Config) The global configuration :param product_name: (str) The name of the product @@ -336,7 +324,6 @@ (if not None, the section is explicitly given) :return: (Config) The product description """ - # if section is not None, try to get the corresponding section if section: if section not in config.PRODUCTS[product_name]: @@ -512,27 +499,24 @@ return False, None
- - -
[docs]def get_products_infos(lproducts, config): +
[docs]def get_products_infos(products, config): """Get the specific configuration of a list of products - :param lproducts: (list) The list of product names + :param products: (list) The list of product names :param config: (Config) The global configuration :return: (list) of tuples (str, Config) as (product name, specific configuration of the product) """ products_infos = [] # Loop on product names - for prod in lproducts: - # Get the specific configuration of the product - prod_info = get_product_config(config, prod) - if prod_info is not None: - products_infos.append((prod, prod_info)) - else: - msg = _("The %s product has no definition " - "in the configuration.") % prod - raise Exception(msg) + for prod in products: + # Get the specific configuration of the product + prod_info = get_product_config(config, prod) + if prod_info is not None: + products_infos.append((prod, prod_info)) + else: + msg = _("The product '%s' has no definition in the configuration.") % prod + raise Exception(msg) return products_infos
[docs]def get_product_dependencies(config, product_info): @@ -855,12 +839,14 @@
@@ -871,8 +857,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10
diff --git a/doc/build/html/_modules/src/pyconf.html b/doc/build/html/_modules/src/pyconf.html index 72289b1..bf8056e 100644 --- a/doc/build/html/_modules/src/pyconf.html +++ b/doc/build/html/_modules/src/pyconf.html @@ -1,41 +1,28 @@ + - + - src.pyconf — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -1803,12 +1790,14 @@
@@ -1819,8 +1808,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/returnCode.html b/doc/build/html/_modules/src/returnCode.html index 977bbc8..2264d39 100644 --- a/doc/build/html/_modules/src/returnCode.html +++ b/doc/build/html/_modules/src/returnCode.html @@ -1,41 +1,28 @@ + - + - src.returnCode — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -233,12 +220,14 @@
@@ -249,8 +238,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/salomeTools.html b/doc/build/html/_modules/src/salomeTools.html index 8b71b82..6ef2530 100644 --- a/doc/build/html/_modules/src/salomeTools.html +++ b/doc/build/html/_modules/src/salomeTools.html @@ -1,41 +1,28 @@ + - + - src.salomeTools — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -575,12 +562,14 @@
@@ -591,8 +580,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/system.html b/doc/build/html/_modules/src/system.html index 5e5c8c5..54a1431 100644 --- a/doc/build/html/_modules/src/system.html +++ b/doc/build/html/_modules/src/system.html @@ -1,41 +1,28 @@ + - + - src.system — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -281,12 +268,14 @@
@@ -297,8 +286,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/template.html b/doc/build/html/_modules/src/template.html index 4c4de27..960032b 100644 --- a/doc/build/html/_modules/src/template.html +++ b/doc/build/html/_modules/src/template.html @@ -1,41 +1,28 @@ + - + - src.template — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -93,12 +80,14 @@
@@ -109,8 +98,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/test_module.html b/doc/build/html/_modules/src/test_module.html index aee1eeb..8ba0118 100644 --- a/doc/build/html/_modules/src/test_module.html +++ b/doc/build/html/_modules/src/test_module.html @@ -1,41 +1,28 @@ + - + - src.test_module — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -917,12 +904,14 @@
@@ -933,8 +922,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_modules/src/utilsSat.html b/doc/build/html/_modules/src/utilsSat.html index b3f2222..0327927 100644 --- a/doc/build/html/_modules/src/utilsSat.html +++ b/doc/build/html/_modules/src/utilsSat.html @@ -1,41 +1,28 @@ + - + - src.utilsSat — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -83,6 +70,7 @@ import tempfile import src.returnCode as RCO +import src.debug as DBG # Easy print stderr (for DEBUG only) ############################################################################## @@ -93,7 +81,7 @@ :param path: (str) The path. """ - print "the path",path + # DBG.write("ensure_path_exists", path, True) if not os.path.exists(path): os.makedirs(path)
@@ -258,7 +246,25 @@ ############################################################################## # pyconf config utilities ############################################################################## -
[docs]def check_config_has_application( config, details = None ): + +
[docs]def check_has_key(inConfig, key): + """Check that the in-Config node has the named key (as an attribute) + + :param inConfig: (Config or Mapping etc) The in-Config node + :param key: (str) The key to check presence in in-Config node + :return: (RCO.ReturnCode) 'OK' if presence + """ + debug = True + if key not in inConfig: + msg = _("check_has_key '%s' not found" % key) + DBG.write("check_has_key", msg, debug) + return RCO.ReturnCode("KO", msg) + else: + msg = _("check_has_key '%s' found" % key) + DBG.write("check_has_key", msg, debug) + return RCO.ReturnCode("OK", msg)
+ +
[docs]def check_config_has_application(config): """ Check that the config has the key APPLICATION. Else raise an exception. @@ -266,27 +272,33 @@ :param config: (Config) The config. """ if 'APPLICATION' not in config: - message = _("An APPLICATION is required. Use 'config --list' to get" - " the list of available applications.\n") - if details : - details.append(message) - raise Exception( message )
+ msg = _("An application name is required.") + msg += "\n" + _("(as 'sat prepare <application>')") + msg += "\n" + _("Use 'sat config --list' to get the list of available applications.") + DBG.write("check_config_has_application", msg) + return RCO.ReturnCode("KO", msg) + else: + msg = _("APPLICATION '%s' found." % config) + DBG.write("check_config_has_application", msg) + return RCO.ReturnCode("OK", msg)
-
[docs]def check_config_has_profile( config, details = None ): +
[docs]def check_config_has_profile(config): """ Check that the config has the key APPLICATION.profile. Else, raise an exception. :param config: (Config) The config. """ - check_config_has_application(config) + check_config_has_application(config).raiseIfKo() if 'profile' not in config.APPLICATION: - message = _("A profile section is required in your application.\n") - if details : - details.append(message) - raise Exception( message )
+ msg = _("An 'APPLICATION.profile' section is required in config.") + return RCO.ReturnCode("KO", msg) + else: + msg = _("An 'APPLICATION.profile' is found in config.") + return RCO.ReturnCode("OK", msg)
+ -
[docs]def config_has_application( config ): +
[docs]def config_has_application(config): return 'APPLICATION' in config
[docs]def get_cfg_param(config, param_name, default): @@ -319,19 +331,20 @@ return base_path
[docs]def get_launcher_name(config): - """Returns the name of salome launcher. + """Returns the name of application file launcher, 'salome' by default. :param config: (Config) The global Config instance. :return: (str) The name of salome launcher. """ - check_config_has_application(config) - if 'profile' in config.APPLICATION and 'launcher_name' in config.APPLICATION.profile: + check_config_has_application(config).raiseIfKo() + if 'profile' in config.APPLICATION and \ + 'launcher_name' in config.APPLICATION.profile: launcher_name = config.APPLICATION.profile.launcher_name else: launcher_name = 'salome' - return launcher_name
+
[docs]def get_log_path(config): """Returns the path of the logs. @@ -394,7 +407,7 @@ return product_cfg.properties[pprty]
############################################################################## -# logger and color utilities +# logger utilities ##############################################################################
[docs]def formatTuples(tuples): """ @@ -426,13 +439,25 @@
[docs]def logger_info_tuples(logger, tuples): """ - for convenience + For convenience format as formatTuples() and call logger.info() """ msg = formatTuples(tuples) logger.info(msg)
-# for convenience +
[docs]def log_step(logger, header, step): + logger.info("\r%s%s" % (header, " " * 20)) + logger.info("\r%s%s" % (header, step))
+ +
[docs]def log_res_step(logger, res): + if res == 0: + logger.info("<OK>\n") + else: + logger.info("<KO>\n")
+ +############################################################################## +# color utilities, for convenience +############################################################################## _colors = "BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE".lower().split(" ")
[docs]def black(msg): @@ -546,10 +571,8 @@ ############################################################################## -# log utilities (TODO: set in loggingSat class, later, changing tricky xml ? -############################################################################## - - +# log utilities (TODO: set in loggingSat class, later, changing tricky xml? +##############################################################################
[docs]def date_to_datetime(date): """ From a string date in format YYYYMMDD_HHMMSS @@ -607,13 +630,13 @@ import src.xmlManager as XMLMGR # avoid import cross utilsSat if cmd in notShownCommands: - return RCO.ReturnCode("KO", "in notShownCommands", None) + return RCO.ReturnCode("KO", "command '%s' in notShownCommands" % cmd, None) # Get the application of the log file - if True: #try: + try: logFileXml = XMLMGR.ReadXmlFile(logFilePath) - else: #except Exception as e: - msg = _("The log file '%s' cannot be read:" % logFilePath) + except Exception as e: + msg = _("The log file '%s' cannot be read" % logFilePath) return RCO.ReturnCode("KO", msg, None) if 'application' in logFileXml.xmlroot.keys(): @@ -621,9 +644,9 @@ launched_cmd = logFileXml.xmlroot.find('Site').attrib['launchedCommand'] # if it corresponds, then the log has to be shown if appliLog == application: - return RCO.ReturnCode("OK", "appliLog == application", (appliLog, launched_cmd)) + return RCO.ReturnCode("OK", "appliLog is application", (appliLog, launched_cmd)) elif application != 'None': - return RCO.ReturnCode("KO", "application != 'None'", (appliLog, launched_cmd)) + return RCO.ReturnCode("KO", "application is not 'None'", (appliLog, launched_cmd)) return RCO.ReturnCode("OK", "", (appliLog, launched_cmd)) @@ -726,12 +749,14 @@
@@ -742,8 +767,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10
diff --git a/doc/build/html/_modules/src/xmlManager.html b/doc/build/html/_modules/src/xmlManager.html index 3881e9e..4d3cd40 100644 --- a/doc/build/html/_modules/src/xmlManager.html +++ b/doc/build/html/_modules/src/xmlManager.html @@ -1,41 +1,28 @@ + - + - src.xmlManager — salomeTools 5.0.0dev documentation - - - + - + - - - - +
@@ -287,12 +274,14 @@
@@ -303,8 +292,8 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 diff --git a/doc/build/html/_sources/apidoc_commands/commands.rst.txt b/doc/build/html/_sources/apidoc_commands/commands.rst.txt new file mode 100644 index 0000000..d9a4c75 --- /dev/null +++ b/doc/build/html/_sources/apidoc_commands/commands.rst.txt @@ -0,0 +1,222 @@ +commands package +================ + +Submodules +---------- + +commands.application module +--------------------------- + +.. automodule:: commands.application + :members: + :undoc-members: + :show-inheritance: + +commands.check module +--------------------- + +.. automodule:: commands.check + :members: + :undoc-members: + :show-inheritance: + +commands.clean module +--------------------- + +.. automodule:: commands.clean + :members: + :undoc-members: + :show-inheritance: + +commands.compile module +----------------------- + +.. automodule:: commands.compile + :members: + :undoc-members: + :show-inheritance: + +commands.config module +---------------------- + +.. automodule:: commands.config + :members: + :undoc-members: + :show-inheritance: + +commands.configure module +------------------------- + +.. automodule:: commands.configure + :members: + :undoc-members: + :show-inheritance: + +commands.environ module +----------------------- + +.. automodule:: commands.environ + :members: + :undoc-members: + :show-inheritance: + +commands.find_duplicates module +------------------------------- + +.. automodule:: commands.find_duplicates + :members: + :undoc-members: + :show-inheritance: + +commands.generate module +------------------------ + +.. automodule:: commands.generate + :members: + :undoc-members: + :show-inheritance: + +commands.init module +-------------------- + +.. automodule:: commands.init + :members: + :undoc-members: + :show-inheritance: + +commands.job module +------------------- + +.. automodule:: commands.job + :members: + :undoc-members: + :show-inheritance: + +commands.jobs module +-------------------- + +.. automodule:: commands.jobs + :members: + :undoc-members: + :show-inheritance: + +commands.launcher module +------------------------ + +.. automodule:: commands.launcher + :members: + :undoc-members: + :show-inheritance: + +commands.log module +------------------- + +.. automodule:: commands.log + :members: + :undoc-members: + :show-inheritance: + +commands.make module +-------------------- + +.. automodule:: commands.make + :members: + :undoc-members: + :show-inheritance: + +commands.makeinstall module +--------------------------- + +.. automodule:: commands.makeinstall + :members: + :undoc-members: + :show-inheritance: + +commands.package module +----------------------- + +.. automodule:: commands.package + :members: + :undoc-members: + :show-inheritance: + +commands.patch module +--------------------- + +.. automodule:: commands.patch + :members: + :undoc-members: + :show-inheritance: + +commands.prepare module +----------------------- + +.. automodule:: commands.prepare + :members: + :undoc-members: + :show-inheritance: + +commands.profile module +----------------------- + +.. automodule:: commands.profile + :members: + :undoc-members: + :show-inheritance: + +commands.run module +------------------- + +.. automodule:: commands.run + :members: + :undoc-members: + :show-inheritance: + +commands.script module +---------------------- + +.. automodule:: commands.script + :members: + :undoc-members: + :show-inheritance: + +commands.shell module +--------------------- + +.. automodule:: commands.shell + :members: + :undoc-members: + :show-inheritance: + +commands.source module +---------------------- + +.. automodule:: commands.source + :members: + :undoc-members: + :show-inheritance: + +commands.template module +------------------------ + +.. automodule:: commands.template + :members: + :undoc-members: + :show-inheritance: + +commands.test module +-------------------- + +.. automodule:: commands.test + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: commands + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/build/html/_sources/apidoc_commands/modules.rst.txt b/doc/build/html/_sources/apidoc_commands/modules.rst.txt new file mode 100644 index 0000000..6a11c3d --- /dev/null +++ b/doc/build/html/_sources/apidoc_commands/modules.rst.txt @@ -0,0 +1,7 @@ +commands +======== + +.. toctree:: + :maxdepth: 4 + + commands diff --git a/doc/build/html/_sources/apidoc_src/modules.rst.txt b/doc/build/html/_sources/apidoc_src/modules.rst.txt new file mode 100644 index 0000000..e9ff8ac --- /dev/null +++ b/doc/build/html/_sources/apidoc_src/modules.rst.txt @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + src diff --git a/doc/build/html/_sources/apidoc_src/src.colorama.rst.txt b/doc/build/html/_sources/apidoc_src/src.colorama.rst.txt new file mode 100644 index 0000000..65cd0c2 --- /dev/null +++ b/doc/build/html/_sources/apidoc_src/src.colorama.rst.txt @@ -0,0 +1,54 @@ +src.colorama package +==================== + +Submodules +---------- + +src.colorama.ansi module +------------------------ + +.. automodule:: src.colorama.ansi + :members: + :undoc-members: + :show-inheritance: + +src.colorama.ansitowin32 module +------------------------------- + +.. automodule:: src.colorama.ansitowin32 + :members: + :undoc-members: + :show-inheritance: + +src.colorama.initialise module +------------------------------ + +.. automodule:: src.colorama.initialise + :members: + :undoc-members: + :show-inheritance: + +src.colorama.win32 module +------------------------- + +.. automodule:: src.colorama.win32 + :members: + :undoc-members: + :show-inheritance: + +src.colorama.winterm module +--------------------------- + +.. automodule:: src.colorama.winterm + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: src.colorama + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/build/html/_sources/apidoc_src/src.example.rst.txt b/doc/build/html/_sources/apidoc_src/src.example.rst.txt new file mode 100644 index 0000000..1000632 --- /dev/null +++ b/doc/build/html/_sources/apidoc_src/src.example.rst.txt @@ -0,0 +1,30 @@ +src.example package +=================== + +Submodules +---------- + +src.example.essai_logging_1 module +---------------------------------- + +.. automodule:: src.example.essai_logging_1 + :members: + :undoc-members: + :show-inheritance: + +src.example.essai_logging_2 module +---------------------------------- + +.. automodule:: src.example.essai_logging_2 + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: src.example + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/build/html/_sources/apidoc_src/src.rst.txt b/doc/build/html/_sources/apidoc_src/src.rst.txt new file mode 100644 index 0000000..fd0d004 --- /dev/null +++ b/doc/build/html/_sources/apidoc_src/src.rst.txt @@ -0,0 +1,206 @@ +src package +=========== + +Subpackages +----------- + +.. toctree:: + + src.colorama + src.example + +Submodules +---------- + +src.ElementTree module +---------------------- + +.. automodule:: src.ElementTree + :members: + :undoc-members: + :show-inheritance: + +src.architecture module +----------------------- + +.. automodule:: src.architecture + :members: + :undoc-members: + :show-inheritance: + +src.catchAll module +------------------- + +.. automodule:: src.catchAll + :members: + :undoc-members: + :show-inheritance: + +src.coloringSat module +---------------------- + +.. automodule:: src.coloringSat + :members: + :undoc-members: + :show-inheritance: + +src.compilation module +---------------------- + +.. automodule:: src.compilation + :members: + :undoc-members: + :show-inheritance: + +src.configManager module +------------------------ + +.. automodule:: src.configManager + :members: + :undoc-members: + :show-inheritance: + +src.debug module +---------------- + +.. automodule:: src.debug + :members: + :undoc-members: + :show-inheritance: + +src.environment module +---------------------- + +.. automodule:: src.environment + :members: + :undoc-members: + :show-inheritance: + +src.environs module +------------------- + +.. automodule:: src.environs + :members: + :undoc-members: + :show-inheritance: + +src.exceptionSat module +----------------------- + +.. automodule:: src.exceptionSat + :members: + :undoc-members: + :show-inheritance: + +src.fileEnviron module +---------------------- + +.. automodule:: src.fileEnviron + :members: + :undoc-members: + :show-inheritance: + +src.fork module +--------------- + +.. automodule:: src.fork + :members: + :undoc-members: + :show-inheritance: + +src.loggingSat module +--------------------- + +.. automodule:: src.loggingSat + :members: + :undoc-members: + :show-inheritance: + +src.options module +------------------ + +.. automodule:: src.options + :members: + :undoc-members: + :show-inheritance: + +src.product module +------------------ + +.. automodule:: src.product + :members: + :undoc-members: + :show-inheritance: + +src.pyconf module +----------------- + +.. automodule:: src.pyconf + :members: + :undoc-members: + :show-inheritance: + +src.returnCode module +--------------------- + +.. automodule:: src.returnCode + :members: + :undoc-members: + :show-inheritance: + +src.salomeTools module +---------------------- + +.. automodule:: src.salomeTools + :members: + :undoc-members: + :show-inheritance: + +src.system module +----------------- + +.. automodule:: src.system + :members: + :undoc-members: + :show-inheritance: + +src.template module +------------------- + +.. automodule:: src.template + :members: + :undoc-members: + :show-inheritance: + +src.test_module module +---------------------- + +.. automodule:: src.test_module + :members: + :undoc-members: + :show-inheritance: + +src.utilsSat module +------------------- + +.. automodule:: src.utilsSat + :members: + :undoc-members: + :show-inheritance: + +src.xmlManager module +--------------------- + +.. automodule:: src.xmlManager + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: src + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/build/html/_sources/commands/application.rst.txt b/doc/build/html/_sources/commands/application.rst.txt new file mode 100644 index 0000000..2052da0 --- /dev/null +++ b/doc/build/html/_sources/commands/application.rst.txt @@ -0,0 +1,55 @@ + +.. include:: ../../rst_prolog.rst + +Command application +********************* + +Description +=========== +The **application** command creates a virtual SALOME_ application. +Virtual SALOME applications are used to start SALOME when distribution is needed. + +Usage +===== +* Create an application: :: + + sat application + + Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``. + +* Give a name to the application: :: + + sat application --name + + *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``. + +* Change the directory where the application is created: :: + + sat application --target + +* Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): :: + + sat application --catalog + + Note that the catalog specified will be copied to the application directory. + +* Generate the catalog for a list of machines: :: + + sat application --gencat machine1,machine2,machine3 + + This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh. + +* Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): :: + + sat launcher --use_mesa + +Some useful configuration pathes +================================= + +The virtual application can be configured with the virtual_app section of the configutation file. + +* **APPLICATION.virtual_app** + + * **name** : name of the launcher (to replace the default runAppli). + * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``. + diff --git a/doc/build/html/_sources/commands/clean.rst.txt b/doc/build/html/_sources/commands/clean.rst.txt new file mode 100644 index 0000000..e5d2f38 --- /dev/null +++ b/doc/build/html/_sources/commands/clean.rst.txt @@ -0,0 +1,61 @@ + +.. include:: ../../rst_prolog.rst + +Command clean +**************** + +Description +============ + +The **clean** command removes products in the *source, build, or install* directories of an application. Theses directories are usually named ``SOURCES, BUILD, INSTALL``. + +Use the options to define what directories you want to suppress and to set the list of products + + +Usage +======= + +* Clean all previously created *build* and *install* directories (example application as *SALOME_xx*): + + .. code-block:: bash + + # take care, is long time to restore, sometimes + sat clean SALOME-xx --build --install + +* Clean previously created *build* and *install* directories, only for products with property *is_salome_module*: + + .. code-block:: bash + + sat clean SALOME-xxx --build --install \ + --properties is_salome_module:yes + + +Availables options +====================== + + * **--products** : Products to clean. + + * **--properties** : + + | Filter the products by their properties. + | Syntax: *--properties :* + + * **--sources** : Clean the product source directories. + + * **--build** : Clean the product build directories. + + * **--install** : Clean the product install directories. + + * **--all** : Clean the product source, build and install directories. + + * **--sources_without_dev** : + + | Do not clean the products in development mode, + | (they could have VCS_ commits pending). + + + +Some useful configuration pathes +================================= + +No specific configuration. diff --git a/doc/build/html/_sources/commands/compile.rst.txt b/doc/build/html/_sources/commands/compile.rst.txt new file mode 100644 index 0000000..915705e --- /dev/null +++ b/doc/build/html/_sources/commands/compile.rst.txt @@ -0,0 +1,75 @@ + +.. include:: ../../rst_prolog.rst + +Command compile +**************** + +Description +=========== +The **compile** command allows compiling the products of a SALOME_ application. + + +Usage +===== +* Compile a complete application: :: + + sat compile + +* Compile only some products: :: + + sat compile --products , ... + +* Use *sat -t* to duplicate the logs in the terminal (by default the log are stored and displayed with *sat log* command): :: + + sat -t compile --products + +* Compile a module and its dependencies: :: + + sat compile --products med --with_fathers + +* Compile a module and the modules depending on it (for example plugins): :: + + sat compile --products med --with_children + +* Clean the build and install directories before starting compilation: :: + + sat compile --products GEOM --clean_all + + .. note:: | a warning will be shown if option *--products* is missing + | (as it will clean everything) + +* Clean only the install directories before starting compilation: :: + + sat compile --clean_install + +* Add options for make: :: + + sat compile --products --make_flags + +* Use the *--check* option to execute the unit tests after compilation: :: + + sat compile --check + +* Remove the build directory after successful compilation (some build directory like qt are big): :: + + sat compile --products qt --clean_build_after + +* Stop the compilation as soon as the compilation of a module fails: :: + + sat compile --stop_first_fail + +* Do not compile, just show if products are installed or not, and where is the installation: :: + + sat compile --show + + +Some useful configuration pathes +================================= + +The way to compile a product is defined in the *pyconf file configuration*. +The main options are: + + * **build_source** : the method used to build the product (cmake/autotools/script) + * **compil_script** : the compilation script if build_source is equal to "script" + * **cmake_options** : additional options for cmake. + * **nb_proc** : number of jobs to use with make for this product. diff --git a/doc/build/html/_sources/commands/config.rst.txt b/doc/build/html/_sources/commands/config.rst.txt new file mode 100644 index 0000000..ffcfdf9 --- /dev/null +++ b/doc/build/html/_sources/commands/config.rst.txt @@ -0,0 +1,89 @@ + +.. include:: ../../rst_prolog.rst + +Command config +****************** + +Description +=========== +The **config** command manages sat configuration. +It allows display, manipulation and operation on configuration files + +Usage +===== +* Edit the user personal configuration file ``$HOME/.salomeTools/SAT.pyconf``. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: :: + + sat config --edit + +* List the available applications (they come from the sat projects defined in ``data/local.pyconf``: :: + + sat config --list + +* Edit the configuration of an application: :: + + sat config --edit + +* Copy an application configuration file into the user personal directory: :: + + sat config --copy [new_name] + +* | Print the value of a configuration parameter. + | Use the automatic completion to get recursively the parameter names. + | Use *--no_label* option to get *only* the value, *without* label (useful in automatic scripts). + | Examples (with *SALOME-xx* as *SALOME-8.4.0* ): + + .. code-block:: bash + + # sat config --value + sat config --value . # all the configuration + sat config --value LOCAL + sat config --value LOCAL.workdir + + # sat config --value + sat config SALOME-xx --value APPLICATION.workdir + sat config SALOME-xx --no_label --value APPLICATION.workdir + +* | Print in one-line-by-value mode the value of a configuration parameter, + | with its source *expression*, if any. + | This is a debug mode, useful for developers. + | Prints the parameter path, the source expression if any, and the final value: + + :: + + sat config SALOME-xx -g USER + + .. note:: And so, *not only for fun*, to get **all expressions** of configuration + + .. code-block:: bash + + sat config SALOME-xx -g . | grep -e "-->" + + +* Print the patches that are applied: :: + + sat config SALOME-xx --show_patchs + +* Get information on a product configuration: + +.. code-block:: bash + + # sat config --info + sat config SALOME-xx --info KERNEL + sat config SALOME-xx --info qt + +Some useful configuration pathes +================================= + +Exploring a current configuration. + +* **PATHS**: To get list of directories where to find files. + +* **USER**: To get user preferences (editor, pdf viewer, web browser, default working dir). + +sat commands: :: + + sat config SALOME-xx -v PATHS + sat config SALOME-xx -v USERS + + + diff --git a/doc/build/html/_sources/commands/environ.rst.txt b/doc/build/html/_sources/commands/environ.rst.txt new file mode 100644 index 0000000..d487e4c --- /dev/null +++ b/doc/build/html/_sources/commands/environ.rst.txt @@ -0,0 +1,139 @@ + +.. include:: ../../rst_prolog.rst + +Command environ +**************** + +Description +=========== +The **environ** command generates the environment files used +to run and compile your application (as SALOME_ is an example). + +.. note :: + these files are **not** required, + salomeTool set the environment himself, when compiling. + And so does the salome launcher. + + These files are useful when someone wants to check the environment. + They could be used in debug mode to set the environment for *gdb*. + +The configuration part at the end of this page explains how +to specify the environment used by sat (at build or run time), +and saved in some files by *sat environ* command. + +Usage +===== +* Create the shell environment files of the application: :: + + sat environ + +* Create the environment files of the application for a given shell. + Options are bash, bat (for windows) and cfg (the configuration format used by SALOME_): :: + + sat environ --shell [bash|cfg|all] + +* Use a different prefix for the files (default is 'env'): + + .. code-block:: bash + + # This will create file _launch.sh, _build.sh + sat environ --prefix + +* Use a different target directory for the files: + + .. code-block:: bash + + # This will create file env_launch.sh, env_build.sh + # in the directory corresponding to + sat environ --target + +* Generate the environment files only with the given products: + + .. code-block:: bash + + # This will create the environment files only for the given products + # and their prerequisites. + # It is useful when you want to visualise which environment uses + # sat to compile a given product. + sat environ --product ,, ... + + +Configuration +============= + +The specification of the environment can be done through several mechanisms. + +1. For salome products (the products with the property ``is_SALOME_module`` as ``yes``) the environment is set automatically by sat, in respect with SALOME_ requirements. + +2. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically. + +Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories. +In the following example, we prepend */lib* to ``LD_LIBRARY_PATH`` (note the *left first* underscore), append */lib* to ``PYTHONPATH`` (note the *right last* underscore), and set ``LAPACK_ROOT_DIR`` to **: + +.. code-block:: bash + + environ : + { + _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib" + PYTHONPATH_ : $install_dir + $VARS.sep + "lib" + LAPACK_ROOT_DIR : $install_dir + } + +It is possible to distinguish the build environment from the launch environment: use a subsection called *build* or *launch*. In the example below, ``LD_LIBRARY_PATH`` and ``PYTHONPATH`` are only modified at run time, not at compile time: + +.. code-block:: bash + + environ : + { + build : + { + LAPACK_ROOT_DIR : $install_dir + } + launch : + { + LAPACK_ROOT_DIR : $install_dir + _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib" + PYTHONPATH_ : $install_dir + $VARS.sep + "lib" + } + } + +3. The last possibility is to set the environment with a python script. The script should be provided in the *products/env_scripts* directory of the sat project, and its name is specified in the environment section with the key ``environ.env_script``: + +.. code-block:: python + + environ : + { + env_script : 'lapack.py' + } + +Please note that the two modes are complementary and are both taken into account. +Most of the time, the first mode is sufficient. + +The second mode can be used when the environment has to be set programmatically. +The developer implements a handle (as a python method) +which is called by sat to set the environment. +Here is an example: + +.. code-block:: python + + + #!/usr/bin/env python + #-*- coding:utf-8 -*- + + import os.path + import platform + + def set_env(env, prereq_dir, version): + env.set("TRUST_ROOT_DIR",prereq_dir) + env.prepend('PATH', os.path.join(prereq_dir, 'bin')) + env.prepend('PATH', os.path.join(prereq_dir, 'include')) + env.prepend('LD_LIBRARY_PATH', os.path.join(prereq_dir, 'lib')) + return + +SalomeTools defines four handles: + +* **set_env(env, prereq_dir, version)** : used at build and run time. +* **set_env_launch(env, prereq_dir, version)** : used only at run time (if defined!) +* **set_env_build(env, prereq_dir, version)** : used only at build time (if defined!) +* **set_native_env(env)** : used only for native products, at build and run time. + diff --git a/doc/build/html/_sources/commands/generate.rst.txt b/doc/build/html/_sources/commands/generate.rst.txt new file mode 100644 index 0000000..f753261 --- /dev/null +++ b/doc/build/html/_sources/commands/generate.rst.txt @@ -0,0 +1,39 @@ + +.. include:: ../../rst_prolog.rst + +Command generate +**************** + +Description +=========== +The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN. + +.. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``. + + +Remarks +======= +* This command will only apply on the CPP modules of the application, those who have both properties: :: + + cpp : "yes" + generate : "yes" + +* The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation) + + +Usage +===== +* Generate all the modules of a product: :: + + sat generate + +* Generate only specific modules: :: + + sat generate --products + + Remark: modules which don't have the *generate* property are ignored. + +* Use a specific version of YACSGEN: :: + + sat generate --yacsgen + diff --git a/doc/build/html/_sources/commands/launcher.rst.txt b/doc/build/html/_sources/commands/launcher.rst.txt new file mode 100644 index 0000000..864a31a --- /dev/null +++ b/doc/build/html/_sources/commands/launcher.rst.txt @@ -0,0 +1,52 @@ + +.. include:: ../../rst_prolog.rst + +Command launcher +****************** + +Description +=========== +The **launcher** command creates a SALOME launcher, a python script file to start SALOME_. + + +Usage +===== +* Create a launcher: :: + + sat launcher + + Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``. + +* Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) :: + + sat launcher --name ZeLauncher + + The launcher will be called *ZeLauncher*. + +* Set a specific resources catalog: :: + + sat launcher --catalog + + Note that the catalog specified will be copied to the profile directory. + +* Generate the catalog for a list of machines: :: + + sat launcher --gencat + + This will create a catalog by querying each machine (memory, number of processor) with ssh. + +* Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): :: + + sat launcher --use_mesa + + +Configuration +============= + +Some useful configuration pathes: + +* **APPLICATION.profile** + + * **product** : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen) + * **launcher_name** : the name of the launcher. + diff --git a/doc/build/html/_sources/commands/log.rst.txt b/doc/build/html/_sources/commands/log.rst.txt new file mode 100644 index 0000000..9908f4b --- /dev/null +++ b/doc/build/html/_sources/commands/log.rst.txt @@ -0,0 +1,46 @@ + +.. include:: ../../rst_prolog.rst + +Command log +**************** + +Description +=========== +The **log** command displays sat log in a web browser or in a terminal. + +Usage +===== +* Show (in a web browser) the log of the commands corresponding to an application: :: + + sat log + +* Show the log for commands that do not use any application: :: + + sat log + +* The --terminal (or -t) display the log directly in the terminal, through a CLI_ interactive menu: :: + + sat log --terminal + +* The --last option displays only the last command: :: + + sat log --last + +* To access the last compilation log in terminal mode, use --last_terminal option: :: + + sat log --last_terminal + +* The --clean (int) option erases the n older log files and print the number of remaining log files: :: + + sat log --clean 50 + + + +Some useful configuration pathes +================================= + +* **USER** + + * **browser** : The browser used to show the log (by default *firefox*). + * **log_dir** : The directory used to store the log files. + diff --git a/doc/build/html/_sources/commands/package.rst.txt b/doc/build/html/_sources/commands/package.rst.txt new file mode 100644 index 0000000..6d6648a --- /dev/null +++ b/doc/build/html/_sources/commands/package.rst.txt @@ -0,0 +1,81 @@ + +.. include:: ../../rst_prolog.rst + +Command package +**************** + +Description +============ +The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz). +This tar file is used later to intall SALOME on other remote computer. + +Depending on the selected options, the archive includes sources and binaries +of SALOME products and prerequisites. + +Usually utility *salomeTools* is included in the archive. + +.. note:: + By default the package includes the sources of prerequisites and products. + To select a subset use the *--without_property* or *--with_vcs* options. + + +Usage +===== +* Create a package for a product (example as *SALOME_xx*): :: + + sat package SALOME_xx + + This command will create an archive named ``SALOME_xx.tgz`` + in the working directory (``USER.workDir``). + If the archive already exists, do nothing. + + +* Create a package with a specific name: :: + + sat package SALOME_xx --name YourSpecificName + +.. note:: + By default, the archive is created in the working directory of the user (``USER.workDir``). + + If the option *--name* is used with a path (relative or absolute) it will be used. + + If the option *--name* is not used and binaries (prerequisites and products) + are included in the package, the OS_ architecture + will be appended to the name (example: ``SALOME_xx-CO7.tgz``). + + Examples: :: + + # Creates SALOME_xx.tgz in $USER.workDir + sat package SALOME_xx + + # Creates SALOME_xx_.tgz in $USER.workDir + sat package SALOME_xx --binaries + + # Creates MySpecificName.tgz in $USER.workDir + sat package SALOME_xx --name MySpecificName + + +* Force the creation of the archive (if it already exists): :: + + sat package SALOME_xx --force + + +* Include the binaries in the archive (products and prerequisites): :: + + sat package SALOME_xx --binaries + + This command will create an archive named ``SALOME_xx _.tgz`` + where is the OS_ architecture of the machine. + + +* Do not delete Version Control System (VCS_) informations from the configurations files of the embedded salomeTools: :: + + sat package SALOME_xx --with_vcs + + The version control systems known by this option are CVS_, SVN_ and Git_. + + +Some useful configuration pathes +================================= + +No specific configuration. diff --git a/doc/build/html/_sources/commands/prepare.rst.txt b/doc/build/html/_sources/commands/prepare.rst.txt new file mode 100644 index 0000000..a28fdae --- /dev/null +++ b/doc/build/html/_sources/commands/prepare.rst.txt @@ -0,0 +1,100 @@ + +.. include:: ../../rst_prolog.rst + +Command prepare +**************** + +Description +=========== +The **prepare** command brings the sources of an application in the *sources +application directory*, in order to compile them with the compile command. + +The sources can be prepared from VCS software (*cvs, svn, git*), an archive or a directory. + +.. warning:: When sat prepares a product, it first removes the + existing directory, except if the development mode is activated. + When you are working on a product, you need to declare in + the application configuration this product in **dev** mode. + +Remarks +======= + +VCS bases (git, svn, cvs) +------------------------- + +The *prepare* command does not manage authentication on the cvs server. +For example, to prepare modules from a cvs server, you first need to login once. + +To avoid typing a password for each product, +you may use a ssh key with passphrase, or store your password +(in .cvspass or .gitconfig files). +If you have security concerns, it is also possible to use +a bash agent and type your password only once. + + + +Dev mode +-------- + +By default *prepare* uses *export* mode: it creates an image +of the sources, corresponding to the tag or branch specified, +without any link to the VCS base. +To perform a *checkout* (svn, cvs) or a *git clone* (git), +you need to declare the product in dev mode in your application configuration: +edit the application configuration file (pyconf) and modify the product declaration: + +.. code-block:: bash + + sat config -e + # and edit the product section: + # : {tag : "my_tag", dev : "yes", debug : "yes"} + +The first time you will execute the *sat prepare* command, +your module will be downloaded in *checkout* mode +(inside the SOURCES directory of the application. +Then, you can develop in this repository, and finally push +them in the base when they are ready. +If you type during the development process by mistake +a *sat prepare* command, the sources in dev mode will +not be altered/removed (Unless you use -f option) + + +Usage +===== +* Prepare the sources of a complete application in SOURCES directory (all products): :: + + sat prepare + +* Prepare only some modules: :: + + sat prepare --products , ... + +* Use --force to force to prepare the products in development mode + (this will remove the sources and do a new clone/checkout): :: + + sat prepare --force + +* Use --force_patch to force to apply patch to the products + in development mode (otherwise they are not applied): :: + + sat prepare --force_patch + + +Some useful configuration pathes +================================= + +Command *sat prepare* uses the *pyconf file configuration* of each product to know how to get the sources. + +.. note:: to verify configuration of a product, and get name of this *pyconf files configuration* + + .. code-block :: bash + + sat config --info + + +* **get_method**: the method to use to prepare the module, possible values are cvs, git, archive, dir. +* **git_info** : (used if get_method = git) information to prepare sources from git. +* **svn_info** : (used if get_method = svn) information to prepare sources from cvs. +* **cvs_info** : (used if get_method = cvs) information to prepare sources from cvs. +* **archive_info** : (used if get_method = archive) the path to the archive. +* **dir_info** : (used if get_method = dir) the directory with the sources. diff --git a/doc/build/html/_sources/configuration.rst.txt b/doc/build/html/_sources/configuration.rst.txt new file mode 100644 index 0000000..7f415a3 --- /dev/null +++ b/doc/build/html/_sources/configuration.rst.txt @@ -0,0 +1,88 @@ +************* +Configuration +************* + +*salomeTools* uses files to store its configuration parameters. + +There are several configuration files which are loaded by salomeTools in a specific order. +When all the files are loaded a *config* object is created. +Then, this object is passed to all command scripts. + + +Syntax +====== +The configuration files use a python-like structure format +(see `config module `_ for a complete description). + +* **{}** define a dictionary, +* **[]** define a list, +* **@** can be used to include a file, +* **$prefix** reference to another parameter (ex: ``$PRODUCT.name``), +* **#** comments. + +.. note:: in this documentation a reference to a configuration parameter will be noted ``XXX.YYY``. + +Description +=========== + +.. _VARS-Section: + +VARS section +------------- +| This section is dynamically created by salomeTools at run time. +| It contains information about the environment: date, time, OS, architecture etc. + +:: + + # to get the current setting + sat config --value VARS + +PRODUCTS section +------------------ +| This section is defined in the product file. +| It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions) + +:: + + # to get the current setting + sat config SALOME-xx --value PRODUCTS + +APPLICATION section +--------------------- +| This section is optional, it is also defined in the product file. +| It gives additional parameters to create an application based on SALOME, as versions of products to use. + +:: + + # to get the current setting + sat config SALOME-xx --value APPLICATION + + +.. _USER-Section: + +USER section +-------------- +This section is defined by the user configuration file, +``~/.salomeTools/salomeTools.pyconf``. + +The ``USER`` section defines some parameters (not exhaustive): + +* **workDir** : + + | The working directory. + | Each product will be usually installed here (in sub-directories). + +* **browser** : The web browser to use (*firefox*). + +* **editor** : The editor to use (*vi, pluma*). + +* and other user preferences. + +:: + + # to get the current setting + sat config SALOME-xx --value USER + + + + diff --git a/doc/build/html/_sources/index.rst.txt b/doc/build/html/_sources/index.rst.txt new file mode 100644 index 0000000..11740aa --- /dev/null +++ b/doc/build/html/_sources/index.rst.txt @@ -0,0 +1,84 @@ + +.. include:: ../rst_prolog.rst + +.. empty first toctree is used for pdf contents maxdepth, see sphinx/builders/latex/__init__.py, toctrees[0].get('maxdepth') + +.. toctree:: + :maxdepth: 2 + +************ +Salome Tools +************ + +.. image:: images/sat_about.png + :scale: 100 % + :align: center + +.. warning:: This documentation is under construction. + +The **Sa**\ lome\ **T**\ ools (sat) is a suite of commands +that can be used to perform operations on SALOME_. + +For example, sat allows you to compile SALOME's codes +(prerequisites, products) +create application, run tests, create package, etc. + +This utility code is a set of Python_ scripts files. + +Find a `pdf version of this documentation `_ + + +Quick start +=========== + +.. toctree:: + :maxdepth: 1 + + Installation of salomeTools + Configuration + Usage of salomeTools + +List of Commands +================ + +.. toctree:: + :maxdepth: 1 + + config + prepare + compile + launcher + application + log + environ + clean + package + generate + +Developer documentation +======================= + +.. toctree:: + :maxdepth: 1 + + Add a command + + +Code documentation +================== + +.. toctree:: + :maxdepth: 1 + + SAT src modules + SAT commands modules + + +Release Notes +============= + +.. toctree:: + :maxdepth: 1 + + Release Notes 5.0.0 + diff --git a/doc/build/html/_sources/installation_of_sat.rst.txt b/doc/build/html/_sources/installation_of_sat.rst.txt new file mode 100644 index 0000000..da661be --- /dev/null +++ b/doc/build/html/_sources/installation_of_sat.rst.txt @@ -0,0 +1,15 @@ +************ +Installation +************ + +Usually user could find (and use) command **sat** directly after a 'detar' installation of SALOME. + +.. code-block:: bash + + tar -xf .../SALOME_xx.tgz + cd SALOME_xx + ls -l sat # sat -> salomeTools/sat + + +Python package (scripts of salomeTools) actually remains in directory *salomeTools*. + diff --git a/doc/build/html/_sources/release_notes/release_notes_5.0.0.rst.txt b/doc/build/html/_sources/release_notes/release_notes_5.0.0.rst.txt new file mode 100644 index 0000000..55b6aad --- /dev/null +++ b/doc/build/html/_sources/release_notes/release_notes_5.0.0.rst.txt @@ -0,0 +1,5 @@ +*************** +Release notes +*************** + +In construction. diff --git a/doc/build/html/_sources/usage_of_sat.rst.txt b/doc/build/html/_sources/usage_of_sat.rst.txt new file mode 100644 index 0000000..80c7b46 --- /dev/null +++ b/doc/build/html/_sources/usage_of_sat.rst.txt @@ -0,0 +1,97 @@ + +.. include:: ../rst_prolog.rst + +******************** +Usage of SAlomeTools +******************** + +Usage +===== +sat usage is a Command Line Interface (CLI_). + +.. code-block:: bash + + sat [generic_options] [command] [product] [command_options] + +Options of sat +-------------- + +Useful *not exhaustive* generic options of *sat* CLI. + +*--help or -h* +............... + +Get help as simple text. + +.. code-block:: bash + + sat --help # get the list of existing commands + sat --help compile # get the help on a specific command 'compile' + + +*--debug or -g* +................ + +Execution in debug mode allows to see more trace and *stack* if an exception is raised. + +*--verbose or -v* +.................. + +Change verbosity level (default is 3). + +.. code-block:: bash + + # for product 'SALOME_xx' for example + # execute compile command in debug mode with trace level 4 + sat -g -v 4 compile SALOME_xx + + +Build a SALOME product +====================== + +Get the list of available products +---------------------------------- + +To get the list of the current available products in your context: + +.. code-block:: bash + + sat config --list + +Prepare sources of a product +---------------------------- + +To prepare (get) *all* the sources of a product (*SALOME_xx* for example): + +.. code-block:: bash + + sat prepare SALOME_xx + +| The sources are usually copied in directories +| *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name* + + +Compile SALOME +---------------- + +To compile products: + +.. code-block:: bash + + # compile all prerequisites/products + sat compile SALOME_xx + + # compile only 2 products (KERNEL and SAMPLES), if not done yet + sat compile SALOME_xx --products KERNEL,SAMPLES + + # compile only 2 products, unconditionaly + sat compile SALOME_xx ---products SAMPLES --clean_all + + +| The products are usually build in the directories +| *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name* +| +| The products are usually installed in the directories +| *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name* + + diff --git a/doc/build/html/_sources/write_command.rst.txt b/doc/build/html/_sources/write_command.rst.txt new file mode 100644 index 0000000..a3f48f8 --- /dev/null +++ b/doc/build/html/_sources/write_command.rst.txt @@ -0,0 +1,156 @@ + +.. include:: ../rst_prolog.rst + + +Add a user custom command +*************************** + +Introduction +============ + +.. note:: This documentation is for Python_ developers. + + +The salomeTools product provides a simple way to develop commands. +The first thing to do is to add a file with *.py* extension in the ``commands`` directory of salomeTools. + +Here are the basic requirements that must be followed in this file in order to add a command. + +Basic requirements +================== + +.. warning:: ALL THIS IS OBSOLETE FOR SAT 5.1 + +By adding a file *mycommand.py* in the ``commands`` directory, salomeTools will define a new command named ``mycommand``. + +In *mycommand.py*, there must be the following method: :: + + def run(args, runner, logger): + # your algorithm ... + pass + +In fact, at this point, the command will already be functional. +But there are some useful services provided by salomeTools : + +* You can give some options to your command: + +.. code-block:: python + + import src + + # Define all possible option for mycommand command : 'sat mycommand ' + parser = src.options.Options() + parser.add_option('m', 'myoption', \ + 'boolean', 'myoption', \ + 'My option changes the behavior of my command.') + + def run(args, runner, logger): + # Parse the options + (options, args) = parser.parse_args(args) + # algorithm + + +* You can add a *description* method that will display a message when the user will call the help: + + +.. code-block:: python + :emphasize-lines: 9,10 + + import src + + # Define all possible option for mycommand command : 'sat mycommand ' + parser = src.options.Options() + parser.add_option('m', 'myoption', \ + 'boolean', 'myoption', \ + 'My option changes the behavior of my command.') + + def description(): + return _("The help of mycommand.") + + def run(args, runner, logger): + # Parse the options + (options, args) = parser.parse_args(args) + # algorithm + +HowTo access salomeTools config and other commands +======================================================== + +The *runner* variable is an python instance of *Sat* class. +It gives access to *runner.getConfig()* which is the data model defined from all +*configuration pyconf files* of salomeTools +For example, *runner.cfg.APPLICATION.workdir* +contains the root directory of the current application. + +The *runner* variable gives also access to other commands of salomeTools: + +.. code-block:: python + + # as CLI_ 'sat prepare ...' + runner.prepare(runner.cfg.VARS.application) + +HowTo logger +============== + +The logger variable is an instance of the python ``logging`` package class. +It gives access to ``debug, info, warning, error, critical`` methods. + +Using these methods, the message passed as parameter +will be displayed in the terminal and written in an xml log file. + +.. code-block:: python + + logger.info("My message") + + +HELLO example +============== + +Here is a *hello* command, file *commands/hello.py*: + +.. code-block:: python + + import src + + """ + hello.py + Define all possible options for hello command: + sat hello + """ + + parser = src.options.Options() + parser.add_option('f', 'french', 'boolean', 'french', "french set hello message in french.") + + def description(): + return _("The help of hello.") + + def run(args, runner, logger): + # Parse the options + (options, args) = parser.parse_args(args) + # algorithm + if not options.french: + logger.info('HELLO! WORLD!\n') + else: + logger.writeinfo('Bonjour tout le monde!\n') + +A first call of hello: + +.. code-block:: bash + + # Get the help of hello: + ./sat --help hello + + # To get bonjour + ./sat hello --french + Bonjour tout le monde! + + # To get hello + ./sat hello + HELLO! WORLD! + + # To get the log + ./sat log + + + + + diff --git a/doc/build/html/_static/basic.css b/doc/build/html/_static/basic.css index 0b79414..19ced10 100644 --- a/doc/build/html/_static/basic.css +++ b/doc/build/html/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -82,9 +82,21 @@ div.sphinxsidebar input { } div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; } + img { border: 0; max-width: 100%; @@ -122,6 +134,8 @@ ul.keywordmatches li.goodmatch a { table.contentstable { width: 90%; + margin-left: auto; + margin-right: auto; } table.contentstable p.biglink { @@ -149,9 +163,14 @@ table.indextable td { vertical-align: top; } -table.indextable dl, table.indextable dd { +table.indextable ul { margin-top: 0; margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; } table.indextable tr.pcap { @@ -183,8 +202,20 @@ div.genindex-jumpbox { padding: 0.4em; } +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + /* -- general body styles --------------------------------------------------- */ +div.body { + min-width: 450px; + max-width: 800px; +} + div.body p, div.body dd, div.body li, div.body blockquote { -moz-hyphens: auto; -ms-hyphens: auto; @@ -217,10 +248,6 @@ div.body td { text-align: left; } -.field-list ul { - padding-left: 1em; -} - .first { margin-top: 0 !important; } @@ -322,6 +349,11 @@ table.docutils { border-collapse: collapse; } +table.align-center { + margin-left: auto; + margin-right: auto; +} + table caption span.caption-number { font-style: italic; } @@ -337,10 +369,6 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } -table.field-list td, table.field-list th { - border: 0 !important; -} - table.footnote td, table.footnote th { border: 0 !important; } @@ -377,6 +405,27 @@ div.figure p.caption span.caption-number { div.figure p.caption span.caption-text { } +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} /* -- other body styles ----------------------------------------------------- */ @@ -418,24 +467,19 @@ dd { margin-left: 30px; } -dt:target, .highlighted { +dt:target, span.highlighted { background-color: #fbe54e; } +rect.highlighted { + fill: #fbe54e; +} + dl.glossary dt { font-weight: bold; font-size: 1.1em; } -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - .optional { font-size: 1.3em; } @@ -592,6 +636,16 @@ span.eqno { float: right; } +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + /* -- printout stylesheet --------------------------------------------------- */ @media print { diff --git a/doc/build/html/_static/comment-bright.png b/doc/build/html/_static/comment-bright.png index 4a2bf8a..15e27ed 100644 Binary files a/doc/build/html/_static/comment-bright.png and b/doc/build/html/_static/comment-bright.png differ diff --git a/doc/build/html/_static/comment-close.png b/doc/build/html/_static/comment-close.png index 5fe0897..4d91bcf 100644 Binary files a/doc/build/html/_static/comment-close.png and b/doc/build/html/_static/comment-close.png differ diff --git a/doc/build/html/_static/comment.png b/doc/build/html/_static/comment.png index e651e98..dfbc0cb 100644 Binary files a/doc/build/html/_static/comment.png and b/doc/build/html/_static/comment.png differ diff --git a/doc/build/html/_static/doctools.js b/doc/build/html/_static/doctools.js index 8163495..d892892 100644 --- a/doc/build/html/_static/doctools.js +++ b/doc/build/html/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -45,7 +45,7 @@ jQuery.urlencode = encodeURIComponent; * it will always return arrays of strings for the value parts. */ jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') + if (typeof s === 'undefined') s = document.location.search; var parts = s.substr(s.indexOf('?') + 1).split('&'); var result = {}; @@ -66,29 +66,55 @@ jQuery.getQueryParameters = function(s) { * span elements with the given class name. */ jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { + function highlight(node, addItems) { + if (node.nodeType === 3) { var val = node.nodeValue; var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span = document.createElement("span"); - span.className = className; + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } span.appendChild(document.createTextNode(val.substr(pos, text.length))); node.parentNode.insertBefore(span, node.parentNode.insertBefore( document.createTextNode(val.substr(pos + text.length)), node.nextSibling)); node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var bbox = span.getBBox(); + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + var parentOfText = node.parentNode.parentNode; + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } } } else if (!jQuery(node).is("button, select, textarea")) { jQuery.each(node.childNodes, function() { - highlight(this); + highlight(this, addItems); }); } } - return this.each(function() { - highlight(this); + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; }; /* @@ -131,21 +157,21 @@ var Documentation = { * i18n support */ TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, LOCALE : 'unknown', // gettext and ngettext don't access this so that the functions // can safely bound to a different name (_ = Documentation.gettext) gettext : function(string) { var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated == 'undefined') + if (typeof translated === 'undefined') return string; - return (typeof translated == 'string') ? translated : translated[0]; + return (typeof translated === 'string') ? translated : translated[0]; }, ngettext : function(singular, plural, n) { var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') + if (typeof translated === 'undefined') return (n == 1) ? singular : plural; return translated[Documentation.PLURALEXPR(n)]; }, @@ -180,7 +206,7 @@ var Documentation = { * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 */ fixFirefoxAnchorBug : function() { - if (document.location.hash) + if (document.location.hash && $.browser.mozilla) window.setTimeout(function() { document.location.href += ''; }, 10); @@ -216,7 +242,7 @@ var Documentation = { var src = $(this).attr('src'); var idnum = $(this).attr('id').substr(7); $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) == 'minus.png') + if (src.substr(-9) === 'minus.png') $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); else $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); @@ -248,7 +274,7 @@ var Documentation = { var path = document.location.pathname; var parts = path.split(/\//); $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') + if (this === '..') parts.pop(); }); var url = parts.join('/'); diff --git a/doc/build/html/_static/documentation_options.js b/doc/build/html/_static/documentation_options.js new file mode 100644 index 0000000..47f9066 --- /dev/null +++ b/doc/build/html/_static/documentation_options.js @@ -0,0 +1,9 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: '', + VERSION: '5.0.0dev', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' +}; \ No newline at end of file diff --git a/doc/build/html/_static/down-pressed.png b/doc/build/html/_static/down-pressed.png index 20cd4e2..5756c8c 100644 Binary files a/doc/build/html/_static/down-pressed.png and b/doc/build/html/_static/down-pressed.png differ diff --git a/doc/build/html/_static/down.png b/doc/build/html/_static/down.png index b440895..1b3bdad 100644 Binary files a/doc/build/html/_static/down.png and b/doc/build/html/_static/down.png differ diff --git a/doc/build/html/_static/file.png b/doc/build/html/_static/file.png index eedc819..a858a41 100644 Binary files a/doc/build/html/_static/file.png and b/doc/build/html/_static/file.png differ diff --git a/doc/build/html/_static/jquery-3.2.1.js b/doc/build/html/_static/jquery-3.2.1.js new file mode 100644 index 0000000..d2d8ca4 --- /dev/null +++ b/doc/build/html/_static/jquery-3.2.1.js @@ -0,0 +1,10253 @@ +/*! + * jQuery JavaScript Library v3.2.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2017-03-20T18:59Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + + + + function DOMEval( code, doc ) { + doc = doc || document; + + var script = doc.createElement( "script" ); + + script.text = code; + doc.head.appendChild( script ).parentNode.removeChild( script ); + } +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.2.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, + + // Matches dashed string for camelizing + rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return letter.toUpperCase(); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + + if ( copyIsArray ) { + copyIsArray = false; + clone = src && Array.isArray( src ) ? src : []; + + } else { + clone = src && jQuery.isPlainObject( src ) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isFunction: function( obj ) { + return jQuery.type( obj ) === "function"; + }, + + isWindow: function( obj ) { + return obj != null && obj === obj.window; + }, + + isNumeric: function( obj ) { + + // As of jQuery 3.0, isNumeric is limited to + // strings and numbers (primitives or objects) + // that can be coerced to finite numbers (gh-2662) + var type = jQuery.type( obj ); + return ( type === "number" || type === "string" ) && + + // parseFloat NaNs numeric-cast false positives ("") + // ...but misinterprets leading-number strings, particularly hex literals ("0x...") + // subtraction forces infinities to NaN + !isNaN( obj - parseFloat( obj ) ); + }, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + + /* eslint-disable no-unused-vars */ + // See https://github.com/eslint/eslint/issues/6125 + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + type: function( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; + }, + + // Evaluates a script in a global context + globalEval: function( code ) { + DOMEval( code ); + }, + + // Convert dashed to camelCase; used by the css and data modules + // Support: IE <=9 - 11, Edge 12 - 13 + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + var tmp, args, proxy; + + if ( typeof context === "string" ) { + tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + args = slice.call( arguments, 2 ); + proxy = function() { + return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || jQuery.guid++; + + return proxy; + }, + + now: Date.now, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = jQuery.type( obj ); + + if ( type === "function" || jQuery.isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.3 + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2016-08-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + disabledAncestor = addCombinator( + function( elem ) { + return elem.disabled === true && ("form" in elem || "label" in elem); + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !compilerCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + + if ( nodeType !== 1 ) { + newContext = context; + newSelector = selector; + + // qSA looks outside Element context, which is not what we want + // Thanks to Andrew Dupont for this workaround technique + // Support: IE <=8 + // Exclude object elements + } else if ( context.nodeName.toLowerCase() !== "object" ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + disabledAncestor( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + if ( support.matchesSelector && documentIsHTML && + !compilerCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) {} + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +var risSimple = /^.[^:#\[\.,]*$/; + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Simple selector that can be filtered directly, removing non-Elements + if ( risSimple.test( qualifier ) ) { + return jQuery.filter( qualifier, elements, not ); + } + + // Complex selector, compare the two sets, removing non-Elements + qualifier = jQuery.filter( qualifier, elements ); + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1; + } ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( jQuery.isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( nodeName( elem, "iframe" ) ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( jQuery.isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && jQuery.isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( jQuery.isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + jQuery.isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( jQuery.type( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !jQuery.isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ jQuery.camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ jQuery.camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( jQuery.camelCase ); + } else { + key = jQuery.camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + jQuery.contains( elem.ownerDocument, elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, + scale = 1, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + do { + + // If previous iteration zeroed out, double until we get *something*. + // Use string for doubling so we don't accidentally see scale as unchanged below + scale = scale || ".5"; + + // Adjust and apply + initialInUnit = initialInUnit / scale; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Update scale, tolerating zero or NaN from tween.cur() + // Break the loop if scale is unchanged or perfect, or if we've just had enough. + } while ( + scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations + ); + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i ); + +var rscriptType = ( /^$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, contains, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( jQuery.type( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); +var documentElement = document.documentElement; + + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 only +// See #13393 for more info +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or 2) have namespace(s) + // a subset or equal to those in the bound event (both can have no namespace). + if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: jQuery.isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + this.focus(); + return false; + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( ">tbody", elem )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + var match = rscriptTypeMasked.exec( elem.type ); + + if ( match ) { + elem.type = match[ 1 ]; + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + isFunction = jQuery.isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( isFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( isFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl ) { + jQuery._evalUrl( node.src ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && jQuery.contains( node.ownerDocument, node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = jQuery.contains( elem.ownerDocument, elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rmargin = ( /^margin/ ); + +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + div.style.cssText = + "box-sizing:border-box;" + + "position:relative;display:block;" + + "margin:auto;border:1px;padding:1px;" + + "top:1%;width:50%"; + div.innerHTML = ""; + documentElement.appendChild( container ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = divStyle.marginLeft === "2px"; + boxSizingReliableVal = divStyle.width === "4px"; + + // Support: Android 4.0 - 4.3 only + // Some styles come back with percentage values, even though they shouldn't + div.style.marginRight = "50%"; + pixelMarginRightVal = divStyle.marginRight === "4px"; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" + + "padding:0;margin-top:1px;position:absolute"; + container.appendChild( div ); + + jQuery.extend( support, { + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelMarginRight: function() { + computeStyleTests(); + return pixelMarginRightVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }, + + cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style; + +// Return a css property mapped to a potentially vendor prefixed property +function vendorPropName( name ) { + + // Shortcut for names that are not vendor prefixed + if ( name in emptyStyle ) { + return name; + } + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a property mapped along what jQuery.cssProps suggests or to +// a vendor prefixed property. +function finalPropName( name ) { + var ret = jQuery.cssProps[ name ]; + if ( !ret ) { + ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name; + } + return ret; +} + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) { + var i, + val = 0; + + // If we already have the right measurement, avoid augmentation + if ( extra === ( isBorderBox ? "border" : "content" ) ) { + i = 4; + + // Otherwise initialize for horizontal or vertical properties + } else { + i = name === "width" ? 1 : 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin, so add it if we want it + if ( extra === "margin" ) { + val += jQuery.css( elem, extra + cssExpand[ i ], true, styles ); + } + + if ( isBorderBox ) { + + // border-box includes padding, so remove it if we want content + if ( extra === "content" ) { + val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // At this point, extra isn't border nor margin, so remove border + if ( extra !== "margin" ) { + val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } else { + + // At this point, extra isn't content, so add padding + val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // At this point, extra isn't content nor padding, so add border + if ( extra !== "padding" ) { + val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + return val; +} + +function getWidthOrHeight( elem, name, extra ) { + + // Start with computed style + var valueIsBorderBox, + styles = getStyles( elem ), + val = curCSS( elem, name, styles ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Computed unit is not pixels. Stop here and return. + if ( rnumnonpx.test( val ) ) { + return val; + } + + // Check for style in case a browser which returns unreliable values + // for getComputedStyle silently falls back to the reliable elem.style + valueIsBorderBox = isBorderBox && + ( support.boxSizingReliable() || val === elem.style[ name ] ); + + // Fall back to offsetWidth/Height when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + if ( val === "auto" ) { + val = elem[ "offset" + name[ 0 ].toUpperCase() + name.slice( 1 ) ]; + } + + // Normalize "", auto, and prepare for extra + val = parseFloat( val ) || 0; + + // Use the active box-sizing model to add/subtract irrelevant styles + return ( val + + augmentWidthOrHeight( + elem, + name, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: { + "float": "cssFloat" + }, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = jQuery.camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + if ( type === "number" ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = jQuery.camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, name ) { + jQuery.cssHooks[ name ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, name, extra ); + } ) : + getWidthOrHeight( elem, name, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = extra && getStyles( elem ), + subtract = extra && augmentWidthOrHeight( + elem, + name, + extra, + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + styles + ); + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ name ] = value; + value = jQuery.css( elem, name ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( !rmargin.test( prefix ) ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && + ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || + jQuery.cssHooks[ tween.prop ] ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = jQuery.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 13 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = jQuery.camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( jQuery.isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + jQuery.proxy( result.stop, result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( jQuery.isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( jQuery.isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + jQuery.isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( jQuery.isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = jQuery.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( jQuery.isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( typeof value === "string" && value ) { + classes = value.match( rnothtmlwhite ) || []; + + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( jQuery.isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + if ( typeof value === "string" && value ) { + classes = value.match( rnothtmlwhite ) || []; + + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value; + + if ( typeof stateVal === "boolean" && type === "string" ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( jQuery.isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( type === "string" ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = value.match( rnothtmlwhite ) || []; + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, isFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + isFunction = jQuery.isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " + + "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + + "change select submit keydown keypress keyup contextmenu" ).split( " " ), + function( i, name ) { + + // Handle event binding + jQuery.fn[ name ] = function( data, fn ) { + return arguments.length > 0 ? + this.on( name, null, data, fn ) : + this.trigger( name ); + }; +} ); + +jQuery.fn.extend( { + hover: function( fnOver, fnOut ) { + return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); + } +} ); + + + + +support.focusin = "onfocusin" in window; + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = jQuery.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && jQuery.type( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = jQuery.isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( jQuery.isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ]; + } + } + match = responseHeaders[ key.toLowerCase() ]; + } + return match == null ? null : match; + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 13 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available, append data to url + if ( s.data ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( jQuery.isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + "throws": true + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( jQuery.isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( jQuery.isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var isFunction = jQuery.isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain requests + if ( s.crossDomain ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + - + - - @@ -36,8 +24,7 @@ - - +
@@ -57,13 +44,13 @@ see Command class docstring, also used for help

class commands.application.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The application command creates a SALOME application.

Warning:
It works only for SALOME 6.
-
Use the 'launcher' command for newer versions of SALOME
+
Use the ‘launcher’ command for newer versions of SALOME

Examples:
@@ -72,7 +59,7 @@ see Command class docstring, also used for help

getParser()[source]¶
-

Define all options for command 'sat application <options>'

+

Define all options for command ‘sat application <options>’

@@ -83,7 +70,7 @@ see Command class docstring, also used for help

run(cmd_arguments)[source]¶
-

method called for command 'sat application <options>'

+

method called for command ‘sat application <options>’

@@ -136,8 +123,8 @@ This method will use appli_gen to create the application directory.

commands.application.get_step(logger, message, pad=50)[source]¶
-

returns 'message ........ ' with pad 50 by default -avoid colors '<color>' for now in message

+

returns ‘message …….. ‘ with pad 50 by default +avoid colors ‘<color>’ for now in message

@@ -151,19 +138,19 @@ avoid colors '<color>' for now in message

class commands.check.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

-

The check command executes the 'check' command in the build directory of +

Bases: src.salomeTools._BaseCommand

+

The check command executes the ‘check’ command in the build directory of all the products of the application. It is possible to reduce the list of products to check -by using the --products option

+by using the –products option

examples:
-
>> sat check SALOME --products KERNEL,GUI,GEOM
+
>> sat check SALOME –products KERNEL,GUI,GEOM
getParser()[source]¶
-

Define all options for the check command 'sat check <options>'

+

Define all options for the check command ‘sat check <options>’

@@ -174,7 +161,7 @@ by using the --products option

run(cmd_arguments)[source]¶
-

method called for command 'sat check <options>'

+

method called for command ‘sat check <options>’

@@ -189,10 +176,10 @@ in each product build directory.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products_info -- (list) +
  • config – (Config) The global configuration
    • +
  • products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -214,10 +201,10 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -239,10 +226,10 @@ configuration regarding the passed options.

Parameters:
    -
  • options -- (Options) The Options instance that stores +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • cfg -- (Config) The global configuration
    • -
  • logger -- (Logger) The logger instance to use +
  • cfg – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -254,35 +241,25 @@ for the display and logging
-
-
-commands.check.log_res_step(logger, res)[source]¶
-
- -
-
-commands.check.log_step(logger, header, step)[source]¶
-
-

commands.clean module¶

class commands.clean.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The clean command suppresses the source, build, or install directories of the application products. Use the options to define what directories you want to suppress and to reduce the list of products

examples:
-
>> sat clean SALOME --build --install --properties is_salome_module:yes
+
>> sat clean SALOME –build –install –properties is_salome_module:yes
getParser()[source]¶
-

Define all options for the command 'sat clean <options>'

+

Define all options for the command ‘sat clean <options>’

@@ -293,7 +270,7 @@ to reduce the list of products

run(cmd_arguments)[source]¶
-

method called for command 'sat clean <options>'

+

method called for command ‘sat clean <options>’

@@ -307,7 +284,7 @@ product information given as input.

-Parameters:products_infos -- (list) +Parameters:products_infos – (list) The list of (name, config) corresponding to one product. Returns:(list) the list of build paths. @@ -325,7 +302,7 @@ product information given as input.

-Parameters:products_infos -- (list) +Parameters:products_infos – (list) The list of (name, config) corresponding to one product. Returns:(list) the list of install paths. @@ -345,9 +322,9 @@ the dev products are ignored.

Parameters:
    -
  • products_infos -- (list) +
  • products_infos – (list) The list of (name, config) corresponding to one product.
    • -
  • without_dev -- (boolean) If True, then ignore the dev products.
    • +
  • without_dev – (boolean) If True, then ignore the dev products.
@@ -367,7 +344,7 @@ directory corresponding to the product described by product_info.

-Parameters:products_info -- (Config) +Parameters:products_info – (Config) The config corresponding to the product. Returns:(bool) @@ -387,8 +364,8 @@ directory corresponding to the product described by product_info. Parameters:
    -
  • l_paths -- (list) The list of Path to be suppressed
    • -
  • logger -- (Logger) +
  • l_paths – (list) The list of Path to be suppressed
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -403,16 +380,16 @@ The logger instance to use for the display and logging
class commands.compile.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The compile command constructs the products of the application

examples:
-
>> sat compile SALOME --products KERNEL,GUI,MEDCOUPLING --clean_all
+
>> sat compile SALOME –products KERNEL,GUI,MEDCOUPLING –clean_all
getParser()[source]¶
-

Define all options for the command 'sat compile <options>'

+

Define all options for the command ‘sat compile <options>’

@@ -423,7 +400,7 @@ The logger instance to use for the display and logging
run(cmd_arguments)[source]¶
-

method called for command 'sat compile <options>'

+

method called for command ‘sat compile <options>’

@@ -438,8 +415,8 @@ in the product build directory.

Parameters:
    -
  • p_info -- (Config) The specific config of the product
    • -
  • config -- (Config) The global configuration
    • +
  • p_info – (Config) The specific config of the product
    • +
  • config – (Config) The global configuration
@@ -462,10 +439,10 @@ in each product build directory.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products_info -- (list) +
  • config – (Config) The global configuration
    • +
  • products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -487,12 +464,12 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) (str, Config) => (product_name, product_info)
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • header -- (str) the header to display when logging
    • -
  • len_end -- (int) the lenght of the the end of line (used in display)
    • +
  • header – (str) the header to display when logging
    • +
  • len_end – (int) the lenght of the the end of line (used in display)
@@ -513,13 +490,13 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • header -- (str) the header to display when logging
    • -
  • len_end -- (int) the length of the the end of line (used in display)
    • +
  • header – (str) the header to display when logging
    • +
  • len_end – (int) the length of the the end of line (used in display)
@@ -539,13 +516,13 @@ The logger instance to use for the display and logging Parameters:
    -
  • p_name_info -- (tuple) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • header -- (str) the header to display when logging
    • -
  • len_end -- (int) the lenght of the the end of line (used in display)
    • +
  • header – (str) the header to display when logging
    • +
  • len_end – (int) the lenght of the the end of line (used in display)
@@ -581,10 +558,10 @@ configuration regarding the passed options.

Parameters:
    -
  • options -- (Options) +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • cfg -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • cfg – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -606,9 +583,9 @@ the product defined by prod_info

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • prod_info -- (Config) The specific config of the product
    • -
  • without_native_fixed -- (bool) +
  • config – (Config) The global configuration
    • +
  • prod_info – (Config) The specific config of the product
    • +
  • without_native_fixed – (bool) If true, do not include the fixed or native products in the result
@@ -630,9 +607,9 @@ by prod_info

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • prod_info -- (Config) The specific config of the product
    • -
  • without_native_fixed -- (bool) +
  • config – (Config) The global configuration
    • +
  • prod_info – (Config) The specific config of the product
    • +
  • without_native_fixed – (bool) If true, do not include the fixed or native products in the result
@@ -644,16 +621,6 @@ If true, do not include the fixed or native products in the result -
-
-commands.compile.log_res_step(logger, res)[source]¶
-
- -
-
-commands.compile.log_step(logger, header, step)[source]¶
-
-
commands.compile.sort_products(config, p_infos)[source]¶
@@ -663,8 +630,8 @@ If true, do not include the fixed or native products in the result Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • p_infos -- (list) +
  • config – (Config) The global configuration
    • +
  • p_infos – (list) List of (str, Config) => (product_name, product_info)
@@ -679,22 +646,22 @@ List of (str, Config) => (product_name, product_info)
class commands.config.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

-

The config command allows manipulation and operation on config '.pyconf' files.

+

Bases: src.salomeTools._BaseCommand

+

The config command allows manipulation and operation on config ‘.pyconf’ files.

examples:
-
>> sat config --list
-
>> sat config SALOME --edit
-
>> sat config SALOME --copy SALOME-new
-
>> sat config SALOME --value VARS
-
>> sat config SALOME --debug VARS
-
>> sat config SALOME --info ParaView
-
>> sat config SALOME --show_patchs
+
>> sat config –list
+
>> sat config SALOME –edit
+
>> sat config SALOME –copy SALOME-new
+
>> sat config SALOME –value VARS
+
>> sat config SALOME –debug VARS
+
>> sat config SALOME –info ParaView
+
>> sat config SALOME –show_patchs
getParser()[source]¶
-

Define all options for command 'sat config <options>'

+

Define all options for command ‘sat config <options>’

@@ -705,7 +672,7 @@ List of (str, Config) => (product_name, product_info)
run(cmd_arguments)[source]¶
-

method called for command 'sat config <options>'

+

method called for command ‘sat config <options>’

@@ -716,10 +683,10 @@ List of (str, Config) => (product_name, product_info)
class commands.configure.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The configure command executes in the build directory commands corresponding to the compilation mode of the application products. -The possible compilation modes are 'cmake', 'autotools', or 'script'.

+The possible compilation modes are ‘cmake’, ‘autotools’, or ‘script’.

Here are the commands to be run:
@@ -729,12 +696,12 @@ The possible compilation modes are 'cmake', 'autotools', or 'script'.


examples:
-
>> sat configure SALOME --products KERNEL,GUI,PARAVIS
+
>> sat configure SALOME –products KERNEL,GUI,PARAVIS
getParser()[source]¶
-

Define all options for command 'sat configure <options>'

+

Define all options for command ‘sat configure <options>’

@@ -745,7 +712,7 @@ The possible compilation modes are 'cmake', 'autotools', or 'script'.

run(cmd_arguments)[source]¶
-

method called for command 'sat configure <options>'

+

method called for command ‘sat configure <options>’

@@ -760,11 +727,11 @@ in each product build directory.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products_info -- (list) +
  • config – (Config) The global configuration
    • +
  • products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • conf_option -- (str) The options to add to the command
    • -
  • logger -- (Logger) The logger instance to use for the display and logging
    • +
  • conf_option – (str) The options to add to the command
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -785,11 +752,11 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • -
  • conf_option -- (str) The options to add to the command
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • conf_option – (str) The options to add to the command
    • +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -811,10 +778,10 @@ configuration regarding the passed options.

Parameters:
    -
  • options -- (Options) +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • cfg -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • cfg – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -826,23 +793,13 @@ The logger instance to use for the display and logging
-
-
-commands.configure.log_res_step(logger, res)[source]¶
-
- -
-
-commands.configure.log_step(logger, header, step)[source]¶
-
-

commands.environ module¶

class commands.environ.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The environ command generates the environment files of your application.

examples:
@@ -851,7 +808,7 @@ The logger instance to use for the display and logging
getParser()[source]¶
-

Define all options for command 'sat environ <options>'

+

Define all options for command ‘sat environ <options>’

@@ -862,7 +819,7 @@ The logger instance to use for the display and logging
run(cmd_arguments)[source]¶
-

method called for command 'sat environ <options>'

+

method called for command ‘sat environ <options>’

@@ -876,18 +833,18 @@ The logger instance to use for the display and logging Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • out_dir -- (str) +
  • out_dir – (str) The path to the directory where the files will be put
    • -
  • src_root -- (str) +
  • src_root – (str) The path to the directory where the sources are
    • -
  • silent -- (bool) +
  • silent – (bool) If True, do not print anything in the terminal
    • -
  • shells -- (list) The list of shells to generate
    • -
  • prefix -- (str) The prefix to add to the file names.
    • -
  • env_info -- (str) The list of products to add in the files.
    • +
  • shells – (list) The list of shells to generate
    • +
  • prefix – (str) The prefix to add to the file names.
    • +
  • env_info – (str) The list of products to add in the files.
@@ -904,18 +861,18 @@ If True, do not print anything in the terminal
class commands.find_duplicates.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The find_duplicates command search recursively for all duplicates files in INSTALL directory (or the optionally given directory) and prints the found files to the terminal.

examples:
-
>> sat find_duplicates --path /tmp
+
>> sat find_duplicates –path /tmp
getParser()[source]¶
-

Define all options for command 'sat find_duplicates <options>'

+

Define all options for command ‘sat find_duplicates <options>’

@@ -926,7 +883,7 @@ prints the found files to the terminal.

run(cmd_arguments)[source]¶
-

method called for command 'sat find_duplicates <options>'

+

method called for command ‘sat find_duplicates <options>’

@@ -943,7 +900,7 @@ prints the found files to the terminal.

-Parameters:val -- (float) val must be between valMin and valMax. +Parameters:val – (float) val must be between valMin and valMax. @@ -959,7 +916,7 @@ prints the found files to the terminal.

-Parameters:l_str -- (list or str) The variable to format +Parameters:l_str – (list or str) The variable to format Returns:(list) the formatted variable @@ -976,11 +933,11 @@ prints the found files to the terminal.

Parameters:
    -
  • lpath -- (list) +
  • lpath – (list) The list of path to of the directories where to search for duplicates
    • -
  • extension_ignored -- (list) The list of extensions to ignore
    • -
  • files_ignored -- (list) The list of files to ignore
    • -
  • directories_ignored -- (list) +
  • extension_ignored – (list) The list of extensions to ignore
    • +
  • files_ignored – (list) The list of files to ignore
    • +
  • directories_ignored – (list) The list of directory paths to ignore
@@ -1000,18 +957,18 @@ and files_out is is the list of files

class commands.generate.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

-

The generate command generates SALOME modules from 'pure cpp' products.

+

Bases: src.salomeTools._BaseCommand

+

The generate command generates SALOME modules from ‘pure cpp’ products.

warning: this command NEEDS YACSGEN to run.

examples:
-
>> sat generate SALOME --products FLICACPP
+
>> sat generate SALOME –products FLICACPP
getParser()[source]¶
-

Define all options for command 'sat generate <options>'

+

Define all options for command ‘sat generate <options>’

@@ -1022,7 +979,7 @@ and files_out is is the list of files

run(cmd_arguments)[source]¶
-

method called for command 'sat generate <options>'

+

method called for command ‘sat generate <options>’

@@ -1040,7 +997,7 @@ and files_out is is the list of files

-Parameters:directory -- (str) The directory of YACSGEN. +Parameters:directory – (str) The directory of YACSGEN. Returns:(str) The YACSGEN path if the module_generator is available, else None @@ -1058,9 +1015,9 @@ The YACSGEN path if the module_generator is available, else None Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • directory -- (str) The directory given by option --yacsgen
    • -
  • logger -- (Logger) The logger instance
    • +
  • config – (Config) The global configuration.
    • +
  • directory – (str) The directory given by option –yacsgen
    • +
  • logger – (Logger) The logger instance
@@ -1088,12 +1045,12 @@ with value The path to yacsgen directory if ok

class commands.init.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The init command Changes the local settings of SAT

getParser()[source]¶
-

Define all options for command 'sat init <options>'

+

Define all options for command ‘sat init <options>’

@@ -1104,7 +1061,7 @@ with value The path to yacsgen directory if ok

run(cmd_arguments)[source]¶
-

method called for command 'sat init <options>'

+

method called for command ‘sat init <options>’

@@ -1118,8 +1075,8 @@ with value The path to yacsgen directory if ok

Parameters:
    -
  • path_to_check -- (str) The path to check.
    • -
  • logger -- (Logger) The logger instance.
    • +
  • path_to_check – (str) The path to check.
    • +
  • logger – (Logger) The logger instance.
@@ -1136,9 +1093,9 @@ with value The path to yacsgen directory if ok

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • key -- (str) The key from which to change the value.
    • -
  • logger -- (Logger) The logger instance.
    • +
  • config – (Config) The global configuration.
    • +
  • key – (str) The key from which to change the value.
    • +
  • logger – (Logger) The logger instance.
@@ -1155,10 +1112,10 @@ with value The path to yacsgen directory if ok

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • key -- (str) The key from which to change the value.
    • -
  • value -- (str) The path to change.
    • -
  • logger -- (Logger) The logger instance.
    • +
  • config – (Config) The global configuration.
    • +
  • key – (str) The key from which to change the value.
    • +
  • value – (str) The path to change.
    • +
  • logger – (Logger) The logger instance.
@@ -1175,15 +1132,15 @@ with value The path to yacsgen directory if ok

class commands.job.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The job command executes the commands of the job defined in the jobs configuration file | examples: -| >> sat job --jobs_config my_jobs --name my_job"

+| >> sat job –jobs_config my_jobs –name my_job”

getParser()[source]¶
-

Define all options for command 'sat job <options>'

+

Define all options for command ‘sat job <options>’

@@ -1194,7 +1151,7 @@ in the jobs configuration file
run(cmd_arguments)[source]¶
-

method called for command 'sat job <options>'

+

method called for command ‘sat job <options>’

@@ -1205,17 +1162,17 @@ in the jobs configuration file
class commands.jobs.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The jobs command command launches maintenances that are described in the dedicated jobs configuration file.

examples:
-
>> sat jobs --name my_jobs --publish
+
>> sat jobs –name my_jobs –publish
getParser()[source]¶
-

Define all options for command 'sat jobs <options>'

+

Define all options for command ‘sat jobs <options>’

@@ -1226,7 +1183,7 @@ the dedicated jobs configuration file.

run(cmd_arguments)[source]¶
-

method called for command 'sat jobs <options>'

+

method called for command ‘sat jobs <options>’

@@ -1234,7 +1191,7 @@ the dedicated jobs configuration file.

class commands.jobs.Gui(xml_dir_path, l_jobs, l_jobs_not_today, prefix, logger, file_boards='')[source]¶
-

Bases: object

+

Bases: object

Class to manage the the xml data that can be displayed in a browser to see the jobs states

@@ -1245,7 +1202,7 @@ to see the jobs states

-Parameters:name -- (str) the board name +Parameters:name – (str) the board name @@ -1262,9 +1219,9 @@ self.history = {name_job : list of (date, status, list links)}

Parameters:
    -
  • l_jobs -- (list) +
  • l_jobs – (list) the list of jobs to run today
    • -
  • l_jobs_not_today -- (list) +
  • l_jobs_not_today – (list) the list of jobs that do not run today
@@ -1283,7 +1240,7 @@ so the result is a list.

-Parameters:l_remote_log_files -- (list) the list of all remote log files +Parameters:l_remote_log_files – (list) the list of all remote log files Returns:(list) the list of tuples (test log files path, res of the command) @@ -1302,8 +1259,8 @@ first version of the files

Parameters:
    -
  • l_jobs -- (list) the list of jobs that run today
    • -
  • l_jobs_not_today -- (list) the list of jobs that do not run today
    • +
  • l_jobs – (list) the list of jobs that run today
    • +
  • l_jobs_not_today – (list) the list of jobs that do not run today
@@ -1320,8 +1277,8 @@ first version of the files

Parameters:
    -
  • l_jobs -- (list) the list of jobs that run today
    • -
  • xml_file -- (xmlManager.XmlLogFile) the xml instance to update
    • +
  • l_jobs – (list) the list of jobs that run today
    • +
  • xml_file – (xmlManager.XmlLogFile) the xml instance to update
@@ -1338,7 +1295,7 @@ the dict d_input_boards that contain the csv file contain

-Parameters:today -- (int) the current day of the week +Parameters:today – (int) the current day of the week @@ -1354,9 +1311,9 @@ first version of the files

Parameters:
    -
  • xml_node_jobs -- (etree.Element) +
  • xml_node_jobs – (etree.Element) the node corresponding to a job
    • -
  • l_jobs_not_today -- (list) +
  • l_jobs_not_today – (list) the list of jobs that do not run today
@@ -1374,8 +1331,8 @@ the list of jobs that do not run today Parameters:
    -
  • l_jobs -- (list) the list of jobs that run today
    • -
  • xml_file -- (xmlManager.XmlLogFile) +
  • l_jobs – (list) the list of jobs that run today
    • +
  • xml_file – (xmlManager.XmlLogFile) the xml instance to update
@@ -1392,7 +1349,7 @@ the xml instance to update -Parameters:l_jobs -- (list) the list of jobs that run today +Parameters:l_jobs – (list) the list of jobs that run today @@ -1415,7 +1372,7 @@ the xml instance to update
class commands.jobs.Job(name, machine, application, board, commands, timeout, config, job_file_path, logger, after=None, prefix=None)[source]¶
-

Bases: object

+

Bases: object

Class to manage one job

@@ -1596,7 +1553,7 @@ If it is finished, the outputs are stored in the fields out and err.

write_results()[source]¶
-

Display on the terminal all the job's information

+

Display on the terminal all the job’s information

@@ -1604,7 +1561,7 @@ If it is finished, the outputs are stored in the fields out and err.

class commands.jobs.Jobs(runner, logger, job_file_path, config_jobs, lenght_columns=20)[source]¶
-

Bases: object

+

Bases: object

Class to manage the jobs to be run

@@ -1630,8 +1587,8 @@ and returns the job instance corresponding to the definition.

Parameters:
    -
  • job_def -- (Mapping a job definition
    • -
  • machine -- (Machine) the machine on which the job will run
    • +
  • job_def – (Mapping a job definition
    • +
  • machine – (Machine) the machine on which the job will run
@@ -1667,7 +1624,7 @@ It displays the job that is currently running on the host of the column.

-Parameters:len_col -- (int) the size of the column +Parameters:len_col – (int) the size of the column Returns:None @@ -1683,7 +1640,7 @@ It displays the job that is currently running on the host of the column.

-Parameters:name -- (str) a job name +Parameters:name – (str) a job name Returns:(Job) the job that has the name. @@ -1700,7 +1657,7 @@ the machine defined by its host and its port.

-Parameters:hostname -- (str, int) the pair (host, port) +Parameters:hostname – (str, int) the pair (host, port) Returns:(Job or bool) the job that is running on the host, @@ -1746,18 +1703,18 @@ This method stops when all the jobs are finished.

str_of_length(text, length)[source]¶

Takes a string text of any length and returns -the most close string of length "length".

+the most close string of length “length”.

- @@ -1798,7 +1755,7 @@ running jobs and the jobs that have already finished.

class commands.jobs.Machine(name, host, user, port=22, passwd=None, sat_path='salomeTools')[source]¶
-

Bases: object

+

Bases: object

Manage a ssh connection on a machine

@@ -1814,7 +1771,7 @@ running jobs and the jobs that have already finished.

- + @@ -1837,8 +1794,8 @@ running jobs and the jobs that have already finished.

@@ -1873,7 +1830,7 @@ All sub-directories in source are created under target.

- + @@ -1890,7 +1847,7 @@ All sub-directories in source are created under target.

- + @@ -1908,7 +1865,7 @@ All sub-directories in source are created under target.

- @@ -1931,7 +1888,7 @@ the config corresponding to the jos description
class commands.launcher.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The launcher command generates a SALOME launcher.

examples:
@@ -1940,7 +1897,7 @@ the config corresponding to the jos description
getParser()[source]¶
-

Define all possible options for command 'sat launcher <options>'

+

Define all possible options for command ‘sat launcher <options>’

@@ -1951,7 +1908,7 @@ the config corresponding to the jos description
run(cmd_arguments)[source]¶
-

method called for command 'sat launcher <options>'

+

method called for command ‘sat launcher <options>’

@@ -1965,8 +1922,8 @@ the config corresponding to the jos description @@ -1987,9 +1944,9 @@ The environment dictionary corresponding to the file path.

@@ -2010,13 +1967,13 @@ The logger instance to use for the display and logging @@ -2034,7 +1991,7 @@ The dict giving additional environment variables
class commands.log.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The log command gives access to the logs produced by the salomeTools commands.

examples:
@@ -2043,7 +2000,7 @@ The dict giving additional environment variables
getParser()[source]¶
-

Define all options for command 'sat log <options>'

+

Define all options for command ‘sat log <options>’

@@ -2054,7 +2011,7 @@ The dict giving additional environment variables
run(cmd_arguments)[source]¶
-

method called for command 'sat log <options>'

+

method called for command ‘sat log <options>’

@@ -2067,7 +2024,7 @@ The dict giving additional environment variables - + @@ -2079,7 +2036,7 @@ the value entered by the user. Return -1 if it is not as expected
commands.log.getMaxFormat(aListOfStr, offset=1)[source]¶
-

returns format for columns width as '%-30s"' for example

+

returns format for columns width as ‘%-30s”’ for example

@@ -2092,8 +2049,8 @@ Get the last log command file path.

@@ -2113,8 +2070,8 @@ Get the last log command file path.

@@ -2131,8 +2088,8 @@ Get the last log command file path.

@@ -2158,16 +2115,16 @@ Get the last log command file path.

class commands.make.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

-

The make command executes the 'make' command in the build directory.

+

Bases: src.salomeTools._BaseCommand

+

The make command executes the ‘make’ command in the build directory.

examples:
-
>> sat make SALOME --products Python,KERNEL,GUI
+
>> sat make SALOME –products Python,KERNEL,GUI
getParser()[source]¶
-

Define all options for the command 'sat make <options>'

+

Define all options for the command ‘sat make <options>’

@@ -2178,7 +2135,7 @@ Get the last log command file path.

run(cmd_arguments)[source]¶
-

method called for command 'sat make <options>'

+

method called for command ‘sat make <options>’

@@ -2198,10 +2155,10 @@ configuration regarding the passed options.

@@ -2213,16 +2170,6 @@ The logger instance to use for the display and logging
Parameters:
    -
  • text -- (str) any string
    • -
  • length -- (int) a length for the returned string
    • +
  • text – (str) any string
    • +
  • length – (int) a length for the returned string
Returns:

(str) the most close string of length "length"

+
Returns:

(str) the most close string of length “length”
Parameters:logger -- The logger instance
Parameters:logger – The logger instance
Returns:None
Parameters:
    -
  • command -- (str) The command to be run
    • -
  • logger -- The logger instance
    • +
  • command – (str) The command to be run
    • +
  • logger – The logger instance
Parameters:logger -- The logger instance
Parameters:logger – The logger instance
Returns:(bool) True if the connection has succeed, False if not
Parameters:logger -- The logger instance
Parameters:logger – The logger instance
Returns:None
Parameters:config_jobs -- (Config) +
Parameters:config_jobs – (Config) the config corresponding to the jos description
Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • catalog_path -- (str) the catalog file path
    • +
  • config – (Config) The global configuration
    • +
  • catalog_path – (str) the catalog file path
Parameters:
    -
  • machines -- (list) The list of machines to add in the catalog
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • machines – (list) The list of machines to add in the catalog
    • +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • launcher_name -- (str) The name of the launcher to generate
    • -
  • pathlauncher -- (str) The path to the launcher to generate
    • -
  • display -- (bool) If False, do not print anything in the terminal
    • -
  • additional_env -- (dict) +
  • launcher_name – (str) The name of the launcher to generate
    • +
  • pathlauncher – (str) The path to the launcher to generate
    • +
  • display – (bool) If False, do not print anything in the terminal
    • +
  • additional_env – (dict) The dict giving additional environment variables
Parameters:nb -- (int) The maximum value of the value to be returned by the user.
Parameters:nb – (int) The maximum value of the value to be returned by the user.
Returns:(int) the value entered by the user. Return -1 if it is not as expected
Parameters:
    -
  • logDir -- (str) The directory where to search the log files
    • -
  • notShownCommands -- (list) the list of commands to ignore
    • +
  • logDir – (str) The directory where to search the log files
    • +
  • notShownCommands – (list) the list of commands to ignore
Parameters:
    -
  • filePath -- The command xml file from which extract the commands context and traces
    • -
  • logger -- (Logger) the logging instance to use in order to print.
    • +
  • filePath – The command xml file from which extract the commands context and traces
    • +
  • logger – (Logger) the logging instance to use in order to print.
Parameters:
    -
  • filePath -- the path of the file to delete
    • -
  • logger -- (Logger) the logger instance to use for the print
    • +
  • filePath – the path of the file to delete
    • +
  • logger – (Logger) the logger instance to use for the print
Parameters:
    -
  • options -- (Options) +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • cfg -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • cfg – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
-
-
-commands.make.log_res_step(logger, res)[source]¶
-
- -
-
-commands.make.log_step(logger, header, step)[source]¶
-
-
commands.make.make_all_products(config, products_infos, make_option, logger)[source]¶
@@ -2233,11 +2180,11 @@ in each product build directory.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products_info -- (list) +
  • config – (Config) The global configuration
    • +
  • products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • make_option -- (str) The options to add to the command
    • -
  • logger -- (Logger) +
  • make_option – (str) The options to add to the command
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -2259,10 +2206,10 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) (str, Config) => (product_name, product_info)
    • -
  • make_option -- (str) The options to add to the command
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • +
  • make_option – (str) The options to add to the command
    • +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -2280,18 +2227,18 @@ The logger instance to use for the display and logging
class commands.makeinstall.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

-

The makeinstall command executes the 'make install' command in the build directory. -In case of product constructed using a script (build_source : 'script'), +

Bases: src.salomeTools._BaseCommand

+

The makeinstall command executes the ‘make install’ command in the build directory. +In case of product constructed using a script (build_source : ‘script’), then the makeinstall command do nothing.

examples:
-
>> sat makeinstall SALOME --products KERNEL,GUI
+
>> sat makeinstall SALOME –products KERNEL,GUI
getParser()[source]¶
-

Define all options for the command 'sat makeinstall <options>'

+

Define all options for the command ‘sat makeinstall <options>’

@@ -2302,7 +2249,7 @@ then the makeinstall command do nothing.

run(cmd_arguments)[source]¶
-

method called for command 'sat makeinstall <options>'

+

method called for command ‘sat makeinstall <options>’

@@ -2317,10 +2264,10 @@ configuration regarding the passed options.

Parameters:
    -
  • options -- (Options) +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • cfg -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • cfg – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -2332,16 +2279,6 @@ The logger instance to use for the display and logging
-
-
-commands.makeinstall.log_res_step(logger, res)[source]¶
-
- -
-
-commands.makeinstall.log_step(logger, header, step)[source]¶
-
-
commands.makeinstall.makeinstall_all_products(config, products_infos, logger)[source]¶
@@ -2352,10 +2289,10 @@ in each product build directory.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products_info -- (list) +
  • config – (Config) The global configuration
    • +
  • products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -2377,10 +2314,10 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -2398,7 +2335,7 @@ The logger instance to use for the display and logging
class commands.package.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The package command creates an archive.

There are 4 kinds of archive, which can be mixed:
@@ -2408,12 +2345,12 @@ The logger instance to use for the display and logging
4- The salomeTools archive. It contains salomeTools.

examples:
-
>> sat package SALOME --binaries --sources
+
>> sat package SALOME –binaries –sources
getParser()[source]¶
-

Define all options for command 'sat package <options>'

+

Define all options for command ‘sat package <options>’

@@ -2424,7 +2361,7 @@ The logger instance to use for the display and logging
run(cmd_arguments)[source]¶
-

method called for command 'sat package <options>'

+

method called for command ‘sat package <options>’

@@ -2439,13 +2376,13 @@ in the d_content argument.

Parameters:
    -
  • tar -- (tarfile) The tarfile instance used to make the archive.
    • -
  • name_archive -- (str) The name of the archive to make.
    • -
  • d_content -- (dict) +
  • tar – (tarfile) The tarfile instance used to make the archive.
    • +
  • name_archive – (str) The name of the archive to make.
    • +
  • d_content – (dict) The dictionary that contain all directories and files to add in the archive. d_content[label] = (path_on_local_machine, path_in_archive)
    • -
  • logger -- (Logger) the logging instance
    • -
  • f_exclude -- (function) the function that filters
    • +
  • logger – (Logger) the logging instance
    • +
  • f_exclude – (function) the function that filters
@@ -2471,8 +2408,8 @@ configured for a source package.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • tmp_working_dir -- (str) +
  • config – (Config) The global configuration.
    • +
  • tmp_working_dir – (str) The temporary local directory containing some specific directories or files needed in the source package
@@ -2496,10 +2433,10 @@ to add in a binary package.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) the logging instance
    • -
  • options -- (OptResult) the options of the launched command
    • -
  • tmp_working_dir -- (str) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) the logging instance
    • +
  • options – (OptResult) the options of the launched command
    • +
  • tmp_working_dir – (str) The temporary local directory containing some specific directories or files needed in the binary package
@@ -2524,11 +2461,11 @@ to add in a binary package. Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • tmp_working_dir -- (str) +
  • config – (Config) The global configuration.
    • +
  • tmp_working_dir – (str) The temporary local directory containing some specific directories or files needed in the source package
    • -
  • with_vcs -- (bool) +
  • with_vcs – (bool) True if the package is with vcs products (not transformed into archive products)
@@ -2536,7 +2473,7 @@ True if the package is with vcs products Returns:

(dict) The dictionary -{"project" : (produced project, project path in the archive)}

+{“project” : (produced project, project path in the archive)}

@@ -2552,7 +2489,7 @@ VCS repositories (like .git)

-Parameters:filename -- (str) The filname to exclude (or not). +Parameters:filename – (str) The filname to exclude (or not). Returns:(bool) True if the file has to be exclude @@ -2570,8 +2507,8 @@ directory containing the specific project of a source package.

Parameters:
    -
  • config -- 'Config) The global configuration.
    • -
  • application_tmp_dir -- (str) +
  • config – ‘Config) The global configuration.
    • +
  • application_tmp_dir – (str) The path to the temporary application scripts directory of the project.
@@ -2593,19 +2530,19 @@ construct the specific project.

Parameters:
    -
  • p_name -- (str) The name of the product.
    • -
  • p_info -- (Config) The specific configuration corresponding to the product
    • -
  • config -- (Config) The global configuration.
    • -
  • with_vcs -- (bool) +
  • p_name – (str) The name of the product.
    • +
  • p_info – (Config) The specific configuration corresponding to the product
    • +
  • config – (Config) The global configuration.
    • +
  • with_vcs – (bool) True if the package is with vcs products (not transformed into archive products)
    • -
  • compil_scripts_tmp_dir -- (str) +
  • compil_scripts_tmp_dir – (str) The path to the temporary compilation scripts directory of the project.
    • -
  • env_scripts_tmp_dir -- (str) +
  • env_scripts_tmp_dir – (str) The path to the temporary environment script directory of the project.
    • -
  • patches_tmp_dir -- (str) +
  • patches_tmp_dir – (str) The path to the temporary patch scripts directory of the project.
    • -
  • products_pyconf_tmp_dir -- (str) +
  • products_pyconf_tmp_dir – (str) The path to the temporary product scripts directory of the project.
@@ -2624,8 +2561,8 @@ from a VCS (git, cvs, svn) repository.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) The logging instance
    • +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) The logging instance
@@ -2651,13 +2588,13 @@ and then create the archives.

Parameters:
    -
  • l_pinfo_vcs -- (list) +
  • l_pinfo_vcs – (list) The list of specific configuration corresponding to each vcs product
    • -
  • sat -- (Sat) +
  • sat – (Sat) The Sat instance that can be called to clean and source the products
    • -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) The logging instance
    • -
  • tmp_working_dir -- (str) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) The logging instance
    • +
  • tmp_working_dir – (str) The temporary local directory containing some specific directories or files needed in the source package
@@ -2680,7 +2617,7 @@ The dictionary that stores all the archives to add in the sourcepackage. -Parameters:filepath -- (str) The path to the launcher to modify. +Parameters:filepath – (str) The path to the launcher to modify. @@ -2695,10 +2632,10 @@ The dictionary that stores all the archives to add in the sourcepackage. Parameters:
    -
  • prod_name -- (str) The name of the product.
    • -
  • prod_info -- (Config) +
  • prod_name – (str) The name of the product.
    • +
  • prod_info – (Config) The specific configuration corresponding to the product
    • -
  • where -- (str) +
  • where – (str) The path of the repository where to put the resulting archive
@@ -2720,12 +2657,12 @@ in order to use it for extra compilations.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) the logging instance
    • -
  • file_dir -- (str) the directory where to put the files
    • -
  • d_sub -- (dict) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) the logging instance
    • +
  • file_dir – (str) the directory where to put the files
    • +
  • d_sub – (dict) the dictionnary that contains the substitutions to be done
    • -
  • file_name -- (str) the name of the install script file
    • +
  • file_name – (str) the name of the install script file
@@ -2746,10 +2683,10 @@ These files use relative paths.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) the logging instance
    • -
  • file_dir -- (str) the directory where to put the files
    • -
  • binaries_dir_name -- (str) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) the logging instance
    • +
  • file_dir – (str) the directory where to put the files
    • +
  • binaries_dir_name – (str) The name of the repository where the binaries are, in the archive.
@@ -2771,11 +2708,11 @@ This launcher uses relative paths.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) the logging instance
    • -
  • file_dir -- (str) the directory where to put the launcher
    • -
  • file_name -- (str) The launcher name
    • -
  • binaries_dir_name -- (str) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) the logging instance
    • +
  • file_dir – (str) the directory where to put the launcher
    • +
  • file_name – (str) The launcher name
    • +
  • binaries_dir_name – (str) the name of the repository where the binaries are, in the archive.
@@ -2797,10 +2734,10 @@ in the binary package.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) the logging instance
    • -
  • file_dir -- (str) the directory where to put the file
    • -
  • binaries_dir_name -- (str) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) the logging instance
    • +
  • file_dir – (str) the directory where to put the file
    • +
  • binaries_dir_name – (str) The name of the repository where the binaries are, in the archive.
@@ -2822,8 +2759,8 @@ to add in a project package.

Parameters:
    -
  • project_file_path -- (str) The path to the local project.
    • -
  • tmp_working_dir -- (str) +
  • project_file_path – (str) The path to the local project.
    • +
  • tmp_working_dir – (str) The temporary local directory containing some specific directories or files needed in the project package
@@ -2849,10 +2786,10 @@ to add in a source package.

Parameters:
    -
  • config -- (Config) The global configuration.
    • -
  • logger -- (Logger) the logging instance
    • -
  • options -- (OptResult) the options of the launched command
    • -
  • tmp_working_dir -- (str) +
  • config – (Config) The global configuration.
    • +
  • logger – (Logger) the logging instance
    • +
  • options – (OptResult) the options of the launched command
    • +
  • tmp_working_dir – (str) The temporary local directory containing some specific directories or files needed in the binary package
@@ -2878,9 +2815,9 @@ that have the property given as input.

Parameters:
    -
  • config -- (Config) The global config.
    • -
  • prop -- (str) The property to filter
    • -
  • value -- (str) The value of the property to filter
    • +
  • config – (Config) The global config.
    • +
  • prop – (str) The property to filter
    • +
  • value – (str) The value of the property to filter
@@ -2894,17 +2831,17 @@ that have the property given as input.

class commands.patch.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The patch command apply the patches on the sources of the application products if there is any.

examples:
-
>> sat patch SALOME --products qt,boost
+
>> sat patch SALOME –products qt,boost
getParser()[source]¶
-

Define all options for command 'sat patch <options>'

+

Define all options for command ‘sat patch <options>’

@@ -2915,7 +2852,7 @@ if there is any.

run(cmd_arguments)[source]¶
-

method called for command 'sat patch <options>'

+

method called for command ‘sat patch <options>’

@@ -2929,10 +2866,10 @@ if there is any.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_info -- (Config) +
  • config – (Config) The global configuration
    • +
  • product_info – (Config) The configuration specific to the product to be patched
    • -
  • logger -- (Logger: +
  • logger – (Logger: The logger instance to use for the display and logging
@@ -2950,17 +2887,17 @@ The logger instance to use for the display and logging
class commands.prepare.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The prepare command gets the sources of the application products and apply the patches if there is any.

examples:
-
>> sat prepare SALOME --products KERNEL,GUI
+
>> sat prepare SALOME –products KERNEL,GUI
getParser()[source]¶
-

Define all options for command 'sat prepare <options>'

+

Define all options for command ‘sat prepare <options>’

@@ -2971,7 +2908,7 @@ and apply the patches if there is any.

run(cmd_arguments)[source]¶
-

method called for command 'sat prepare <options>'

+

method called for command ‘sat prepare <options>’

@@ -2984,7 +2921,7 @@ and apply the patches if there is any.

-Parameters:l_products -- (list) The list of products to check +Parameters:l_products – (list) The list of products to check Returns:(list) The list of product configurations @@ -3002,7 +2939,7 @@ that have an existing source directory. -Parameters:l_products -- (list) The list of products to check +Parameters:l_products – (list) The list of products to check Returns:(list) The list of product configurations @@ -3021,10 +2958,10 @@ that have one or more patches. Parameters:
    -
  • arguments -- (str) The arguments from which to remove products
    • -
  • l_products_info -- (list) +
  • arguments – (str) The arguments from which to remove products
    • +
  • l_products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -3042,21 +2979,21 @@ The logger instance to use for the display and logging
class commands.profile.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The profile command creates default profile.

examples:
>> sat profile [PRODUCT]
-
>> sat profile --prefix (string)
-
>> sat profile --name (string)
-
>> sat profile --force
-
>> sat profile --version (string)
-
>> sat profile --slogan (string)
+
>> sat profile –prefix (string)
+
>> sat profile –name (string)
+
>> sat profile –force
+
>> sat profile –version (string)
+
>> sat profile –slogan (string)
getParser()[source]¶
-

Define all options for command 'sat profile <options>'

+

Define all options for command ‘sat profile <options>’

@@ -3067,7 +3004,7 @@ The logger instance to use for the display and logging
run(cmd_arguments)[source]¶
-

method called for command 'sat profile <options>'

+

method called for command ‘sat profile <options>’

@@ -3086,18 +3023,26 @@ The logger instance to use for the display and logging
class commands.profile.profileConfigReader(config)[source]¶
-

Bases: src.pyconf.ConfigReader

+

Bases: src.pyconf.ConfigReader

parseMapping(parent, suffix)[source]¶
-
+

Parse a mapping.

+

@param parent: The container to which the mapping will be added. +@type parent: A L{Container} instance. +@param suffix: The suffix for the value. +@type suffix: str +@return: a L{Mapping} instance representing the mapping. +@rtype: L{Mapping} +@raise ConfigFormatError: if a syntax error is found.

+
class commands.profile.profileReference(config, type, ident)[source]¶
-

Bases: src.pyconf.Reference

+

Bases: src.pyconf.Reference

@@ -3112,7 +3057,7 @@ The logger instance to use for the display and logging
class commands.run.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The run command runs the application launcher with the given arguments.

examples:
@@ -3121,7 +3066,7 @@ The logger instance to use for the display and logging
getParser()[source]¶
-

Define all options for command 'sat run <options>'

+

Define all options for command ‘sat run <options>’

@@ -3132,7 +3077,7 @@ The logger instance to use for the display and logging
run(cmd_arguments)[source]¶
-

method called for command 'sat run <options>'

+

method called for command ‘sat run <options>’

@@ -3143,20 +3088,20 @@ The logger instance to use for the display and logging
class commands.script.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The script command executes the script(s) of the the given products in the build directory. -This is done only for the products that are constructed using a script (build_source : 'script'). +This is done only for the products that are constructed using a script (build_source : ‘script’). Otherwise, nothing is done.

examples:
-
>> sat script SALOME --products Python,numpy
+
>> sat script SALOME –products Python,numpy
getParser()[source]¶
-

Define all options for the command 'sat script <options>'

+

Define all options for the command ‘sat script <options>’

@@ -3167,7 +3112,7 @@ Otherwise, nothing is done.

run(cmd_arguments)[source]¶
-

method called for command 'sat script <options>'

+

method called for command ‘sat script <options>’

@@ -3182,10 +3127,10 @@ configuration regarding the passed options.

Parameters:
    -
  • options -- (Options) +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • cfg -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • cfg – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -3197,16 +3142,6 @@ The logger instance to use for the display and logging
-
-
-commands.script.log_res_step(logger, res)[source]¶
-
- -
-
-commands.script.log_step(logger, header, step)[source]¶
-
-
commands.script.run_script_all_products(config, products_infos, nb_proc, logger)[source]¶
@@ -3216,11 +3151,11 @@ The logger instance to use for the display and logging Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products_info -- (list) +
  • config – (Config) The global configuration
    • +
  • products_info – (list) List of (str, Config) => (product_name, product_info)
    • -
  • nb_proc -- (int) The number of processors to use
    • -
  • logger -- (Logger) +
  • nb_proc – (int) The number of processors to use
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -3242,11 +3177,11 @@ in the product build directory.

Parameters:
    -
  • p_name_info -- (tuple) +
  • p_name_info – (tuple) (str, Config) => (product_name, product_info)
    • -
  • nb_proc -- (int) The number of processors to use
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • nb_proc – (int) The number of processors to use
    • +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -3264,16 +3199,16 @@ The logger instance to use for the display and logging
class commands.shell.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The shell command executes the shell command passed as argument.

examples:
-
>> sat shell --command 'ls -lt /tmp'
+
>> sat shell –command ‘ls -lt /tmp’
getParser()[source]¶
-

Define all options for the command 'sat shell <options>'

+

Define all options for the command ‘sat shell <options>’

@@ -3284,7 +3219,7 @@ The logger instance to use for the display and logging
run(cmd_arguments)[source]¶
-

method called for command 'sat shell <options>'

+

method called for command ‘sat shell <options>’

@@ -3295,17 +3230,17 @@ The logger instance to use for the display and logging
class commands.source.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The source command gets the sources of the application products from cvs, git or an archive.

examples:
-
>> sat source SALOME --products KERNEL,GUI
+
>> sat source SALOME –products KERNEL,GUI
getParser()[source]¶
-

Define all options for command 'sat source <options>'

+

Define all options for command ‘sat source <options>’

@@ -3316,7 +3251,7 @@ from cvs, git or an archive.

run(cmd_arguments)[source]¶
-

method called for command 'sat source <options>'

+

method called for command ‘sat source <options>’

@@ -3331,9 +3266,9 @@ using the files to be tested in product information

Parameters:
    -
  • product_info -- (Config) +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to be used for the logging
@@ -3355,10 +3290,10 @@ True if the files exists (or no files to test is provided).

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • products -- (list) +
  • config – (Config) The global configuration
    • +
  • products – (list) The list of tuples (product name, product informations)
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to be used for the logging
@@ -3380,17 +3315,17 @@ The tuple (number of success, dictionary product_name/success_fail)

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_info -- (Config) +
  • config – (Config) The global configuration
    • +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • is_dev -- (bool) True if the product is in development mode
    • -
  • source_dir -- (Path) +
  • is_dev – (bool) True if the product is in development mode
    • +
  • source_dir – (Path) The Path instance corresponding to the directory where to put the sources
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • pad -- (int) The gap to apply for the terminal display
    • -
  • checkout -- (bool) If True, get the source in checkout mode
    • +
  • pad – (int) The gap to apply for the terminal display
    • +
  • checkout – (bool) If True, get the source in checkout mode
@@ -3410,14 +3345,14 @@ The logger instance to use for the display and logging Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_info -- (Config) +
  • config – (Config) The global configuration
    • +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • source_dir -- (Path) +
  • source_dir – (Path) The Path instance corresponding to the directory where to put the sources
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • pad -- (int) The gap to apply for the terminal display
    • +
  • pad – (int) The gap to apply for the terminal display
@@ -3437,13 +3372,13 @@ The logger instance to use for the display and logging Parameters:
    -
  • product_info -- (Config) +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • source_dir -- (Path) +
  • source_dir – (Path) The Path instance corresponding to the directory where to put the sources
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
@@ -3464,17 +3399,17 @@ The logger instance to use for the display and logging Parameters:
    -
  • user -- (str) The user to use in for the cvs command
    • -
  • product_info -- (Config) +
  • user – (str) The user to use in for the cvs command
    • +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • source_dir -- (Path) +
  • source_dir – (Path) The Path instance corresponding to the directory where to put the sources
    • -
  • checkout -- (bool) If True, get the source in checkout mode
    • -
  • logger -- (Logger) +
  • checkout – (bool) If True, get the source in checkout mode
    • +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • pad -- (int) The gap to apply for the terminal display
    • -
  • environ -- (src.environment.Environ) +
  • pad – (int) The gap to apply for the terminal display
    • +
  • environ – (src.environment.Environ) The environment to source when extracting.
@@ -3500,16 +3435,16 @@ The environment to source when extracting. Parameters:
    -
  • product_info -- (Config) +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • source_dir -- (Path) +
  • source_dir – (Path) The Path instance corresponding to the directory where to put the sources
    • -
  • Logger (logger) -- (Logger) +
  • Logger (logger) – (Logger) The logger instance to use for the display and logging
    • -
  • pad -- (int) The gap to apply for the terminal display
    • -
  • is_dev -- (bool) True if the product is in development mode
    • -
  • environ -- (src.environment.Environ) +
  • pad – (int) The gap to apply for the terminal display
    • +
  • is_dev – (bool) True if the product is in development mode
    • +
  • environ – (src.environment.Environ) The environment to source when extracting.
@@ -3530,17 +3465,17 @@ The environment to source when extracting. Parameters:
    -
  • user -- (str) The user to use in for the svn command
    • -
  • product_info -- (Config) +
  • user – (str) The user to use in for the svn command
    • +
  • product_info – (Config) The configuration specific to the product to be prepared
    • -
  • source_dir -- (Path) +
  • source_dir – (Path) The Path instance corresponding to the directory where to put the sources
    • -
  • checkout -- (boolean) +
  • checkout – (boolean) If True, get the source in checkout mode
    • -
  • logger -- (Logger) +
  • logger – (Logger) The logger instance to use for the display and logging
    • -
  • environ -- (src.environment.Environ) +
  • environ – (src.environment.Environ) The environment to source when extracting.
@@ -3558,16 +3493,16 @@ The environment to source when extracting.
class commands.template.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The template command creates the sources for a SALOME module from a template.

examples:
-
>> sat template --name my_product_name --template PythonComponent --target /tmp
+
>> sat template –name my_product_name –template PythonComponent –target /tmp
getParser()[source]¶
-

Define all options for command 'sat template <options>'

+

Define all options for command ‘sat template <options>’

@@ -3578,7 +3513,7 @@ The environment to source when extracting.
run(cmd_arguments)[source]¶
-

method called for command 'sat template <options>'

+

method called for command ‘sat template <options>’

@@ -3650,11 +3585,11 @@ The environment to source when extracting.
class commands.test.Command(runner)[source]¶
-

Bases: src.salomeTools._BaseCommand

+

Bases: src.salomeTools._BaseCommand

The test command runs a test base on a SALOME installation.

examples:
-
>> sat test SALOME --grid GEOM --session light
+
>> sat test SALOME –grid GEOM –session light
@@ -3664,7 +3599,7 @@ The environment to source when extracting. -Parameters:options -- (Options) The options +Parameters:options – (Options) The options Returns:None @@ -3675,7 +3610,7 @@ The environment to source when extracting.
getParser()[source]¶
-

Define all options for command 'sat test <options>'

+

Define all options for command ‘sat test <options>’

@@ -3686,7 +3621,7 @@ The environment to source when extracting.
run(cmd_arguments)[source]¶
-

method called for command 'sat test <options>'

+

method called for command ‘sat test <options>’

@@ -3694,7 +3629,7 @@ The environment to source when extracting.
commands.test.ask_a_path()[source]¶
-

interactive as using 'raw_input'

+

interactive as using ‘raw_input’

@@ -3718,8 +3653,8 @@ on the machine with the current APPLICATION and the current test base.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • test_base -- (str) The test base name (or path)
    • +
  • config – (Config) The global configuration
    • +
  • test_base – (str) The test base name (or path)
@@ -3803,18 +3738,20 @@ on the machine with the current APPLICATION and the current test base.

This Page

@@ -3825,11 +3762,11 @@ on the machine with the current APPLICATION and the current test base.

©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source diff --git a/doc/build/html/apidoc_commands/modules.html b/doc/build/html/apidoc_commands/modules.html index 41b3203..6d91d9f 100644 --- a/doc/build/html/apidoc_commands/modules.html +++ b/doc/build/html/apidoc_commands/modules.html @@ -1,32 +1,21 @@ + - + - commands — salomeTools 5.0.0dev documentation - - - + - + - @@ -35,8 +24,7 @@ - - +
@@ -103,18 +91,20 @@

This Page

@@ -125,11 +115,11 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source diff --git a/doc/build/html/apidoc_src/modules.html b/doc/build/html/apidoc_src/modules.html index 6584385..167a8a1 100644 --- a/doc/build/html/apidoc_src/modules.html +++ b/doc/build/html/apidoc_src/modules.html @@ -1,32 +1,21 @@ + - + - src — salomeTools 5.0.0dev documentation - - - + - + - @@ -35,8 +24,7 @@ - - +
@@ -120,18 +108,20 @@

This Page

@@ -142,11 +132,11 @@ ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source diff --git a/doc/build/html/apidoc_src/src.colorama.html b/doc/build/html/apidoc_src/src.colorama.html index d65378f..52aa498 100644 --- a/doc/build/html/apidoc_src/src.colorama.html +++ b/doc/build/html/apidoc_src/src.colorama.html @@ -1,33 +1,21 @@ + - + - src.colorama package — salomeTools 5.0.0dev documentation - - - + - + - - @@ -36,8 +24,7 @@ - - +
@@ -57,7 +44,7 @@ See:
class src.colorama.ansi.AnsiBack[source]¶
-

Bases: src.colorama.ansi.AnsiCodes

+

Bases: src.colorama.ansi.AnsiCodes

BLACK = 40¶
@@ -148,13 +135,13 @@ See:
class src.colorama.ansi.AnsiCodes[source]¶
-

Bases: object

+

Bases: object

class src.colorama.ansi.AnsiCursor[source]¶
-

Bases: object

+

Bases: object

BACK(n=1)[source]¶
@@ -185,7 +172,7 @@ See:
class src.colorama.ansi.AnsiFore[source]¶
-

Bases: src.colorama.ansi.AnsiCodes

+

Bases: src.colorama.ansi.AnsiCodes

BLACK = 30¶
@@ -276,7 +263,7 @@ See:
class src.colorama.ansi.AnsiStyle[source]¶
-

Bases: src.colorama.ansi.AnsiCodes

+

Bases: src.colorama.ansi.AnsiCodes

BRIGHT = 1¶
@@ -325,18 +312,18 @@ See:
class src.colorama.ansitowin32.AnsiToWin32(wrapped, convert=None, strip=None, autoreset=False)[source]¶
-

Bases: object

-

Implements a 'write()' method which, on Windows, will strip ANSI character +

Bases: object

+

Implements a ‘write()’ method which, on Windows, will strip ANSI character sequences from the text, and if outputting to a tty, will convert them into win32 function calls.

-ANSI_CSI_RE = <_sre.SRE_Pattern object>¶
+ANSI_CSI_RE = <_sre.SRE_Pattern object at 0x3504970>¶
-ANSI_OSC_RE = <_sre.SRE_Pattern object>¶
+ANSI_OSC_RE = <_sre.SRE_Pattern object at 0x350dc10>¶
@@ -402,9 +389,9 @@ calls.

class src.colorama.ansitowin32.StreamWrapper(wrapped, converter)[source]¶
-

Bases: object

+

Bases: object

Wraps a stream (such as stdout), acting as a transparent proxy for all -attribute access apart from method 'write()', which is delegated to our +attribute access apart from method ‘write()’, which is delegated to our Converter instance.

@@ -475,7 +462,7 @@ Converter instance.

class src.colorama.winterm.WinColor[source]¶
-

Bases: object

+

Bases: object

BLACK = 0¶
@@ -521,7 +508,7 @@ Converter instance.

class src.colorama.winterm.WinStyle[source]¶
-

Bases: object

+

Bases: object

BRIGHT = 8¶
@@ -542,7 +529,7 @@ Converter instance.

class src.colorama.winterm.WinTerm[source]¶
-

Bases: object

+

Bases: object

back(back=None, light=False, on_stderr=False)[source]¶
@@ -654,18 +641,20 @@ Converter instance.

This Page

@@ -676,11 +665,11 @@ Converter instance.

©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source diff --git a/doc/build/html/apidoc_src/src.example.html b/doc/build/html/apidoc_src/src.example.html index 9de9958..44188c8 100644 --- a/doc/build/html/apidoc_src/src.example.html +++ b/doc/build/html/apidoc_src/src.example.html @@ -1,33 +1,21 @@ + - + - src.example package — salomeTools 5.0.0dev documentation - - - + - + - - @@ -36,8 +24,7 @@ - - +
@@ -57,12 +44,12 @@

essai utilisation logger plusieurs handler format different

/usr/lib/python2.7/logging/__init__.pyc

-

init MyLogger, fmt='%(asctime)s :: %(levelname)-8s :: %(message)s', level='20'

+

init MyLogger, fmt=’%(asctime)s :: %(levelname)-8s :: %(message)s’, level=‘20’

2018-03-11 18:51:21 :: INFO :: test logger info 2018-03-11 18:51:21 :: WARNING :: test logger warning 2018-03-11 18:51:21 :: ERROR :: test logger error 2018-03-11 18:51:21 :: CRITICAL :: test logger critical

-

init MyLogger, fmt='None', level='10'

+

init MyLogger, fmt=’None’, level=‘10’

2018-03-11 18:51:21 :: DEBUG :: test logger debug test logger debug 2018-03-11 18:51:21 :: INFO :: test logger info @@ -98,7 +85,7 @@ test logger critical

sur info() pas de format et su other format

/usr/lib/python2.7/logging/__init__.pyc

-

init MyLogger, fmt='%(asctime)s :: %(levelname)-8s :: %(message)s', level='20'

+

init MyLogger, fmt=’%(asctime)s :: %(levelname)-8s :: %(message)s’, level=‘20’

test logger info 2018-03-11 18:51:51 :: WARNING :: test logger warning 2018-03-11 18:51:51 :: ERROR :: test logger error @@ -107,11 +94,20 @@ sur info() pas de format et su other format

class src.example.essai_logging_2.MyFormatter(fmt=None, datefmt=None)[source]¶
-

Bases: logging.Formatter

+

Bases: logging.Formatter

format(record)[source]¶
-
+

Format the specified record as text.

+

The record’s attribute dictionary is used as the operand to a +string formatting operation which yields the returned string. +Before formatting the dictionary, a couple of preparatory steps +are carried out. The message attribute of the record is computed +using LogRecord.getMessage(). If the formatting string uses the +time (as determined by a call to usesTime(), formatTime() is +called to format the event time. If there is exception information, +it is formatted using formatException() and appended to the message.

+
@@ -171,18 +167,20 @@ sur info() pas de format et su other format

This Page

@@ -193,11 +191,11 @@ sur info() pas de format et su other format

©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source
diff --git a/doc/build/html/apidoc_src/src.html b/doc/build/html/apidoc_src/src.html index 5df5c30..a5afa77 100644 --- a/doc/build/html/apidoc_src/src.html +++ b/doc/build/html/apidoc_src/src.html @@ -1,33 +1,21 @@ + - + - src package — salomeTools 5.0.0dev documentation - - - + - + - - @@ -36,8 +24,7 @@ - - +
@@ -245,9 +232,9 @@ on which SAT is running

Parameters:
    -
  • distrib -- (str) +
  • distrib – (str) The distribution on which the version will be found.
    • -
  • codes -- (L{Mapping}) +
  • codes – (L{Mapping}) The map containing distribution correlation table.
@@ -270,7 +257,7 @@ correlation table contained in codes variable.

-Parameters:codes -- (L{Mapping}) +Parameters:codes – (L{Mapping}) The map containing distribution correlation table. Returns:(str) @@ -348,15 +335,15 @@ and jsonDumps()

usage:
>> import catchAll as CAA >> a = CAA.CatchAll() ->> a.tintin = "reporter" ->> a.milou = "dog" ->> print("a=%s" % a) ->> print("tintin: %s" % a.tintin)
+>> a.tintin = “reporter” +>> a.milou = “dog” +>> print(“a=%s” % a) +>> print(“tintin: %s” % a.tintin)
class src.catchAll.CatchAll[source]¶
-

Bases: object

+

Bases: object

class as simple dynamic dictionary with predefined keys as properties in inherited classes through __init__ method. Or NOT. @@ -365,15 +352,15 @@ with jsonDumps()

usage:

>> import catchAll as CAA >> a = CAA.CatchAll() ->> a.tintin = "reporter" ->> a.milou = "dog" ->> print("a=%s" % a) ->> print("tintin: %s" % a.tintin)

+>> a.tintin = “reporter” +>> a.milou = “dog” +>> print(“a=%s” % a) +>> print(“tintin: %s” % a.tintin)

as

>> a = {} ->> a["tintin"] = "reporter" ->> a["milou"] = "dog" ->> print("tintin: %s" % a["tintin"]

+>> a[“tintin”] = “reporter” +>> a[“milou”] = “dog” +>> print(“tintin: %s” % a[“tintin”]

jsonDumps()[source]¶
@@ -390,8 +377,8 @@ with jsonDumps()

src.catchAll.dumperType(obj)[source]¶
-

to get a "_type" to trace json subclass object, -but ignore all attributes begining with '_'

+

to get a “_type” to trace json subclass object, +but ignore all attributes begining with ‘_’

@@ -403,18 +390,20 @@ but ignore all attributes begining with '_'

src.coloringSat module¶

-

simple tagging as '<color>' for simple coloring log messages on terminal(s) +

simple tagging as ‘<color>’ for simple coloring log messages on terminal(s) window or unix or ios using backend colorama

-

using '<color>' because EZ human readable -so '<color>' are not supposed existing in log message -"{}".format() is not choosen because "{}" are present +

using ‘<color>’ because EZ human readable +so ‘<color>’ are not supposed existing in log message +“{}”.format() is not choosen because “{}” are present in log messages of contents of python dict (as JSON) etc.

+

usage: +>> import src.coloringSat as COLS

example: ->> log("this is in <green>color green<reset>, OK is in blue: <blue>OK?")

+>> log(“this is in <green>color green<reset>, OK is in blue: <blue>OK?”)

class src.coloringSat.ColoringStream[source]¶
-

Bases: object

+

Bases: object

write my stream class only write and flush are used for the streaming https://docs.python.org/2/library/logging.handlers.html @@ -434,7 +423,7 @@ only write and flush are used for the streaming

src.coloringSat.cleanColors(msg)[source]¶
-

clean the message of color tags '<red> ...

+

clean the message of color tags ‘<red> …

@@ -457,7 +446,7 @@ only write and flush are used for the streaming
src.coloringSat.toColor(msg)[source]¶
-

automatically clean the message of color tags '<red> ... +

automatically clean the message of color tags ‘<red> … if the terminal output stdout is redirected by user if not, replace tags with ansi color codes

example: @@ -476,7 +465,7 @@ if not, replace tags with ansi color codes

class src.compilation.Builder(config, logger, product_info, options=OptResult( ), check_src=True)[source]¶
-

Class to handle all construction steps, like cmake, configure, make, ...

+

Class to handle all construction steps, like cmake, configure, make, …

build_configure(options='')[source]¶
@@ -566,7 +555,7 @@ in the directory <APPLICATION DIR>/LOGS/<product_name>/

-Parameters:file_name -- (str) The name of the file to write +Parameters:file_name – (str) The name of the file to write @@ -595,7 +584,7 @@ It build it from scratch.

-Parameters:config -- (Config) The global config. +Parameters:config – (Config) The global config. Returns:(Config) The config corresponding to the file created. @@ -613,9 +602,9 @@ The config corresponding to the file created. Parameters:
    -
  • options -- The options from salomeTools class initialization -(as '-l5' or '--overwrite')
    • -
  • sections -- (str) The config section to overwrite.
    • +
  • options – The options from salomeTools class initialization +(as ‘-l5’ or ‘–overwrite’)
    • +
  • sections – (str) The config section to overwrite.
@@ -635,13 +624,13 @@ The config corresponding to the file created. Parameters:
    -
  • application -- (str) +
  • application – (str) The application for which salomeTools is called.
    • -
  • options -- (Options) +
  • options – (Options) The general salomeTools options -(as '--overwrite' or '-v5')
    • -
  • command -- (str) The command that is called.
    • -
  • datadir -- (str) +(as ‘–overwrite’ or ‘-v5’)
    • +
  • command – (str) The command that is called.
    • +
  • datadir – (str) The repository that contain external data for salomeTools.
@@ -676,7 +665,7 @@ If necessary, build it from another one or create it from scratch.

-Parameters:config -- (Config) +Parameters:config – (Config) The global config (containing all pyconf). @@ -698,7 +687,7 @@ in all the possible directories (pathList)

-Parameters:name -- (str) The name of the searched pyconf. +Parameters:name – (str) The name of the searched pyconf. @@ -709,14 +698,14 @@ in all the possible directories (pathList)

src.configManager.check_path(path, ext=[])[source]¶
-

Construct a text with the input path and "not found" if it does not exist.

+

Construct a text with the input path and “not found” if it does not exist.

@@ -738,14 +727,14 @@ used recursively from the initial path.

@@ -763,8 +752,8 @@ Useful only for completion mechanism

@@ -782,10 +771,10 @@ configuration regarding the passed options.

@@ -801,9 +790,9 @@ The logger instance to use for the display and logging
src.configManager.print_debug(config, aPath, logger, show_label=False, level=0, show_full_path=False)[source]¶

logger output for debugging a config/pyconf -lines contains: path : expression --> 'evaluation'

+lines contains: path : expression –> ‘evaluation’

example: -PROJECTS.projects.salome.project_path : $PWD --> '/tmp/SALOME'

+PROJECTS.projects.salome.project_path : $PWD –> ‘/tmp/SALOME’

@@ -830,8 +819,8 @@ used recursively from the initial path.

@@ -849,9 +838,9 @@ The logger instance to use for the display @@ -869,19 +858,19 @@ Show pretty print debug representation from instances of SAT classes

WARNING: supposedly show messages in SAT development phase, not production

usage: >> import debug as DBG ->> DBG.write("aTitle", aVariable) # not shown in production ->> DBG.write("aTitle", aVariable, True) # unconditionaly shown

+>> DBG.write(“aTitle”, aVariable) # not shown in production +>> DBG.write(“aTitle”, aVariable, True) # unconditionaly shown

class src.debug.InStream(buf='')[source]¶
-

Bases: StringIO.StringIO

+

Bases: StringIO.StringIO

utility class for pyconf.Config input iostream

class src.debug.OutStream(buf='')[source]¶
-

Bases: StringIO.StringIO

+

Bases: StringIO.StringIO

utility class for pyconf.Config output iostream

@@ -926,6 +915,12 @@ as file .pyconf

indent multi lines message

+
+
+src.debug.isTypeConfig(var)[source]¶
+

To know if var is instance from Config/pyconf

+
+
src.debug.pop_debug()[source]¶
@@ -979,9 +974,9 @@ use this only if no logger accessible for classic logger.warning(message)

@@ -998,9 +993,9 @@ use this only if no logger accessible for classic logger.warning(message)

@@ -1011,15 +1006,15 @@ use this only if no logger accessible for classic logger.warning(message)

command_value(key, command)[source]¶
-

Get the value given by the system command "command" +

Get the value given by the system command “command” and put it in the environment variable key

Parameters:
    -
  • path -- (str) The path to check.
    • -
  • ext -- (list) +
  • path – (str) The path to check.
    • +
  • ext – (list) An extension. Verify that the path extension is in the list
Parameters:
    -
  • config -- (Config) +
  • config – (Config) The configuration from which the value is displayed.
    • -
  • path -- (str) The path in the configuration of the value to print.
    • -
  • show_label -- (bool) +
  • path – (str) The path in the configuration of the value to print.
    • +
  • show_label – (bool) If True, do a basic display. (useful for bash completion)
    • -
  • stream -- The output stream used
    • -
  • level -- (int) The number of spaces to add before display.
    • -
  • show_full_path -- (bool) Display full path, else relative
    • +
  • stream – The output stream used
    • +
  • level – (int) The number of spaces to add before display.
    • +
  • show_full_path – (bool) Display full path, else relative
Parameters:
    -
  • config -- (Config) The configuration where to read the values
    • -
  • args -- The path in the config from which get the keys
    • +
  • config – (Config) The configuration where to read the values
    • +
  • args – The path in the config from which get the keys
Parameters:
    -
  • options -- (Options) +
  • options – (Options) The Options instance that stores the commands arguments
    • -
  • config -- (Config) The global configuration
    • -
  • logger -- (Logger) +
  • config – (Config) The global configuration
    • +
  • logger – (Logger) The logger instance to use for the display and logging
Parameters:
    -
  • config -- (Config) the global configuration.
    • -
  • logger -- (Logger) +
  • config – (Config) the global configuration.
    • +
  • logger – (Logger) The logger instance to use for the display
Parameters:
    -
  • config -- (Config) the global configuration.
    • -
  • name -- (str) The name of the product
    • -
  • logger -- (Logger) The logger instance to use for the display
    • +
  • config – (Config) the global configuration.
    • +
  • name – (str) The name of the product
    • +
  • logger – (Logger) The logger instance to use for the display
Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str or list) the value(s) to append to key
    • -
  • sep -- (str) the separator string (usually ':')
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str or list) the value(s) to append to key
    • +
  • sep – (str) the separator string (usually ‘:’)
Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str) the value to append to key
    • -
  • sep -- (str) the separator string (usually ':')
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str) the value to append to key
    • +
  • sep – (str) the separator string (usually ‘:’)
@@ -1030,12 +1025,12 @@ and put it in the environment variable key

get(key)[source]¶
-

Get the value of the environment variable "key"

+

Get the value of the environment variable “key”

Parameters:
    -
  • key -- (str) the environment variable
    • -
  • command -- (str) the command to execute
    • +
  • key – (str) the environment variable
    • +
  • command – (str) the command to execute
- +
Parameters:key -- (str) the environment variable
Parameters:key – (str) the environment variable
@@ -1049,7 +1044,7 @@ and put it in the environment variable key

-Parameters:key -- (str) the environment variable to check +Parameters:key – (str) the environment variable to check @@ -1064,9 +1059,9 @@ and put it in the environment variable key

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str or list) the value(s) to prepend to key
    • -
  • sep -- (str) the separator string (usually ':')
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str or list) the value(s) to prepend to key
    • +
  • sep – (str) the separator string (usually ‘:’)
@@ -1083,9 +1078,9 @@ and put it in the environment variable key

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str) the value to prepend to key
    • -
  • sep -- (str) the separator string (usually ':')
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str) the value to prepend to key
    • +
  • sep – (str) the separator string (usually ‘:’)
@@ -1096,14 +1091,14 @@ and put it in the environment variable key

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -1127,10 +1122,10 @@ environment (SALOME python launcher).

@@ -1176,7 +1171,7 @@ If not None, produce a relative environment - +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:
    -
  • filename -- (str) the file path
    • -
  • additional_env -- (dict) +
  • filename – (str) the file path
    • +
  • additional_env – (dict) a dictionary of additional variables to add to the environment
    • -
  • for_package -- (str) +
  • for_package – (str) If not None, produce a relative environment (designed for a package)
@@ -1149,9 +1144,9 @@ If not None, produce a relative environment
Parameters:
    -
  • filename -- (str) the file path
    • -
  • forBuild -- (bool) if true, the build environment
    • -
  • shell -- (str) the type of file wanted (.sh, .bat)
    • +
  • filename – (str) the file path
    • +
  • forBuild – (bool) if true, the build environment
    • +
  • shell – (str) the type of file wanted (.sh, .bat)
Parameters:comment -- (str) the commentary to add
Parameters:comment – (str) the commentary to add
@@ -1190,7 +1185,7 @@ If not None, produce a relative environment -Parameters:nb_line -- (int) the number of empty lines to add +Parameters:nb_line – (int) the number of empty lines to add @@ -1204,7 +1199,7 @@ If not None, produce a relative environment -Parameters:warning -- (str) the warning to add +Parameters:warning – (str) the warning to add @@ -1219,9 +1214,9 @@ If not None, produce a relative environment Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str) the value to append to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str) the value to append to key
    • +
  • sep – (str) the separator string
@@ -1237,7 +1232,7 @@ If not None, produce a relative environment -Parameters:out -- (file) the stream where to write the environment +Parameters:out – (file) the stream where to write the environment @@ -1251,7 +1246,7 @@ If not None, produce a relative environment -Parameters:required -- (bool) Do nothing if required is False +Parameters:required – (bool) Do nothing if required is False @@ -1260,12 +1255,12 @@ If not None, produce a relative environment
get(key)[source]¶
-

Get the value of the environment variable "key"

+

Get the value of the environment variable “key”

- +
Parameters:key -- (str) the environment variable
Parameters:key – (str) the environment variable
@@ -1277,12 +1272,12 @@ If not None, produce a relative environment

Get the products name to add in SALOME_MODULES environment variable It is the name of the product, except in the case where the is a component name. And it has to be in SALOME_MODULES variable only -if the product has the property has_salome_hui = "yes"

+if the product has the property has_salome_hui = “yes”

- +
Parameters:lProducts -- (list) List of products to potentially add
Parameters:lProducts – (list) List of products to potentially add
@@ -1296,7 +1291,7 @@ if the product has the property has_salome_hui = "yes"

-Parameters:key -- (str) the environment variable to check +Parameters:key – (str) the environment variable to check @@ -1310,7 +1305,7 @@ if the product has the property has_salome_hui = "yes"

-Parameters:cfg_env -- (Config) A config containing an environment +Parameters:cfg_env – (Config) A config containing an environment @@ -1325,9 +1320,9 @@ if the product has the property has_salome_hui = "yes"

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str) the value to prepend to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str) the value to prepend to key
    • +
  • sep – (str) the separator string
@@ -1344,9 +1339,9 @@ if the product has the property has_salome_hui = "yes"

Parameters:
    -
  • product_info -- (Config) The product description
    • -
  • logger -- (Logger) The logger instance to display messages
    • -
  • native -- (bool) If True load set_native_env instead of set_env
    • +
  • product_info – (Config) The product description
    • +
  • logger – (Logger) The logger instance to display messages
    • +
  • native – (bool) If True load set_native_env instead of set_env
@@ -1366,8 +1361,8 @@ if the product has the property has_salome_hui = "yes"

Parameters:
    -
  • script_path -- (str) A path to an environment script
    • -
  • logger -- (Logger) The logger instance to display messages
    • +
  • script_path – (str) A path to an environment script
    • +
  • logger – (Logger) The logger instance to display messages
@@ -1378,14 +1373,14 @@ if the product has the property has_salome_hui = "yes"

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -1402,8 +1397,8 @@ if the product has the property has_salome_hui = "yes"

@@ -1419,7 +1414,7 @@ if the product has the property has_salome_hui = "yes"

- +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:
    -
  • product -- (str) The product name
    • -
  • logger -- (Logger) The logger instance to display messages
    • +
  • product – (str) The product name
    • +
  • logger – (Logger) The logger instance to display messages
Parameters:logger -- (Logger) The logger instance to display messages
Parameters:logger – (Logger) The logger instance to display messages
@@ -1433,7 +1428,7 @@ if the product has the property has_salome_hui = "yes"

-Parameters:product_info -- (Config) The product description +Parameters:product_info – (Config) The product description @@ -1449,8 +1444,8 @@ specified in env_info dictionary.

Parameters:
    -
  • logger -- (Logger) The logger instance to display messages
    • -
  • env_info -- (list) the list of products
    • +
  • logger – (Logger) The logger instance to display messages
    • +
  • env_info – (list) the list of products
@@ -1467,8 +1462,8 @@ specified in env_info dictionary.

Parameters:
    -
  • logger -- (Logger) The logger instance to display messages
    • -
  • src_root -- the application working directory
    • +
  • logger – (Logger) The logger instance to display messages
    • +
  • src_root – the application working directory
@@ -1490,7 +1485,7 @@ specified in env_info dictionary.

-Parameters:pi -- (Config) The product description +Parameters:pi – (Config) The product description @@ -1506,8 +1501,8 @@ xxx_ROOT_DIR and xxx_SRC_DIR

Parameters:
    -
  • product_info -- (Config) The product description
    • -
  • logger -- (Logger) The logger instance to display messages
    • +
  • product_info – (Config) The product description
    • +
  • logger – (Logger) The logger instance to display messages
@@ -1532,9 +1527,9 @@ xxx_ROOT_DIR and xxx_SRC_DIR

Parameters:
    -
  • config -- (Config) the global config
    • -
  • build -- (bool) build environement if True
    • -
  • logger -- (Logger) The logger instance to display messages
    • +
  • config – (Config) the global config
    • +
  • build – (bool) build environement if True
    • +
  • logger – (Logger) The logger instance to display messages
@@ -1549,19 +1544,19 @@ xxx_ROOT_DIR and xxx_SRC_DIR

examples:
    -
  • split all or specific environment variables $XXX(s)... +
  • split all or specific environment variables $XXX(s)… >> environs.py -> all >> environs.py SHELL PATH -> specific $SHELL $PATH
    • -
  • split all or specific environment variables on pattern $*XXX*(s)... ->> environs.py --pat ROOT -> specific $*ROOT*
    • -
  • split search specific substrings in contents of environment variables $XXX(s)... ->> environs.py --grep usr -> all specific environment variables containing usr
    • +
  • split all or specific environment variables on pattern $*XXX*(s)… +>> environs.py –pat ROOT -> specific $*ROOT*
    • +
  • split search specific substrings in contents of environment variables $XXX(s)… +>> environs.py –grep usr -> all specific environment variables containing usr
tips:
  • create unix alias as shortcut for bash console ->> alias envs=".../environs.py"
    • +>> alias envs=”…/environs.py”
@@ -1586,8 +1581,8 @@ xxx_ROOT_DIR and xxx_SRC_DIR

exception src.exceptionSat.ExceptionSat[source]¶
-

Bases: exceptions.Exception

-

rename Exception Class for sat convenience (for future...)

+

Bases: exceptions.Exception

+

rename Exception Class for sat convenience (for future…)

@@ -1596,12 +1591,12 @@ xxx_ROOT_DIR and xxx_SRC_DIR

class src.fileEnviron.BashFileEnviron(output, environ=None)[source]¶
-

Bases: src.fileEnviron.FileEnviron

+

Bases: src.fileEnviron.FileEnviron

Class for bash shell.

command_value(key, command)[source]¶
-

Get the value given by the system command "command" +

Get the value given by the system command “command” and put it in the environment variable key. Has to be overwritten in the derived classes This can be seen as a virtual method

@@ -1610,8 +1605,8 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable
    • -
  • command -- (str) the command to execute
    • +
  • key – (str) the environment variable
    • +
  • command – (str) the command to execute
@@ -1627,7 +1622,7 @@ This can be seen as a virtual method

-Parameters:required -- (bool) Do nothing if required is False +Parameters:required – (bool) Do nothing if required is False @@ -1636,14 +1631,14 @@ This can be seen as a virtual method

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -1656,7 +1651,7 @@ This can be seen as a virtual method

class src.fileEnviron.BatFileEnviron(output, environ=None)[source]¶
-

Bases: src.fileEnviron.FileEnviron

+

Bases: src.fileEnviron.FileEnviron

for Windows batch shell.

@@ -1666,7 +1661,7 @@ This can be seen as a virtual method

- +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:comment -- (str) the comment to add
Parameters:comment – (str) the comment to add
@@ -1675,7 +1670,7 @@ This can be seen as a virtual method

command_value(key, command)[source]¶
-

Get the value given by the system command "command" +

Get the value given by the system command “command” and put it in the environment variable key. Has to be overwritten in the derived classes This can be seen as a virtual method

@@ -1684,8 +1679,8 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable
    • -
  • command -- (str) the command to execute
    • +
  • key – (str) the environment variable
    • +
  • command – (str) the command to execute
@@ -1702,7 +1697,7 @@ In the particular windows case, do nothing

-Parameters:required -- (bool) Do nothing if required is False +Parameters:required – (bool) Do nothing if required is False @@ -1711,12 +1706,12 @@ In the particular windows case, do nothing

get(key)[source]¶
-

Get the value of the environment variable "key"

+

Get the value of the environment variable “key”

- +
Parameters:key -- (str) the environment variable
Parameters:key – (str) the environment variable
@@ -1725,14 +1720,14 @@ In the particular windows case, do nothing

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -1745,7 +1740,7 @@ In the particular windows case, do nothing

class src.fileEnviron.ContextFileEnviron(output, environ=None)[source]¶
-

Bases: src.fileEnviron.FileEnviron

+

Bases: src.fileEnviron.FileEnviron

Class for a salome context configuration file.

@@ -1755,7 +1750,7 @@ In the particular windows case, do nothing

- +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:text -- (str) the comment to add
Parameters:text – (str) the comment to add
@@ -1769,7 +1764,7 @@ In the particular windows case, do nothing

-Parameters:text -- (str) the warning to add +Parameters:text – (str) the warning to add @@ -1784,9 +1779,9 @@ In the particular windows case, do nothing

Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str) the value to append to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str) the value to append to key
    • +
  • sep – (str) the separator string
@@ -1797,7 +1792,7 @@ In the particular windows case, do nothing

command_value(key, command)[source]¶
-

Get the value given by the system command "command" +

Get the value given by the system command “command” and put it in the environment variable key. Has to be overwritten in the derived classes This can be seen as a virtual method

@@ -1806,8 +1801,8 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable
    • -
  • command -- (str) the command to execute
    • +
  • key – (str) the environment variable
    • +
  • command – (str) the command to execute
@@ -1823,7 +1818,7 @@ This can be seen as a virtual method

-Parameters:required -- (bool) Do nothing if required is False +Parameters:required – (bool) Do nothing if required is False @@ -1832,12 +1827,12 @@ This can be seen as a virtual method

get(key)[source]¶
-

Get the value of the environment variable "key"

+

Get the value of the environment variable “key”

- +
Parameters:key -- (str) the environment variable
Parameters:key – (str) the environment variable
@@ -1852,9 +1847,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str) the value to prepend to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str) the value to prepend to key
    • +
  • sep – (str) the separator string
@@ -1865,14 +1860,14 @@ This can be seen as a virtual method

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -1894,7 +1889,7 @@ This can be seen as a virtual method

- +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:comment -- (str) the comment to add
Parameters:comment – (str) the comment to add
@@ -1903,12 +1898,12 @@ This can be seen as a virtual method

add_echo(text)[source]¶
-

Add a 'echo' in the shell file

+

Add a ‘echo’ in the shell file

- +
Parameters:text -- (str) the text to echo
Parameters:text – (str) the text to echo
@@ -1922,7 +1917,7 @@ This can be seen as a virtual method

-Parameters:number -- (int) the number of lines to add +Parameters:number – (int) the number of lines to add @@ -1931,12 +1926,12 @@ This can be seen as a virtual method

add_warning(warning)[source]¶
-

Add a warning "echo" in the shell file

+

Add a warning “echo” in the shell file

- +
Parameters:warning -- (str) the text to echo
Parameters:warning – (str) the text to echo
@@ -1951,9 +1946,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str or list) the value(s) to append to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str or list) the value(s) to append to key
    • +
  • sep – (str) the separator string
@@ -1970,9 +1965,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str) the value to append to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str) the value to append to key
    • +
  • sep – (str) the separator string
@@ -1983,7 +1978,7 @@ This can be seen as a virtual method

command_value(key, command)[source]¶
-

Get the value given by the system command "command" +

Get the value given by the system command “command” and put it in the environment variable key. Has to be overwritten in the derived classes This can be seen as a virtual method

@@ -1992,8 +1987,8 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable
    • -
  • command -- (str) the command to execute
    • +
  • key – (str) the environment variable
    • +
  • command – (str) the command to execute
@@ -2009,7 +2004,7 @@ This can be seen as a virtual method

-Parameters:required -- (bool) Do nothing if required is False +Parameters:required – (bool) Do nothing if required is False @@ -2018,12 +2013,12 @@ This can be seen as a virtual method

get(key)[source]¶
-

Get the value of the environment variable "key"

+

Get the value of the environment variable “key”

- +
Parameters:key -- (str) the environment variable
Parameters:key – (str) the environment variable
@@ -2037,7 +2032,7 @@ This can be seen as a virtual method

-Parameters:key -- (str) the environment variable to check +Parameters:key – (str) the environment variable to check @@ -2052,9 +2047,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str or list) the value(s) to prepend to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str or list) the value(s) to prepend to key
    • +
  • sep – (str) the separator string
@@ -2071,9 +2066,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- str) the value to prepend to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – str) the value to prepend to key
    • +
  • sep – (str) the separator string
@@ -2084,14 +2079,14 @@ This can be seen as a virtual method

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -2115,8 +2110,8 @@ This can be seen as a virtual method

@@ -2137,7 +2132,7 @@ This can be seen as a virtual method

- +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str) the value to prepend to key
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str) the value to prepend to key
Parameters:text -- (str) the comment to add
Parameters:text – (str) the comment to add
@@ -2151,7 +2146,7 @@ This can be seen as a virtual method

-Parameters:number -- (int) the number of lines to add +Parameters:number – (int) the number of lines to add @@ -2165,7 +2160,7 @@ This can be seen as a virtual method

-Parameters:text -- (str) the warning to add +Parameters:text – (str) the warning to add @@ -2180,9 +2175,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str or list) the value(s) to append to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str or list) the value(s) to append to key
    • +
  • sep – (str) the separator string
@@ -2199,9 +2194,9 @@ This can be seen as a virtual method

Parameters:
    -
  • key -- (str) the environment variable to append
    • -
  • value -- (str) the value to append to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to append
    • +
  • value – (str) the value to append to key
    • +
  • sep – (str) the separator string
@@ -2218,15 +2213,15 @@ This can be seen as a virtual method

command_value(key, command)[source]¶
-

Get the value given by the system command "command" +

Get the value given by the system command “command” and put it in the environment variable key.

@@ -2243,7 +2238,7 @@ In the particular launcher case, do nothing

- +
Parameters:
    -
  • key -- (str) the environment variable
    • -
  • command -- (str) the command to execute
    • +
  • key – (str) the environment variable
    • +
  • command – (str) the command to execute
Parameters:required -- (bool) Do nothing if required is False
Parameters:required – (bool) Do nothing if required is False
@@ -2252,12 +2247,12 @@ In the particular launcher case, do nothing

get(key)[source]¶
-

Get the value of the environment variable "key"

+

Get the value of the environment variable “key”

- +
Parameters:key -- (str) the environment variable
Parameters:key – (str) the environment variable
@@ -2271,7 +2266,7 @@ In the particular launcher case, do nothing

-Parameters:key -- (str) the environment variable to check +Parameters:key – (str) the environment variable to check @@ -2286,9 +2281,9 @@ In the particular launcher case, do nothing

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str or list) the value(s) to prepend to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str or list) the value(s) to prepend to key
    • +
  • sep – (str) the separator string
@@ -2305,9 +2300,9 @@ In the particular launcher case, do nothing

Parameters:
    -
  • key -- (str) the environment variable to prepend
    • -
  • value -- (str) the value to prepend to key
    • -
  • sep -- (str) the separator string
    • +
  • key – (str) the environment variable to prepend
    • +
  • value – (str) the value to prepend to key
    • +
  • sep – (str) the separator string
@@ -2318,14 +2313,14 @@ In the particular launcher case, do nothing

set(key, value)[source]¶
-

Set the environment variable "key" to value "value"

+

Set the environment variable “key” to value “value”

@@ -2338,7 +2333,7 @@ In the particular launcher case, do nothing

class src.fileEnviron.ScreenEnviron(output, environ=None)[source]¶
-

Bases: src.fileEnviron.FileEnviron

+

Bases: src.fileEnviron.FileEnviron

add_comment(comment)[source]¶
@@ -2410,9 +2405,9 @@ In the particular launcher case, do nothing

@@ -2431,7 +2426,7 @@ to append or prepend.

- +
Parameters:
    -
  • key -- (str) the environment variable to set
    • -
  • value -- (str) the value
    • +
  • key – (str) the environment variable to set
    • +
  • value – (str) the value
Parameters:
    -
  • output -- (file) the output file stream.
    • -
  • shell -- (str) the type of shell syntax to use.
    • -
  • environ -- (dict) a potential additional environment.
    • +
  • output – (file) the output file stream.
    • +
  • shell – (str) the type of shell syntax to use.
    • +
  • environ – (dict) a potential additional environment.
Parameters:name -- (str) The name of the variable to find the separator
Parameters:name – (str) The name of the variable to find the separator
@@ -2467,10 +2462,10 @@ to append or prepend.

Parameters:
    -
  • logger -- (Logger) The logging instance
    • -
  • top -- (int) the number to display
    • -
  • delai -- (int) the number max
    • -
  • ss -- (str) the string to display
    • +
  • logger – (Logger) The logging instance
    • +
  • top – (int) the number to display
    • +
  • delai – (int) the number max
    • +
  • ss – (str) the string to display
@@ -2487,9 +2482,9 @@ to append or prepend.

Parameters:
    -
  • logger -- (Logger) The logging instance
    • -
  • message -- (str) the text to display
    • -
  • level -- (int) the level of verbosity
    • +
  • logger – (Logger) The logging instance
    • +
  • message – (str) the text to display
    • +
  • level – (int) the level of verbosity
@@ -2511,11 +2506,20 @@ on other formatted indented on multi lines messages
class src.loggingSat.DefaultFormatter(fmt=None, datefmt=None)[source]¶
-

Bases: logging.Formatter

+

Bases: logging.Formatter

format(record)[source]¶
-
+

Format the specified record as text.

+

The record’s attribute dictionary is used as the operand to a +string formatting operation which yields the returned string. +Before formatting the dictionary, a couple of preparatory steps +are carried out. The message attribute of the record is computed +using LogRecord.getMessage(). If the formatting string uses the +time (as determined by a call to usesTime(), formatTime() is +called to format the event time. If there is exception information, +it is formatted using formatException() and appended to the message.

+
@@ -2527,18 +2531,27 @@ on other formatted indented on multi lines messages
class src.loggingSat.UnittestFormatter(fmt=None, datefmt=None)[source]¶
-

Bases: logging.Formatter

+

Bases: logging.Formatter

format(record)[source]¶
-
+

Format the specified record as text.

+

The record’s attribute dictionary is used as the operand to a +string formatting operation which yields the returned string. +Before formatting the dictionary, a couple of preparatory steps +are carried out. The message attribute of the record is computed +using LogRecord.getMessage(). If the formatting string uses the +time (as determined by a call to usesTime(), formatTime() is +called to format the event time. If there is exception information, +it is formatted using formatException() and appended to the message.

+
class src.loggingSat.UnittestStream[source]¶
-

Bases: object

+

Bases: object

write my stream class only write and flush are used for the streaming https://docs.python.org/2/library/logging.handlers.html @@ -2598,7 +2611,7 @@ keep human readable

src.loggingSat.initLoggerAsDefault(logger, fmt=None, level=None)[source]¶

init logger as prefixed message and indented message if multi line -exept info() outed 'as it' without any format

+exept info() outed ‘as it’ without any format

@@ -2629,7 +2642,7 @@ parameters in salomeTools command lines

class src.options.OptResult[source]¶
-

Bases: object

+

Bases: object

An instance of this class will be the object manipulated in code of all salomeTools commands The aim of this class is to have an elegant syntax to manipulate the options.

@@ -2641,7 +2654,7 @@ The aim of this class is to have an elegant syntax to manipulate the options.

class src.options.Options[source]¶
-

Bases: object

+

Bases: object

Class to manage all salomeTools options

@@ -2653,13 +2666,13 @@ of an option and append it in the options field

Parameters:
    -
  • shortName -- (str) -The short name of the option (as '-l' for level option).
    • -
  • longName -- (str) -The long name of the option (as '--level' for level option).
    • -
  • optionType -- (str) The type of the option (ex "int").
    • -
  • destName -- (str) The name that will be used in the code.
    • -
  • helpString -- (str) +
  • shortName – (str) +The short name of the option (as ‘-l’ for level option).
    • +
  • longName – (str) +The long name of the option (as ‘–level’ for level option).
    • +
  • optionType – (str) The type of the option (ex “int”).
    • +
  • destName – (str) The name that will be used in the code.
    • +
  • helpString – (str) The text to display when user ask for help on a command.
@@ -2720,7 +2733,7 @@ that gives access to all options in the code

-Parameters:argList -- (list) the raw list of arguments that were passed +Parameters:argList – (list) the raw list of arguments that were passed Returns:(OptResult, list) as (optResult, args) optResult is the option instance to manipulate in the code. @@ -2748,11 +2761,11 @@ that is in it

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • prod_dir -- (str) +
  • config – (Config) The global configuration
    • +
  • prod_dir – (str) The product installation directory path (without config-<i>)
    • -
  • product_info -- (Config) +
  • product_info – (Config) The configuration specific to the product
@@ -2776,7 +2789,7 @@ and some additional files if it is defined in the config

-Parameters:product_info -- (Config) +Parameters:product_info – (Config) The configuration specific to the product Returns:(bool) True if it is well installed @@ -2794,10 +2807,10 @@ The configuration specific to the product Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_info -- (Config) +
  • config – (Config) The global configuration
    • +
  • product_info – (Config) The configuration specific to the product
    • -
  • version -- (str) The version of the product
    • +
  • version – (str) The version of the product
@@ -2817,14 +2830,14 @@ The configuration specific to the product Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • base -- (str) +
  • config – (Config) The global configuration
    • +
  • base – (str) This corresponds to the value given by user in its application.pyconf for the specific product. -If "yes", the user wants the product to be in base. -If "no", he wants the product to be in the application workdir
    • -
  • version -- (str) The version of the product
    • -
  • product_info -- (Config) The configuration specific to the product
    • +If “yes”, the user wants the product to be in base. +If “no”, he wants the product to be in the application workdir +
  • version – (str) The version of the product
    • +
  • product_info – (Config) The configuration specific to the product
@@ -2843,7 +2856,7 @@ If "no", he wants the product to be in the application workdir -Parameters:product_info -- (Config) +Parameters:product_info – (Config) The configuration specific to the product Returns:(list) The list of names of the components @@ -2855,15 +2868,16 @@ The configuration specific to the product
src.product.get_product_config(config, product_name, with_install_dir=True)[source]¶
-

Get the specific configuration of a product from the global configuration

+

Get the specific configuration of a product +from the global configuration

@@ -2908,10 +2922,10 @@ The configuration specific to the product @@ -4858,12 +4893,12 @@ to add to all paths in lpath.

src.utilsSat.formatTuples(tuples)[source]¶
-

Format 'label = value' the tuples in a tabulated way.

+

Format ‘label = value’ the tuples in a tabulated way.

Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_name -- (str) The name of the product
    • -
  • with_install_dir -- (boolean) +
  • config – (Config) The global configuration
    • +
  • product_name – (str) The name of the product
    • +
  • with_install_dir – (boolean) If false, do not provide an install directory (at false only for internal use of the function check_config_exists)
@@ -2886,8 +2900,8 @@ in the product_info dependencies
Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_info -- (Config) +
  • config – (Config) The global configuration
    • +
  • product_info – (Config) The configuration specific to the product
Parameters:
    -
  • config -- (Config) The global configuration
    • -
  • product_name -- (str) The product name
    • -
  • version -- (str) The version of the product
    • -
  • section -- (str) +
  • config – (Config) The global configuration
    • +
  • product_name – (str) The product name
    • +
  • version – (str) The version of the product
    • +
  • section – (str) The searched section (if not None, the section is explicitly given)
@@ -2926,15 +2940,15 @@ The searched section
-src.product.get_products_infos(lproducts, config)[source]¶
+src.product.get_products_infos(products, config)[source]¶

Get the specific configuration of a list of products

@@ -2957,7 +2971,7 @@ as (product name, specific configuration of the product)

- - - - - - - - - - - - - - @@ -3208,7 +3222,7 @@ The configuration specific to the product - - - - - - - + @@ -4802,7 +4837,7 @@ The same date and time in separate variables. - + @@ -4818,7 +4853,7 @@ The same date and time in separate variables. - +
Parameters:
    -
  • lproducts -- (list) The list of product names
    • -
  • config -- (Config) The global configuration
    • +
  • products – (list) The list of product names
    • +
  • config – (Config) The global configuration
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -2975,7 +2989,7 @@ True if the product compiles, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -2993,7 +3007,7 @@ True if the product it has an environment script, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(str) @@ -3011,7 +3025,7 @@ The path of the logo if the product has a logo, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3029,7 +3043,7 @@ True if the product has one or more patches
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3047,7 +3061,7 @@ True if the product has a SALOME gui, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3065,7 +3079,7 @@ True if the product it has a compilation script, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3083,7 +3097,7 @@ True if the product is a SALOME module, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3101,7 +3115,7 @@ True if the product is autotools, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3119,7 +3133,7 @@ True if the product is cmake, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3137,7 +3151,7 @@ True if the product is a cpp, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3155,7 +3169,7 @@ True if the product is in debug mode, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3173,7 +3187,7 @@ True if the product is in dev mode, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3191,7 +3205,7 @@ True if the product is fixed, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) True if the product is generated
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3226,7 +3240,7 @@ True if the product has openmpi inits dependencies
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3244,7 +3258,7 @@ True if the product is native, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3262,7 +3276,7 @@ True if the product is salome, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3280,7 +3294,7 @@ True if the product has the sample type, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3298,7 +3312,7 @@ True if the product is a SMESH plugin, else False
Parameters:product_info -- (Config) +
Parameters:product_info – (Config) The configuration specific to the product
Returns:(bool) @@ -3319,7 +3333,7 @@ Python 2.4.2. See the test module (test_config.py) included in the U{distribution<http://www.red-dove.com/python_config.html|_blank>} (follow the download link).

A simple example - with the example configuration file:

-
messages:
+
messages:
 [
   {
     stream : `sys.stderr`
@@ -3340,7 +3354,7 @@ download link).

 

 

 
a program to read the configuration would be:

-
from config import Config
+
from config import Config
 
 f = file('simple.cfg')
 cfg = Config(f)
@@ -3353,7 +3367,7 @@ download link).

 

 

 
which, when run, would yield the console output:

-
Welcome, Harry
+
Welcome, Harry
 Welkom, Ruud
 Bienvenue, Yves
 

@@ -3368,24 +3382,24 @@ information.

 takes a string (e.g. filename) and returns a stream suitable for reading. If
 unable to open the stream, an IOError exception should be thrown.

 
The default value of this variable is L{defaultStreamOpener}. For an example
-of how it's used, see test_config.py (search for streamOpener).

+of how it’s used, see test_config.py (search for streamOpener).

 

 

 class src.pyconf.Config(streamOrFile=None, parent=None, PWD=None)[source]¶

-
Bases: src.pyconf.Mapping

+
Bases: src.pyconf.Mapping

 
This class represents a configuration, and is the only one which clients
 need to interface to, under normal circumstances.

 

 

 class Namespace[source]¶

-
Bases: object

+
Bases: object

 
This internal class is used for implementing default namespaces.

 
An instance acts as a namespace.

 

 
 

 

-Config.addNamespace(ns, name=None)[source]¶

+addNamespace(ns, name=None)[source]¶
 
Add a namespace to this configuration which can be used to evaluate
 (resolve) dotted-identifier expressions.
 @param ns: The namespace to be added.
@@ -3398,7 +3412,7 @@ an additional level of indirection.
 
 

 

-Config.getByPath(path)[source]¶

+getByPath(path)[source]¶
 
Obtain a value in the configuration via its path.
 @param path: The path of the required value
 @type path: str
@@ -3409,7 +3423,7 @@ an additional level of indirection.
 
 

 

-Config.load(stream)[source]¶

+load(stream)[source]¶
 
Load the configuration from the specified stream. Multiple streams can
 be used to populate the same instance, as long as there are no
 clashing keys. The stream is closed.
@@ -3422,7 +3436,7 @@ existing keys.
 
 

 

-Config.removeNamespace(ns, name=None)[source]¶

+removeNamespace(ns, name=None)[source]¶
 
Remove a namespace added with L{addNamespace}.
 @param ns: The namespace to be removed.
 @param name: The name which was specified when L{addNamespace} was
@@ -3435,14 +3449,14 @@ called.
 

 

 exception src.pyconf.ConfigError[source]¶

-
Bases: exceptions.Exception

+
Bases: exceptions.Exception

 
This is the base class of exceptions raised by this module.

 

 
 

 

 exception src.pyconf.ConfigFormatError[source]¶

-
Bases: src.pyconf.ConfigError

+
Bases: src.pyconf.ConfigError

 
This is the base class of exceptions raised due to syntax errors in
 configurations.

 

@@ -3450,7 +3464,7 @@ configurations.

 

 

 class src.pyconf.ConfigInputStream(stream)[source]¶

-
Bases: object

+
Bases: object

 
An input stream which can read either ANSI files with default encoding
 or Unicode files with BOMs.

 
Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
@@ -3475,7 +3489,7 @@ built-in support.

 

 

 class src.pyconf.ConfigList[source]¶

-
Bases: list

+
Bases: list

 
This class implements an ordered list of configurations and allows you
 to try getting the configuration from each entry in turn, returning
 the first successfully obtained value.

@@ -3497,8 +3511,8 @@ the specified path.

 
 

 

-class src.pyconf.ConfigMerger(resolver=<function defaultMergeResolve>)[source]¶

-
Bases: object

+class src.pyconf.ConfigMerger(resolver=<function defaultMergeResolve at 0x3561c80>)[source]¶
+
Bases: object

 
This class is used for merging two configurations. If a key exists in the
 merge operand but not the merge target, then the entry is copied from the
 merge operand to the merge target. If a key exists in both configurations,
@@ -3564,7 +3578,7 @@ and the first is changed depending the keys of the second mapping.
 

 

 class src.pyconf.ConfigOutputStream(stream, encoding=None)[source]¶

-
Bases: object

+
Bases: object

 
An output stream which can write either ANSI files with default encoding
 or Unicode files with BOMs.

 
Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
@@ -3589,7 +3603,7 @@ built-in support.

 

 

 class src.pyconf.ConfigReader(config)[source]¶

-
Bases: object

+
Bases: object

 
This internal class implements a parser for configurations.

 

 

@@ -3647,7 +3661,7 @@ advance to the next token.

 @return: The token which was last read from the stream before this
 function is called.
 @rtype: a token tuple - see L{getToken}.
-@raise ConfigFormatError: If the token does not match what's expected.

+@raise ConfigFormatError: If the token does not match what’s expected.

 

 
 

@@ -3766,7 +3780,7 @@ an L{Expression} or L{Reference}.

 

 

 exception src.pyconf.ConfigResolutionError[source]¶

-
Bases: src.pyconf.ConfigError

+
Bases: src.pyconf.ConfigError

 
This is the base class of exceptions raised due to semantic errors in
 configurations.

 

@@ -3774,12 +3788,12 @@ configurations.

 

 

 class src.pyconf.Container(parent)[source]¶

-
Bases: object

+
Bases: object

 
This internal class is the base class for mappings and sequences.

 
@ivar path: A string which describes how to get
 to this instance from the root of the hierarchy.

 
Example:

-
a.list.of[1].or['more'].elements
+
a.list.of[1].or['more'].elements
 

 

 

@@ -3829,7 +3843,7 @@ to this instance from the root of the hierarchy.
 

 

 class src.pyconf.Expression(op, lhs, rhs)[source]¶

-
Bases: object

+
Bases: object

 
This internal class implements a value which is obtained by evaluating an expression.

 

 

@@ -3850,7 +3864,7 @@ subtracting one string from another.

 

 

 class src.pyconf.Mapping(parent=None)[source]¶

-
Bases: src.pyconf.Container

+
Bases: src.pyconf.Container

 
This internal class implements key-value mappings in configurations.

 

 

@@ -3908,7 +3922,7 @@ again and setting is False.

 

 

 class src.pyconf.Reference(config, type, ident)[source]¶

-
Bases: object

+
Bases: object

 
This internal class implements a value which is a reference to another value.

 

 

@@ -3946,12 +3960,12 @@ again and setting is False.

 

 

 class src.pyconf.Sequence(parent=None)[source]¶

-
Bases: src.pyconf.Container

+
Bases: src.pyconf.Container

 
This internal class implements a value which is a sequence of other values.

 

 

 class SeqIter(seq)[source]¶

-
Bases: object

+
Bases: object

 
This internal class implements an iterator for a L{Sequence} instance.

 

 

@@ -3962,7 +3976,7 @@ again and setting is False.

 
 

 

-Sequence.append(item, comment)[source]¶

+append(item, comment)[source]¶

 
Add an item to the sequence.

 
@param item: The item to add.
 @type item: any
@@ -3972,7 +3986,7 @@ again and setting is False.

 
 

 

-Sequence.writeToStream(stream, indent, container)[source]¶

+writeToStream(stream, indent, container)[source]¶

 
Write this instance to a stream at the specified indentation level.

 
Should be redefined in subclasses.

 
@param stream: The stream to write to
@@ -4001,10 +4015,10 @@ Returns a string indicating what action to take to resolve the conflict.

 @type map2: L{Mapping}.
 @param key: The key in map2 (which also exists in map1).
 @type key: str
-@return: One of "merge", "append", "mismatch" or "overwrite" 
+@return: One of “merge”, “append”, “mismatch” or “overwrite” 
 indicating what action should be taken. This should
 be appropriate to the objects being merged - e.g.
-there is no point returning "merge" if the two objects
+there is no point returning “merge” if the two objects
 are instances of L{Sequence}.
 @rtype: str

 

@@ -4031,14 +4045,14 @@ urllib2.urlopen().

 string, False is returned. An identifier consists of alphanumerics or
 underscore characters.

 
Examples:

-
isWord('a word') ->False
+
isWord('a word') ->False
 isWord('award') -> True
 isWord(9) -> False
 isWord('a_b_c_') ->True
 

 

-
@note: isWord('9abc') will return True - not exactly correct, but adequate
-for the way it's used here.

+
@note: isWord(‘9abc’) will return True - not exactly correct, but adequate
+for the way it’s used here.

 
@param s: The name to be tested
 @type s: any
 @return: True if a word, else False
@@ -4050,9 +4064,9 @@ for the way it's used here.

 src.pyconf.makePath(prefix, suffix)[source]¶

 
Make a path from a prefix and suffix.

 
Examples::
-makePath('', 'suffix') -> 'suffix'
-makePath('prefix', 'suffix') -> 'prefix.suffix'
-makePath('prefix', '[1]') -> 'prefix[1]'

+makePath(‘’, ‘suffix’) -> ‘suffix’
+makePath(‘prefix’, ‘suffix’) -> ‘prefix.suffix’
+makePath(‘prefix’, ‘[1]’) -> ‘prefix[1]’

 
@param prefix:  The prefix to use. If it evaluates as false, the suffix is returned.
 @type prefix:   str
 @param suffix:  The suffix to use. It is either an identifier or an index in brackets.
@@ -4065,7 +4079,7 @@ makePath('prefix', '[1]') -> 'prefix[1]'

 

 src.pyconf.overwriteMergeResolve(map1, map2, key)[source]¶

 
An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve},
-but where a "mismatch" is detected, returns "overwrite" instead.

+but where a “mismatch” is detected, returns “overwrite” instead.

 
@param map1: The map being merged into.
 @type map1: L{Mapping}.
 @param map2: The map being used as the merge operand.
@@ -4083,25 +4097,25 @@ but where a "mismatch" is detected, returns "overwrite" inst
 

 

 class src.returnCode.ReturnCode(status=None, why=None, value=None)[source]¶

-
Bases: object

-
assume simple return code for methods, with explanation as 'why'
+
Bases: object

+
assume simple return code for methods, with explanation as ‘why’
 obviously why is why it is not OK, 
 but also why is why it is OK (if you want). 
 and optionnaly contains a return value as self.getValue()

 
usage:
 >> import returnCode as RCO

 
>> aValue = doSomethingToReturn()
->> return RCO.ReturnCode("KO", "there is no problem here", aValue)
->> return RCO.ReturnCode("KO", "there is a problem here because etc", None)
->> return RCO.ReturnCode("TIMEOUT_STATUS", "too long here because etc")
->> return RCO.ReturnCode("NA", "not applicable here because etc")

+>> return RCO.ReturnCode(“KO”, “there is no problem here”, aValue)
+>> return RCO.ReturnCode(“KO”, “there is a problem here because etc”, None)
+>> return RCO.ReturnCode(“TIMEOUT_STATUS”, “too long here because etc”)
+>> return RCO.ReturnCode(“NA”, “not applicable here because etc”)

 
>> rc = doSomething()
->> print("short returnCode string", str(rc))
->> print("long returnCode string with value", repr(rc))

-
>> rc1 = RCO.ReturnCode("OK", ...)
->> rc2 = RCO.ReturnCode("KO", ...)
+>> print(“short returnCode string”, str(rc))
+>> print(“long returnCode string with value”, repr(rc))

+
>> rc1 = RCO.ReturnCode(“OK”, …)
+>> rc2 = RCO.ReturnCode(“KO”, …)
 >> rcFinal = rc1 + rc2
->> print("long returnCode string with value", repr(rcFinal)) # KO!

+>> print(“long returnCode string with value”, repr(rcFinal)) # KO!

 

 

 KFSYS = 4¶

@@ -4218,13 +4232,13 @@ and optionnaly contains a return value as self.getValue()

 

 
src.salomeTools module¶

 
This file is the main entry file to salomeTools
-NO __main__ entry allowed, use 'sat' (in parent directory)

+NO __main__ entry allowed, use ‘sat’ (in parent directory)

 

 

 class src.salomeTools.Sat(logger)[source]¶

-
Bases: object

+
Bases: object

 
The main class that stores all the commands of salomeTools
-(usually known as 'runner' argument in Command classes)

+(usually known as ‘runner’ argument in Command classes)

 

 

 assumeAsList(strOrList)[source]¶

@@ -4233,12 +4247,12 @@ NO __main__ entry allowed, use 'sat' (in parent directory)

 

 

 execute_cli(cli_arguments)[source]¶

-
select first argument as a command in directory 'commands', and launch on arguments

+
select first argument as a command in directory ‘commands’, and launch on arguments

 
-
+

 
 
 
Parameters:cli_arguments -- (str or list) The sat cli arguments (as sys.argv)
Parameters:cli_arguments – (str or list) The sat cli arguments (as sys.argv)
 

 
 

@@ -4258,7 +4272,7 @@ NO __main__ entry allowed, use 'sat' (in parent directory)

 

 

 getCommandInstance(name)[source]¶

-
returns inherited instance of Command(_BaseCmd) for command 'name'
+
returns inherited instance of Command(_BaseCmd) for command ‘name’
 if module not loaded yet, load it.

 

 
@@ -4280,7 +4294,7 @@ if module not loaded yet, load it.

 

 

 getModule(name)[source]¶

-
returns only-one-time loaded module Command 'name'
+
returns only-one-time loaded module Command ‘name’
 assume load if not done yet

 

 
@@ -4312,12 +4326,12 @@ assume load if not done yet

 

 

 src.salomeTools.find_command_list(dirPath)[source]¶

-
Parse files in dirPath that end with '.py' : it gives commands list

+
Parse files in dirPath that end with ‘.py’ : it gives commands list

 
-
+
@@ -4341,8 +4355,8 @@ assume load if not done yet

 src.salomeTools.launchSat(command)[source]¶
launch sat as subprocess.Popen
-command as string ('sat --help' for example)
-used for unittest, or else...

+command as string (‘sat –help’ for example)
+used for unittest, or else…

 

 
 
 
Parameters:dirPath -- (str) The directory path where to search the commands
Parameters:dirPath – (str) The directory path where to search the commands
 

 
Returns:(list) the list containing the commands name
 

 
 
@@ -4357,8 +4371,8 @@ used for unittest, or else...

 src.salomeTools.setLocale()[source]¶
reset initial locale at any moment 
-'fr' or else (TODO) from initial environment var '$LANG'
-'i18n' as 'internationalization'

+‘fr’ or else (TODO) from initial environment var ‘$LANG’
+‘i18n’ as ‘internationalization’

 

@@ -4385,9 +4399,9 @@ like open a browser or an editor, or call a git command

 

@@ -4407,16 +4421,16 @@ like open a browser or an editor, or call a git command

@@ -4437,11 +4451,11 @@ The environment to source when extracting.
@@ -4462,8 +4476,8 @@ The environment to source when extracting.
@@ -4480,13 +4494,13 @@ The environment to source when extracting.
@@ -4504,7 +4518,7 @@ The environment to source when extracting.

 

 class src.template.MyTemplate(template)[source]¶

-
Bases: string.Template

+
Bases: string.Template

 

 

 delimiter = '\xc2\xa4'¶

@@ -4512,7 +4526,7 @@ The environment to source when extracting.
 
 

 

-pattern = <_sre.SRE_Pattern object>¶

+pattern = <_sre.SRE_Pattern object at 0x412cde0>¶
 

 
 

@@ -4612,7 +4626,7 @@ The environment to source when extracting.

 

 write_test_margin(tab)[source]¶

-
indent with '| ... +' to show test results.

+
indent with ‘| … +’ to show test results.

 

@@ -4733,14 +4747,14 @@ all-in-one import srs.utilsSat as UTS

 

-src.utilsSat.check_config_has_application(config, details=None)[source]¶

+src.utilsSat.check_config_has_application(config)[source]¶
 
Check that the config has the key APPLICATION. 
 Else raise an exception.

 

 
 

 
 
 
 
 
 
Parameters:
    
-
  • from_what -- (str) The path to the archive.
    • 
-
  • where -- (str) The path where to extract.
    • 
-
  • logger -- (Logger) The logger instance to use.
    • 
+
  • from_what – (str) The path to the archive.
    • 
+
  • where – (str) The path where to extract.
    • 
+
  • logger – (Logger) The logger instance to use.
    • 
 

 		
 

 
 
 
Parameters:
    
-
  • protocol -- (str) The cvs protocol.
    • 
-
  • user -- (str) The user to be used.
    • 
-
  • server -- (str) The remote cvs server.
    • 
-
  • base -- (str) .
    • 
-
  • tag -- (str) The tag.
    • 
-
  • product -- (str) The product.
    • 
-
  • where -- (str) The path where to extract.
    • 
-
  • logger -- (Logger) The logger instance to use.
    • 
-
  • checkout -- (bool) If true use checkout cvs.
    • 
-
  • environment -- (Environ) 
+
  • protocol – (str) The cvs protocol.
    • 
+
  • user – (str) The user to be used.
    • 
+
  • server – (str) The remote cvs server.
    • 
+
  • base – (str) .
    • 
+
  • tag – (str) The tag.
    • 
+
  • product – (str) The product.
    • 
+
  • where – (str) The path where to extract.
    • 
+
  • logger – (Logger) The logger instance to use.
    • 
+
  • checkout – (bool) If true use checkout cvs.
    • 
+
  • environment – (Environ) 
 The environment to source when extracting.
    • 
 

 		
 

 
 
Parameters:
    
-
  • from_what -- (str) The remote git repository.
    • 
-
  • tag -- (str) The tag.
    • 
-
  • where -- (str) The path where to extract.
    • 
-
  • logger -- (Logger) The logger instance to use.
    • 
-
  • environment -- (Environ) 
+
  • from_what – (str) The remote git repository.
    • 
+
  • tag – (str) The tag.
    • 
+
  • where – (str) The path where to extract.
    • 
+
  • logger – (Logger) The logger instance to use.
    • 
+
  • environment – (Environ) 
 The environment to source when extracting.
    • 
 

 		
 

 
 
Parameters:
    
-
  • editor -- (str) The editor to use.
    • 
-
  • filePath -- (str) The path to the file to open.
    • 
+
  • editor – (str) The editor to use.
    • 
+
  • filePath – (str) The path to the file to open.
    • 
 

 		
 

 
 
 
Parameters:
    
-
  • user -- (str) The user to be used.
    • 
-
  • from_what -- (str) The remote git repository.
    • 
-
  • tag -- (str) The tag.
    • 
-
  • where -- (str) The path where to extract.
    • 
-
  • logger -- (Logger) The logger instance to use.
    • 
-
  • checkout -- (bool) If true use checkout svn.
    • 
-
  • environment -- (Environ)
+
  • user – (str) The user to be used.
    • 
+
  • from_what – (str) The remote git repository.
    • 
+
  • tag – (str) The tag.
    • 
+
  • where – (str) The path where to extract.
    • 
+
  • logger – (Logger) The logger instance to use.
    • 
+
  • checkout – (bool) If true use checkout svn.
    • 
+
  • environment – (Environ)
 The environment to source when extracting.
    • 
 

 		
 
 
 
 
 
 

-
+

 
 
 
Parameters:config -- (Config) The config.
Parameters:config – (Config) The config.
 

 
 

@@ -4748,14 +4762,35 @@ Else raise an exception.

 
 

 

-src.utilsSat.check_config_has_profile(config, details=None)[source]¶

+src.utilsSat.check_config_has_profile(config)[source]¶

 
Check that the config has the key APPLICATION.profile.
 Else, raise an exception.

 
-
+
+
+
+

 
 
 
Parameters:config -- (Config) The config.
Parameters:config – (Config) The config.

+

+
+

+

+src.utilsSat.check_has_key(inConfig, key)[source]¶

+
Check that the in-Config node has the named key (as an attribute)

+
+++
+
+
+



Parameters:
    
+
  • inConfig – (Config or Mapping etc) The in-Config node
    • 
+
  • key – (str) The key to check presence in in-Config node
    • 
+

+
Returns:
(RCO.ReturnCode) ‘OK’ if presence

+		
 

 
 

@@ -4785,7 +4820,7 @@ returns list year, mon, day, hour, minutes, seconds
Parameters:date -- (str) The date in format YYYYMMDD_HHMMSS
Parameters:date – (str) The date in format YYYYMMDD_HHMMSS
Returns:(tuple) as (str,str,str,str,str,str) The same date and time in separate variables.
Parameters:input_list -- (list) The list to copy
Parameters:input_list – (list) The list to copy
Returns:(list) The copy of the list
Parameters:path -- (str) The path.
Parameters:path – (str) The path.
@@ -4842,9 +4877,9 @@ to add to all paths in lpath.
Parameters:
    -
  • file_name -- (str) The file name to search
    • -
  • lpath -- (list) The list of directories where to search
    • -
  • additional_dir -- (str) The name of the additional directory
    • +
  • file_name – (str) The file name to search
    • +
  • lpath – (list) The list of directories where to search
    • +
  • additional_dir – (str) The name of the additional directory
- + @@ -4874,15 +4909,15 @@ to add to all paths in lpath.

src.utilsSat.formatValue(label, value, suffix='')[source]¶
-

format 'label = value' with the info color

+

format ‘label = value’ with the info color

Parameters:tuples -- (list) The list of tuples to format
Parameters:tuples – (list) The list of tuples to format
Returns:(str) The tabulated text. (as mutiples lines)
@@ -4898,7 +4933,7 @@ to add to all paths in lpath.

- + @@ -4917,9 +4952,9 @@ else, return the found value

@@ -4933,12 +4968,12 @@ else, return the found value

src.utilsSat.get_launcher_name(config)[source]¶
-

Returns the name of salome launcher.

+

Returns the name of application file launcher, ‘salome’ by default.

Parameters:
    -
  • label -- (int) the label to print.
    • -
  • value -- (str) the value to print.
    • -
  • suffix -- (str) the optionnal suffix to add at the end.
    • +
  • label – (int) the label to print.
    • +
  • value – (str) the value to print.
    • +
  • suffix – (str) the optionnal suffix to add at the end.
Parameters:config -- (Config) The global Config instance.
Parameters:config – (Config) The global Config instance.
Returns:(str) The path of the products base.
Parameters:
    -
  • config -- (Config) The config.
    • -
  • param_name -- (str) the name of the parameter to get the value
    • -
  • default -- (str) The value to return if param_name is not in config
    • +
  • config – (Config) The config.
    • +
  • param_name – (str) the name of the parameter to get the value
    • +
  • default – (str) The value to return if param_name is not in config
- + @@ -4954,7 +4989,7 @@ else, return the found value

- + @@ -5011,8 +5046,8 @@ else, return the found value

@@ -5023,10 +5058,20 @@ else, return the found value

Parameters:config -- (Config) The global Config instance.
Parameters:config – (Config) The global Config instance.
Returns:(str) The name of salome launcher.
Parameters:config -- (Config) The global Config instance.
Parameters:config – (Config) The global Config instance.
Returns:(str) The path of the logs.
Parameters:
    -
  • dirPath -- (str) the directory where to search the files
    • -
  • expression -- (str) the regular expression of files to find
    • +
  • dirPath – (str) the directory where to search the files
    • +
  • expression – (str) the regular expression of files to find
+
+
+src.utilsSat.log_res_step(logger, res)[source]¶
+
+ +
+
+src.utilsSat.log_step(logger, header, step)[source]¶
+
+
src.utilsSat.logger_info_tuples(logger, tuples)[source]¶
-

for convenience +

For convenience format as formatTuples() and call logger.info()

@@ -5060,7 +5105,7 @@ precedence goes to key value pairs in latter dicts.

-Parameters:date -- (str) The date to transform +Parameters:date – (str) The date to transform Returns:(str) The date in the new format @@ -5086,7 +5131,7 @@ precedence goes to key value pairs in latter dicts.

-Parameters:input_list -- (list) The list to modify +Parameters:input_list – (list) The list to modify Returns:(list) The without any item @@ -5103,9 +5148,9 @@ precedence goes to key value pairs in latter dicts.

Parameters:
    -
  • file_in -- (str) The file name
    • -
  • str_in -- (str) The string to search
    • -
  • str_out -- (str) The string to replace.
    • +
  • file_in – (str) The file name
    • +
  • str_in – (str) The string to search
    • +
  • str_out – (str) The string to replace.
@@ -5129,11 +5174,11 @@ has to be shown or not in the hat log.

Parameters:
    -
  • logFilePath -- (str) the path to the command xml log file
    • -
  • cmd -- (str) the command of the log file
    • -
  • application -- (str) +
  • logFilePath – (str) the path to the command xml log file
    • +
  • cmd – (str) the command of the log file
    • +
  • application – (str) The application passed as parameter to the salomeTools command
    • -
  • notShownCommands -- (list) +
  • notShownCommands – (list) The list of commands that are not shown by default
@@ -5162,7 +5207,7 @@ in order to be compatible with old python versions

-Parameters:timedelta -- (datetime.timedelta) +Parameters:timedelta – (datetime.timedelta) The delta between two dates Returns:(float) @@ -5182,8 +5227,8 @@ and have a name like YYYYMMDD_HHMMSS_namecmd.xml

Parameters:
    -
  • logDir -- (str) the directory to parse
    • -
  • application -- (str) the name of the application if there is any
    • +
  • logDir – (str) the directory to parse
    • +
  • application – (str) the name of the application if there is any
@@ -5217,7 +5262,7 @@ and have a name like YYYYMMDD_HHMMSS_namecmd.xml

class src.xmlManager.ReadXmlFile(filePath)[source]¶
-

Bases: object

+

Bases: object

Class to manage reading of an xml log file

@@ -5241,7 +5286,7 @@ and have a name like YYYYMMDD_HHMMSS_namecmd.xml

-Parameters:node_name -- (str) the name of the node +Parameters:node_name – (str) the name of the node Returns:(dict) the attibutes of the node node_name in self.xmlroot @@ -5258,7 +5303,7 @@ that corresponds to the parameter node

-Parameters:node -- (str) the name of the node from which get the text +Parameters:node – (str) the name of the node from which get the text Returns:(str) The text of the first node that has name @@ -5273,7 +5318,7 @@ that corresponds to the parameter node
class src.xmlManager.XmlLogFile(filePath, rootname, attrib={})[source]¶
-

Bases: object

+

Bases: object

Class to manage writing in salomeTools xml log file

@@ -5284,9 +5329,9 @@ that corresponds to the parameter node Parameters:
    -
  • node_name -- (str) the name of the node to add
    • -
  • text -- (str) the text of the node
    • -
  • attrib -- (dict) +
  • node_name – (str) the name of the node to add
    • +
  • text – (str) the text of the node
    • +
  • attrib – (dict) The dictionary containing the attribute of the new node
@@ -5304,8 +5349,8 @@ The dictionary containing the attribute of the new node Parameters:
    -
  • node_name -- (str) The name of the node on which append text
    • -
  • attrib -- (dict) The attrib to append
    • +
  • node_name – (str) The name of the node on which append text
    • +
  • attrib – (dict) The attrib to append
@@ -5322,8 +5367,8 @@ The dictionary containing the attribute of the new node Parameters:
    -
  • node_name -- (str) The name of the node on which append text
    • -
  • text -- (str) The text to append
    • +
  • node_name – (str) The name of the node on which append text
    • +
  • text – (str) The text to append
@@ -5339,7 +5384,7 @@ The dictionary containing the attribute of the new node -Parameters:stylesheet -- (str) The stylesheet to apply to the xml file +Parameters:stylesheet – (str) The stylesheet to apply to the xml file @@ -5356,11 +5401,11 @@ The dictionary containing the attribute of the new node Parameters:
    -
  • root_node -- (etree.Element) +
  • root_node – (etree.Element) the Etree element where to add the new node
    • -
  • node_name -- (str) the name of the node to add
    • -
  • text -- (str) the text of the node
    • -
  • attrib -- (dict) +
  • node_name – (str) the name of the node to add
    • +
  • text – (str) the text of the node
    • +
  • attrib – (dict) the dictionary containing the attribute(s) of the new node
@@ -5378,9 +5423,9 @@ the dictionary containing the attribute(s) of the new node Parameters:
    -
  • root_node -- (etree.Element) +
  • root_node – (etree.Element) the Etree element where to append the new attibutes
    • -
  • attrib -- (dict) The attrib to append
    • +
  • attrib – (dict) The attrib to append
@@ -5399,11 +5444,11 @@ Return the node

Parameters:
    -
  • xmlroot -- (etree.Element) +
  • xmlroot – (etree.Element) the Etree element where to search
    • -
  • name_node -- (str) the name of node to search
    • -
  • key -- (str) the key to search
    • -
  • value -- (str) the value to search
    • +
  • name_node – (str) the name of node to search
    • +
  • key – (str) the key to search
    • +
  • value – (str) the value to search
@@ -5423,9 +5468,9 @@ the Etree element where to search Parameters:
    -
  • filename -- (str) The path to the file to create
    • -
  • xmlroot -- (etree.Element) the Etree element to write to the file
    • -
  • stylesheet -- (str) The stylesheet to add to the begin of the file
    • +
  • filename – (str) The path to the file to create
    • +
  • xmlroot – (etree.Element) the Etree element to write to the file
    • +
  • stylesheet – (str) The stylesheet to add to the begin of the file
@@ -5494,18 +5539,20 @@ the Etree element where to search

This Page

@@ -5516,11 +5563,11 @@ the Etree element where to search ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source diff --git a/doc/build/html/commands/application.html b/doc/build/html/commands/application.html index a8db0e0..0e987b8 100644 --- a/doc/build/html/commands/application.html +++ b/doc/build/html/commands/application.html @@ -1,32 +1,21 @@ + - + - Command application — salomeTools 5.0.0dev documentation - - - + - + - @@ -35,8 +24,7 @@ - - +
@@ -55,36 +43,36 @@ Virtual SALOME applications are used to start SALOME when distribution is needed

Usage¶

  • Create an application:

    -
    sat application <application>
+
    sat application <application>
 
    
 
    
-
    Create the virtual application directory in the salomeTool application directory $APPLICATION.workdir.
    
+
    Create the virtual application directory in the salomeTool application directory $APPLICATION.workdir.

  • Give a name to the application:

    -
    sat application <application> --name <my_application_name>
+
    sat application <application> --name <my_application_name>
 
    
 
    
-
    Remark: this option overrides the name given in the virtual_app section of the configuration file $APPLICATION.virtual_app.name.
    
+
    Remark: this option overrides the name given in the virtual_app section of the configuration file $APPLICATION.virtual_app.name.

  • Change the directory where the application is created:

    -
    sat application <application> --target <my_application_directory>
+
    sat application <application> --target <my_application_directory>

  • Set a specific SALOME resources catalog (it will be used for the distribution of components on distant machines):

    -
    sat application <application> --catalog <path_to_catalog>
+
    sat application <application> --catalog <path_to_catalog>
 
    
 
    
 
    Note that the catalog specified will be copied to the application directory.

  • Generate the catalog for a list of machines:

    -
    sat application <application> --gencat machine1,machine2,machine3
+
    sat application <application> --gencat machine1,machine2,machine3
 
    
 
    
 
    This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.

  • Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):

    -
    sat launcher <application> --use_mesa
+
    sat launcher <application> --use_mesa
    • @@ -96,7 +84,7 @@ Virtual SALOME applications are used to start SALOME when distribution is needed
    • APPLICATION.virtual_app
      • name : name of the launcher (to replace the default runAppli).
        • -
      • application_name : (optional) the name of the virtual application directory, if missing the default value is $name + _appli.
        • +
      • application_name : (optional) the name of the virtual application directory, if missing the default value is $name + _appli.
    @@ -133,18 +121,20 @@ Virtual SALOME applications are used to start SALOME when distribution is needed

    This Page

@@ -155,11 +145,11 @@ Virtual SALOME applications are used to start SALOME when distribution is needed ©2018, CEA. | - Powered by Sphinx 1.4.9 - & Alabaster 0.7.8 + Powered by Sphinx 1.7.3 + & Alabaster 0.7.10 | - Page source diff --git a/doc/build/html/commands/clean.html b/doc/build/html/commands/clean.html index a5a37d2..61bdc22 100644 --- a/doc/build/html/commands/clean.html +++ b/doc/build/html/commands/clean.html @@ -1,32 +1,21 @@ + - + - Command clean — salomeTools 5.0.0dev documentation - - - + - + - @@ -35,8 +24,7 @@ - - +
@@ -48,20 +36,20 @@

Command clean¶

Description¶

-

The clean command removes products in the source, build, or install directories of an application. Theses directories are usually named SOURCES, BUILD, INSTALL.

+

The clean command removes products in the source, build, or install directories of an application. Theses directories are usually named SOURCES, BUILD, INSTALL.

Use the options to define what directories you want to suppress and to set the list of products

Usage¶

  • Clean all previously created build and install directories (example application as SALOME_xx):

    -
    # take care, is long time to restore, sometimes
+
    # take care, is long time to restore, sometimes
 sat clean SALOME-xx --build --install

  • Clean previously created build and install directories, only for products with property is_salome_module:

    -
    sat clean SALOME-xxx --build --install \
+
    sat clean SALOME-xxx --build --install \
                      --properties is_salome_module:yes
 
    
 
    
@@ -72,23 +60,23 @@ sat clean SALOME-xx --build --install
 
    Availables options¶
    
 
    
 
      
-
    • --products : Products to clean.
      
+
    • –products : Products to clean.
      
 
      • 
-
    • --properties :
      
+
    • –properties :
      
 
      
 
      Filter the products by their properties.
      
-
      Syntax: --properties <property>:<value>
      
+
      Syntax: –properties <property>:<value>
      
 
      
 
      • 
-
    • --sources : Clean the product source directories.
      
+
    • –sources : Clean the product source directories.
      
 
      • 
-
    • --build : Clean the product build directories.
      
+
    • –build : Clean the product build directories.
      
 
      • 
-
    • --install : Clean the product install directories.
      
+
    • –install : Clean the product install directories.
      
 
      • 
-
    • --all : Clean the product source, build and install directories.
      
+
    • –all : Clean the product source, build and install directories.
      
 
      • 
-
    • --sources_without_dev :
      
+
    • –sources_without_dev :
      
 
      
 
      Do not clean the products in development mode,
      
 
      (they could have VCS commits pending).
      
@@ -134,18 +122,20 @@ sat clean SALOME-xx --build --install
   
      
     
      This Page
      
     
    
      
 
 
         
      
@@ -156,11 +146,11 @@ sat clean SALOME-xx --build --install
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
    
 
diff --git a/doc/build/html/commands/compile.html b/doc/build/html/commands/compile.html
index 4ec8fd3..c3c5d05 100644
--- a/doc/build/html/commands/compile.html
+++ b/doc/build/html/commands/compile.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command compile — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
    
@@ -54,69 +42,69 @@
 
    Usage¶
    
 
      
 
    • Compile a complete application:
      
-
      sat compile <application>
+
      sat compile <application>
 
      
 
      
 
      • 
 
    • Compile only some products:
      
-
      sat compile <application> --products <product1>,<product2> ...
+
      sat compile <application> --products <product1>,<product2> ...
 
      
 
      
 
      • 
 
    • Use sat -t to duplicate the logs in the terminal (by default the log are stored and displayed with sat log command):
      
-
      sat -t compile <application> --products <product1>
+
      sat -t compile <application> --products <product1>
 
      
 
      
 
      • 
 
    • Compile a module and its dependencies:
      
-
      sat compile <application> --products med --with_fathers
+
      sat compile <application> --products med --with_fathers
 
      
 
      
 
      • 
 
    • Compile a module and the modules depending on it (for example plugins):
      
-
      sat compile <application> --products med --with_children
+
      sat compile <application> --products med --with_children
 
      
 
      
 
      • 
 
    • Clean the build and install directories before starting compilation:
      
-
      sat compile <application> --products GEOM  --clean_all
+
      sat compile <application> --products GEOM  --clean_all
 
      
 
      
 
      
 
      Note
      
 
      
-
      a warning will be shown if option --products is missing
      
+
      a warning will be shown if option –products is missing
      
 
      (as it will clean everything)
      
 
      
 
      
 
      • 
 
    • Clean only the install directories before starting compilation:
      
-
      sat compile <application> --clean_install
+
      sat compile <application> --clean_install
 
      
 
      
 
      • 
 
    • Add options for make:
      
-
      sat compile <application> --products <product> --make_flags <flags>
+
      sat compile <application> --products <product> --make_flags <flags>
 
      
 
      
 
      • 
-
    • Use the --check option to execute the unit tests after compilation:
      
-
      sat compile <application> --check
+
    • Use the –check option to execute the unit tests after compilation:
      
+
      sat compile <application> --check
 
      
 
      
 
      • 
 
    • Remove the build directory after successful compilation (some build directory like qt are big):
      
-
      sat compile <application> --products qt --clean_build_after
+
      sat compile <application> --products qt --clean_build_after
 
      
 
      
 
      • 
 
    • Stop the compilation as soon as the compilation of a module fails:
      
-
      sat compile <product> --stop_first_fail
+
      sat compile <product> --stop_first_fail
 
      
 
      
 
      • 
 
    • Do not compile, just show if products are installed or not, and where is the installation:
      
-
      sat compile <application> --show
+
      sat compile <application> --show
 
      
 
      
 
      • 
@@ -129,7 +117,7 @@ The main options are:
      
 
      
 
        
 
      • build_source : the method used to build the product (cmake/autotools/script)
        • 
-
      • compil_script : the compilation script if build_source is equal to "script"
        • 
+
      • compil_script : the compilation script if build_source is equal to “script”
        • 
 
      • cmake_options : additional options for cmake.
        • 
 
      • nb_proc : number of jobs to use with make for this product.
        • 
 
      
@@ -167,18 +155,20 @@ The main options are:
      
   
      
     
      This Page
      
     
    
      
 
 
         
      
@@ -189,11 +179,11 @@ The main options are:
      
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
      
 
diff --git a/doc/build/html/commands/config.html b/doc/build/html/commands/config.html
index 85e2fff..e2d8291 100644
--- a/doc/build/html/commands/config.html
+++ b/doc/build/html/commands/config.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command config — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
      
@@ -54,33 +42,33 @@ It allows display, manipulation and operation on configuration files
      
 
      
 
      Usage¶
      
 
        
-
      • Edit the user personal configuration file $HOME/.salomeTools/SAT.pyconf. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:
        
-
        sat config --edit
+
      • Edit the user personal configuration file $HOME/.salomeTools/SAT.pyconf. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:
        
+
        sat config --edit
 
        
 
        
 
        • 
-
      • List the available applications (they come from the sat projects defined in data/local.pyconf:
        
-
        sat config --list
+
      • List the available applications (they come from the sat projects defined in data/local.pyconf:
        
+
        sat config --list
 
        
 
        
 
        • 
 
      • Edit the configuration of an application:
        
-
        sat config <application> --edit
+
        sat config <application> --edit
 
        
 
        
 
        • 
 
      • Copy an application configuration file into the user personal directory:
        
-
        sat config <application> --copy [new_name]
+
        sat config <application> --copy [new_name]
 
        
 
        
 
        • 
 
      • 
 
        Print the value of a configuration parameter.
        
 
        Use the automatic completion to get recursively the parameter names.
        
-
        Use --no_label option to get only the value, without label (useful in automatic scripts).
        
+
        Use –no_label option to get only the value, without label (useful in automatic scripts).
        
 
        Examples (with SALOME-xx as SALOME-8.4.0 ):
        
 
        
-
        # sat config --value <parameter_path>
+
        # sat config --value <parameter_path>
 sat config --value .         # all the configuration
 sat config --value LOCAL
 sat config --value LOCAL.workdir
@@ -97,26 +85,26 @@ sat config SALOME-xx --no_label --value APPLICATION.workdir
 
        This is a debug mode, useful for developers.
        
 
        Prints the parameter path, the source expression if any, and the final value:
        
 
        
-
        sat config SALOME-xx -g USER
+
        sat config SALOME-xx -g USER
 
        
 
        
 
        
 
        Note
        
 
        And so, not only for fun, to get all expressions of configuration
        
-
        sat config SALOME-xx -g . | grep -e "-->"
+
        sat config SALOME-xx -g . | grep -e "-->"
 
        
 
        
 
        
 
        • 
 
      • Print the patches that are applied:
        
-
        sat config SALOME-xx --show_patchs
+
        sat config SALOME-xx --show_patchs
 
        
 
        
 
        • 
 
      • Get information on a product configuration:
        
 
        • 
 
      
-
      # sat config <application> --info <product>
+
      # sat config <application> --info <product>
 sat config SALOME-xx --info KERNEL
 sat config SALOME-xx --info qt
 
      
@@ -130,7 +118,7 @@ sat config SALOME-xx --info qt
 
    • USER: To get user preferences (editor, pdf viewer, web browser, default working dir).
      • 
 
    
 
    sat commands:
    
-
    sat config SALOME-xx -v PATHS
+
    sat config SALOME-xx -v PATHS
 sat config SALOME-xx -v USERS
 
    
 
    
@@ -167,18 +155,20 @@ sat config SALOME-xx --info qt
   
    
     
    This Page
    
     
    
    
 
 
         
    
@@ -189,11 +179,11 @@ sat config SALOME-xx --info qt
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
    
 
diff --git a/doc/build/html/commands/environ.html b/doc/build/html/commands/environ.html
index 9479ff0..7a32af2 100644
--- a/doc/build/html/commands/environ.html
+++ b/doc/build/html/commands/environ.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command environ — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
    
@@ -66,31 +54,31 @@ and saved in some files by sat environ command.
    
 
    Usage¶
    
 
      
 
    • Create the shell environment files of the application:
      
-
      sat environ <application>
+
      sat environ <application>
 
      
 
      
 
      • 
 
    • Create the environment files of the application for a given shell.
 Options are bash, bat (for windows) and cfg (the configuration format used by SALOME):
      
-
      sat environ <application> --shell [bash|cfg|all]
+
      sat environ <application> --shell [bash|cfg|all]
 
      
 
      
 
      • 
-
    • Use a different prefix for the files (default is 'env'):
      
-
      # This will create file <prefix>_launch.sh, <prefix>_build.sh
+
    • Use a different prefix for the files (default is ‘env’):
      
+
      # This will create file <prefix>_launch.sh, <prefix>_build.sh
 sat environ <application> --prefix <prefix>
 
      
 
      
 
      • 
 
    • Use a different target directory for the files:
      
-
      # This will create file env_launch.sh, env_build.sh
+
      # This will create file env_launch.sh, env_build.sh
 # in the directory corresponding to <path>
 sat environ <application> --target <path>
 
      
 
      
 
      • 
 
    • Generate the environment files only with the given products:
      
-
      # This will create the environment files only for the given products
+
      # This will create the environment files only for the given products
 # and their prerequisites.
 # It is useful when you want to visualise which environment uses
 # sat to compile a given product.
@@ -104,12 +92,12 @@ sat environ <application> --product <product1>,<product2>, ...
 
      Configuration¶
      
 
      The specification of the environment can be done through several mechanisms.
      
 
        
-
      1. For salome products (the products with the property is_SALOME_module as yes) the environment is set automatically by sat, in respect with SALOME requirements.
        2. 
+
      2. For salome products (the products with the property is_SALOME_module as yes) the environment is set automatically by sat, in respect with SALOME requirements.
        3. 
 
      3. For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
        4. 
 
      
 
      Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
-In the following example, we prepend <install_dir>/lib to LD_LIBRARY_PATH (note the left first underscore), append <install_dir>/lib to PYTHONPATH (note the right last underscore), and set LAPACK_ROOT_DIR to <install_dir>:
      
-
      environ :
+In the following example, we prepend <install_dir>/lib to LD_LIBRARY_PATH (note the left first underscore), append <install_dir>/lib to PYTHONPATH (note the right last underscore), and set LAPACK_ROOT_DIR to <install_dir>:
      
+
      environ :
 {
   _LD_LIBRARY_PATH : $install_dir + $VARS.sep + "lib"
   PYTHONPATH_ : $install_dir + $VARS.sep + "lib"
@@ -117,8 +105,8 @@ In the following example, we prepend <install_dir>/lib to }
 
      
 
      
-
      It is possible to distinguish the build environment from the launch environment: use a subsection called build or launch. In the example below, LD_LIBRARY_PATH and PYTHONPATH are only modified at run time, not at compile time:
      
-
      environ :
+
      It is possible to distinguish the build environment from the launch environment: use a subsection called build or launch. In the example below, LD_LIBRARY_PATH and PYTHONPATH are only modified at run time, not at compile time:
      
+
      environ :
 {
   build :
   {
@@ -134,9 +122,9 @@ In the following example, we prepend <install_dir>/lib to 
      
 
      
 
        
-
      1. The last possibility is to set the environment with a python script. The script should be provided in the products/env_scripts directory of the sat project, and its name is specified in the environment section with the key environ.env_script:
        2. 
+
      2. The last possibility is to set the environment with a python script. The script should be provided in the products/env_scripts directory of the sat project, and its name is specified in the environment section with the key environ.env_script:
        3. 
 
      
-
      environ :
+
      environ :
 {
   env_script : 'lapack.py'
 }
@@ -148,7 +136,7 @@ Most of the time, the first mode is sufficient.
      
 The developer implements a handle (as a python method)
 which is called by sat to set the environment.
 Here is an example:
      
-
      #!/usr/bin/env python
+
      #!/usr/bin/env python
 #-*- coding:utf-8 -*-
 
 import os.path
@@ -202,18 +190,20 @@ Here is an example:
      
   
      
     
      This Page
      
     
    
      
 
 
         
      
@@ -224,11 +214,11 @@ Here is an example:
      
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
      
 
diff --git a/doc/build/html/commands/generate.html b/doc/build/html/commands/generate.html
index f50e4a4..14f3566 100644
--- a/doc/build/html/commands/generate.html
+++ b/doc/build/html/commands/generate.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command generate — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
      
@@ -51,14 +39,14 @@
 
      The generate command generates and compile SALOME modules from cpp modules using YACSGEN.
      
 
      
 
      Note
      
-
      This command uses YACSGEN to generate the module. It needs to be specified with --yacsgen option, or defined in the product or by the environment variable $YACSGEN_ROOT_DIR.
      
+
      This command uses YACSGEN to generate the module. It needs to be specified with –yacsgen option, or defined in the product or by the environment variable $YACSGEN_ROOT_DIR.
      
 
      
 
      
 
      
 
      Remarks¶
      
 
        
 
      • This command will only apply on the CPP modules of the application, those who have both properties:
        
-
        cpp : "yes"
+
        cpp : "yes"
 generate : "yes"
 
        
 
        
@@ -71,18 +59,18 @@
 
        Usage¶
        
 
          
 
        • Generate all the modules of a product:
          
-
          sat generate <application>
+
          sat generate <application>
 
          
 
          
 
          • 
 
        • Generate only specific modules:
          
-
          sat generate <application> --products <list_of_products>
+
          sat generate <application> --products <list_of_products>
 
          
 
          
-
          Remark: modules which don't have the generate property are ignored.
          
+
          Remark: modules which don’t have the generate property are ignored.
          
 
          • 
 
        • Use a specific version of YACSGEN:
          
-
          sat generate <application> --yacsgen <path_to_yacsgen>
+
          sat generate <application> --yacsgen <path_to_yacsgen>
 
          
 
          
 
          • 
@@ -120,18 +108,20 @@
   
          
     
          This Page
          
     
    
          
 
 
         
        
@@ -142,11 +132,11 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
        
 
diff --git a/doc/build/html/commands/launcher.html b/doc/build/html/commands/launcher.html
index 5122d80..1b3aaf2 100644
--- a/doc/build/html/commands/launcher.html
+++ b/doc/build/html/commands/launcher.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command launcher — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
        
@@ -54,31 +42,31 @@
 
        Usage¶
        
 
          
 
        • Create a launcher:
          
-
          sat launcher <application>
+
          sat launcher <application>
 
          
 
          
-
          Generate a launcher in the application directory, i.e $APPLICATION.workdir.
          
+
          Generate a launcher in the application directory, i.e $APPLICATION.workdir.
          
 
          • 
-
        • Create a launcher with a given name (default name is APPLICATION.profile.launcher_name)
          
-
          sat launcher <application> --name ZeLauncher
+
        • Create a launcher with a given name (default name is APPLICATION.profile.launcher_name)
          
+
          sat launcher <application> --name ZeLauncher
 
          
 
          
 
          The launcher will be called ZeLauncher.
          
 
          • 
 
        • Set a specific resources catalog:
          
-
          sat launcher <application>  --catalog  <path of a salome resources catalog>
+
          sat launcher <application>  --catalog  <path of a salome resources catalog>
 
          
 
          
 
          Note that the catalog specified will be copied to the profile directory.
          
 
          • 
 
        • Generate the catalog for a list of machines:
          
-
          sat launcher <application> --gencat <list of machines>
+
          sat launcher <application> --gencat <list of machines>
 
          
 
          
 
          This will create a catalog by querying each machine (memory, number of processor) with ssh.
          
 
          • 
 
        • Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
          
-
          sat launcher <application> --use_mesa
+
          sat launcher <application> --use_mesa
 
          
 
          
 
          • 
@@ -127,18 +115,20 @@
   
          
     
          This Page
          
     
    
          
 
 
         
          
@@ -149,11 +139,11 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
          
 
diff --git a/doc/build/html/commands/log.html b/doc/build/html/commands/log.html
index ff1b922..11da33c 100644
--- a/doc/build/html/commands/log.html
+++ b/doc/build/html/commands/log.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command log — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
          
@@ -54,32 +42,32 @@
 
          Usage¶
          
 
            
 
          • Show (in a web browser) the log of the commands corresponding to an application:
            
-
            sat log <application>
+
            sat log <application>
 
            
 
            
 
            • 
 
          • Show the log for commands that do not use any application:
            
-
            sat log
+
            sat log
 
            
 
            
 
            • 
-
          • The --terminal (or -t) display the log directly in the terminal, through a CLI interactive menu:
            
-
            sat log <application> --terminal
+
          • The –terminal (or -t) display the log directly in the terminal, through a CLI interactive menu:
            
+
            sat log <application> --terminal
 
            
 
            
 
            • 
-
          • The --last option displays only the last command:
            
-
            sat log <application> --last
+
          • The –last option displays only the last command:
            
+
            sat log <application> --last
 
            
 
            
 
            • 
-
          • To access the last compilation log in terminal mode, use --last_terminal option:
            
-
            sat log <application> --last_terminal
+
          • To access the last compilation log in terminal mode, use –last_terminal option:
            
+
            sat log <application> --last_terminal
 
            
 
            
 
            • 
-
          • The --clean (int) option erases the n older log files and print the number of remaining log files:
            
-
            sat log <application> --clean 50
+
          • The –clean (int) option erases the n older log files and print the number of remaining log files:
            
+
            sat log <application> --clean 50
 
            
 
            
 
            • 
@@ -127,18 +115,20 @@
   
            
     
            This Page
            
     
    
            
 
 
         
            
@@ -149,11 +139,11 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/html/commands/package.html b/doc/build/html/commands/package.html
index 56cac93..8ef7236 100644
--- a/doc/build/html/commands/package.html
+++ b/doc/build/html/commands/package.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command package — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
            
@@ -56,35 +44,35 @@ of SALOME products and prerequisites.
            
 
            
 
            Note
            
 
            By default the package includes the sources of prerequisites and products.
-To select a subset use the --without_property or --with_vcs options.
            
+To select a subset use the –without_property or –with_vcs options.
            
 
            
 
            
 
            
 
            Usage¶
            
 
              
 
            • Create a package for a product (example as SALOME_xx):
              
-
              sat package SALOME_xx
+
              sat package SALOME_xx
 
              
 
              
-
              This command will create an archive named SALOME_xx.tgz
-in the working directory (USER.workDir).
+
              This command will create an archive named SALOME_xx.tgz
+in the working directory (USER.workDir).
 If the archive already exists, do nothing.
              
 
              • 
 
            • Create a package with a specific name:
              
-
              sat package SALOME_xx --name YourSpecificName
+
              sat package SALOME_xx --name YourSpecificName
 
              
 
              
 
              • 
 
            
 
            
 
            Note
            
-
            By default, the archive is created in the working directory of the user (USER.workDir).
            
-
            If the option --name is used with a path (relative or absolute) it will be used.
            
-
            If the option --name is not used and binaries (prerequisites and products)
+
            By default, the archive is created in the working directory of the user (USER.workDir).
            
+
            If the option –name is used with a path (relative or absolute) it will be used.
            
+
            If the option –name is not used and binaries (prerequisites and products)
 are included in the package, the OS architecture
-will be appended to the name (example: SALOME_xx-CO7.tgz).
            
+will be appended to the name (example: SALOME_xx-CO7.tgz).
            
 
            Examples:
            
-
            # Creates SALOME_xx.tgz in $USER.workDir
+
            # Creates SALOME_xx.tgz in $USER.workDir
 sat package SALOME_xx
 
 # Creates SALOME_xx_<arch>.tgz in $USER.workDir
@@ -97,19 +85,19 @@ will be appended to the name (example: 
 
              
 
            • Force the creation of the archive (if it already exists):
              
-
              sat package SALOME_xx --force
+
              sat package SALOME_xx --force
 
              
 
              
 
              • 
 
            • Include the binaries in the archive (products and prerequisites):
              
-
              sat package SALOME_xx --binaries
+
              sat package SALOME_xx --binaries
 
              
 
              
-
              This command will create an archive named SALOME_xx _<arch>.tgz
+
              This command will create an archive named SALOME_xx _<arch>.tgz
 where <arch> is the OS architecture of the machine.
              
 
              • 
 
            • Do not delete Version Control System (VCS) informations from the configurations files of the embedded salomeTools:
              
-
              sat package SALOME_xx --with_vcs
+
              sat package SALOME_xx --with_vcs
 
              
 
              
 
              The version control systems known by this option are CVS, SVN and Git.
              
@@ -152,18 +140,20 @@ where <arch> is the 
     
              This Page
              
                   
    
              
 
 
         
              
@@ -174,11 +164,11 @@ where <arch> is the Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/html/commands/prepare.html b/doc/build/html/commands/prepare.html
index 6b93937..ea6379f 100644
--- a/doc/build/html/commands/prepare.html
+++ b/doc/build/html/commands/prepare.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Command prepare — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
            
@@ -79,7 +67,7 @@ without any link to the VCS base.
 To perform a checkout (svn, cvs) or a git clone (git),
 you need to declare the product in dev mode in your application configuration:
 edit the application configuration file (pyconf) and modify the product declaration:
            
-
            sat config <application> -e
+
            sat config <application> -e
 # and edit the product section:
 #   <product> : {tag : "my_tag", dev : "yes", debug : "yes"}
 
            
@@ -98,24 +86,24 @@ not be altered/removed (Unless you use -f option)
            
 
            Usage¶
            
 
              
 
            • Prepare the sources of a complete application in SOURCES directory (all products):
              
-
              sat prepare <application>
+
              sat prepare <application>
 
              
 
              
 
              • 
 
            • Prepare only some modules:
              
-
              sat prepare <application>  --products <product1>,<product2> ...
+
              sat prepare <application>  --products <product1>,<product2> ...
 
              
 
              
 
              • 
-
            • Use --force to force to prepare the products in development mode
+
            • Use –force to force to prepare the products in development mode
 (this will remove the sources and do a new clone/checkout):
              
-
              sat prepare <application> --force
+
              sat prepare <application> --force
 
              
 
              
 
              • 
-
            • Use --force_patch to force to apply patch to the products
+
            • Use –force_patch to force to apply patch to the products
 in development mode (otherwise they are not applied):
              
-
              sat prepare <application> --force_patch
+
              sat prepare <application> --force_patch
 
              
 
              
 
              • 
@@ -127,7 +115,7 @@ in development mode (otherwise they are not applied):
              
 
              
 
              Note
              
 
              to verify configuration of a product, and get name of this pyconf files configuration
              
-
              sat config <application> --info <product>
+
              sat config <application> --info <product>
 
              
 
              
 
              
@@ -177,18 +165,20 @@ in development mode (otherwise they are not applied):
              
   
              
     
              This Page
              
     
    
              
 
 
         
              
@@ -199,11 +189,11 @@ in development mode (otherwise they are not applied):
              
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
              
 
diff --git a/doc/build/html/configuration.html b/doc/build/html/configuration.html
index d973f33..18c8654 100644
--- a/doc/build/html/configuration.html
+++ b/doc/build/html/configuration.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Configuration — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
              
@@ -58,12 +46,12 @@ Then, this object is passed to all command scripts.
              
 
            • {} define a dictionary,
              • 
 
            • [] define a list,
              • 
 
            • @ can be used to include a file,
              • 
-
            • $prefix reference to another parameter (ex: $PRODUCT.name),
              • 
+
            • $prefix reference to another parameter (ex: $PRODUCT.name),
              • 
 
            • # comments.
              • 
 
            
 
            
 
            Note
            
-
            in this documentation a reference to a configuration parameter will be noted XXX.YYY.
            
+
            in this documentation a reference to a configuration parameter will be noted XXX.YYY.
            
 
            
 
            
 
            
@@ -74,7 +62,7 @@ Then, this object is passed to all command scripts.
            
 
            This section is dynamically created by salomeTools at run time.
            
 
            It contains information about the environment: date, time, OS, architecture etc.
            
 
            
-
            # to get the current setting
+
            # to get the current setting
 sat config --value VARS
 
            
 
            
@@ -85,7 +73,7 @@ Then, this object is passed to all command scripts.
            
 
            This section is defined in the product file.
            
 
            It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
            
 
            
-
            # to get the current setting
+
            # to get the current setting
 sat config SALOME-xx --value PRODUCTS
 
            
 
            
@@ -96,7 +84,7 @@ Then, this object is passed to all command scripts.
            
 
            This section is optional, it is also defined in the product file.
            
 
            It gives additional parameters to create an application based on SALOME, as versions of products to use.
            
 
            
-
            # to get the current setting
+
            # to get the current setting
 sat config SALOME-xx --value APPLICATION
 
            
 
            
@@ -104,8 +92,8 @@ Then, this object is passed to all command scripts.
            
 
            
 
            USER section¶
            
 
            This section is defined by the user configuration file,
-~/.salomeTools/salomeTools.pyconf.
            
-
            The USER section defines some parameters (not exhaustive):
            
+~/.salomeTools/salomeTools.pyconf.
            
+
            The USER section defines some parameters (not exhaustive):
            
 
              
 
            • workDir :
              
 
              
@@ -122,7 +110,7 @@ Then, this object is passed to all command scripts.
              
 
            • and other user preferences.
              
 
              • 
 
            
-
            # to get the current setting
+
            # to get the current setting
 sat config SALOME-xx --value USER
 
            
 
            
@@ -165,18 +153,20 @@ Then, this object is passed to all command scripts.
            
   
            
     
            This Page
            
     
    
            
 
 
         
            
@@ -187,11 +177,11 @@ Then, this object is passed to all command scripts.
            
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html
index d709893..a120703 100644
--- a/doc/build/html/genindex.html
+++ b/doc/build/html/genindex.html
@@ -1,41 +1,29 @@
 
+
 
 
-
 
   
+    
     
-    
     Index — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
    
   
   
   
   
 
-  
-  
+  
   
 
     
            
@@ -75,4117 +63,2205 @@
 
            
 
            A
            
 
-  
-  
+  
+  
            
-      
-  
            add() (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-      
-  
            add_comment() (src.environment.SalomeEnviron method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.BatFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            add_compile_config_file() (in module commands.compile)
-  
            
-
-      
-  
            add_echo() (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            add_files() (in module commands.package)
-  
            
-
-      
-  
            add_line() (src.environment.SalomeEnviron method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            add_module_to_appli() (in module commands.application)
-  
            
-
-      
-  
            add_option() (src.options.Options method)
-  
            
-
-      
-  
            add_readme() (in module commands.package)
-  
            
-
-      
-  
            add_salomeTools() (in module commands.package)
-  
            
-
-      
-  
            add_simple_node() (in module src.xmlManager)
-  
            
-
-      
            
-        
-  
            (src.xmlManager.XmlLogFile method)
-  
            
-
-      
            
-      
-  
            add_warning() (src.environment.SalomeEnviron method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            add_xml_board() (commands.jobs.Gui method)
-  
            
-
-      
-  
            addElement() (src.pyconf.Reference method)
-  
            
-
-  
            
-      
-  
            addMapping() (src.pyconf.Mapping method)
-  
            
-
-      
-  
            addNamespace() (src.pyconf.Config method)
-  
            
-
-      
-  
            ANSI_CSI_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)
-  
            
-
-      
-  
            ANSI_OSC_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)
-  
            
-
-      
-  
            AnsiBack (class in src.colorama.ansi)
-  
            
-
-      
-  
            AnsiCodes (class in src.colorama.ansi)
-  
            
-
-      
-  
            AnsiCursor (class in src.colorama.ansi)
-  
            
-
-      
-  
            AnsiFore (class in src.colorama.ansi)
-  
            
-
-      
-  
            AnsiStyle (class in src.colorama.ansi)
-  
            
-
-      
-  
            AnsiToWin32 (class in src.colorama.ansitowin32)
-  
            
-
-      
-  
            append() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.environment.SalomeEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-        
-  
            (src.pyconf.Sequence method)
-  
            
-
-      
            
-      
-  
            append_node_attrib() (in module src.xmlManager)
-  
            
-
-      
            
-        
-  
            (src.xmlManager.XmlLogFile method)
-  
            
-
-      
            
-      
-  
            append_node_text() (src.xmlManager.XmlLogFile method)
-  
            
-
-      
-  
            append_value() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-      
            
-      
-  
            apply_patch() (in module commands.patch)
-  
            
-
-      
-  
            archive_extract() (in module src.system)
-  
            
-
-      
-  
            ask_a_path() (in module commands.test)
-  
            
-
-      
-  
            ask_value() (in module commands.log)
-  
            
-
-      
-  
            assumeAsList() (in module src.salomeTools)
-  
            
-
-      
            
-        
-  
            (src.salomeTools.Sat method)
-  
            
-
-      
            
-  
            		
 
            
 
 
            B
            
 
-  
-  
+  
+  
            
-      
-  
            BACK() (src.colorama.ansi.AnsiCursor method)
-  
            
-
-      
-  
            back() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            base() (src.utilsSat.Path method)
-  
            
-
-      
-  
            BashFileEnviron (class in src.fileEnviron)
-  
            
-
-      
-  
            batch() (in module src.fork)
-  
            
-
-      
-  
            batch_salome() (in module src.fork)
-  
            
-
-      
-  
            BatFileEnviron (class in src.fileEnviron)
-  
            
-
-      
-  
            binary_package() (in module commands.package)
-  
            
-
-      
-  
            BLACK (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-  
            
-      
-  
            black() (in module src.utilsSat)
-  
            
-
-      
-  
            BLUE (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-      
-  
            blue() (in module src.utilsSat)
-  
            
-
-      
-  
            BRIGHT (src.colorama.ansi.AnsiStyle attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.winterm.WinStyle attribute)
-  
            
-
-      
            
-      
-  
            BRIGHT_BACKGROUND (src.colorama.winterm.WinStyle attribute)
-  
            
-
-      
-  
            build_configure() (src.compilation.Builder method)
-  
            
-
-      
-  
            build_context() (in module commands.generate)
-  
            
-
-      
-  
            Builder (class in src.compilation)
-  
            
-
-  
            		
 
            
 
 
            C
            
 
-  
+  
+
            
-      
-  
            call_win32() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            cancel() (commands.jobs.Job method)
-  
            
-
-      
-  
            cancel_dependencies_of_failing_jobs() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            CatchAll (class in src.catchAll)
-  
            
-
-      
-  
            change_to_launcher() (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-      
-  
            check() (src.compilation.Builder method)
-  
            
-
-      
-  
            check_all_products() (in module commands.check)
-  
            
-
-      
-  
            check_config_exists() (in module src.product)
-  
            
-
-      
-  
            check_config_has_application() (in module src.utilsSat)
-  
            
-
-      
-  
            check_config_has_profile() (in module src.utilsSat)
-  
            
-
-      
-  
            check_dependencies() (in module commands.compile)
-  
            
-
-      
-  
            check_file_for_substitution() (commands.template.TemplateSettings method)
-  
            
-
-      
-  
            check_installation() (in module src.product)
-  
            
-
-      
-  
            check_module_generator() (in module commands.generate)
-  
            
-
-      
-  
            check_option() (commands.test.Command method)
-  
            
-
-      
-  
            check_path() (in module commands.init)
-  
            
-
-      
            
-        
-  
            (in module src.configManager)
-  
            
-
-      
            
-      
-  
            check_product() (in module commands.check)
-  
            
-
-      
-  
            check_remote_machine() (in module commands.test)
-  
            
-
-      
-  
            check_sources() (in module commands.source)
-  
            
-
-      
-  
            check_time() (commands.jobs.Job method)
-  
            
-
-      
-  
            check_user_values() (commands.template.TemplateSettings method)
-  
            
-
-      
-  
            check_value() (commands.template.TParam method)
-  
            
-
-      
-  
            check_yacsgen() (in module commands.generate)
-  
            
-
-      
-  
            chmod() (src.utilsSat.Path method)
-  
            
+  
            
 
-      
-  
            cleanColors() (in module src.coloringSat)
-  
            
+
            D
            
+
+  
+  
+
            
 
-      
-  
            clear_line() (in module src.colorama.ansi)
-  
            
+
            E
            
+
+  
+  
+
            
 
-      
-  
            clear_screen() (in module src.colorama.ansi)
-  
            
+
            F
            
+
+  
+  
+
            
 
-      
-  
            close() (commands.jobs.Machine method)
-  
            
+
            G
            
+
+  
+  
+
            
 
-      
            
-        
-  
            (src.ElementTree.TreeBuilder method)
-  
            
+
            H
            
+
+  
+  
+
            
 
-        
-  
            (src.ElementTree.XMLTreeBuilder method)
-  
            
+
            I
            
+
+  
+  
+
            
 
-        
-  
            (src.debug.OutStream method)
-  
            
+
            J
            
+
+  
+  
+
            
 
-        
-  
            (src.pyconf.ConfigInputStream method)
-  
            
+
            K
            
+
+  
+  
+
            
 
-        
-  
            (src.pyconf.ConfigOutputStream method)
-  
            
+
            L
            
+
+  
+  
+
            
 
-      
            
-      
-  
            cmake() (src.compilation.Builder method)
-  
            
+
            M
            
+
+  
+  
+
            
 
-      
-  
            code_to_chars() (in module src.colorama.ansi)
-  
            
+
            N
            
+
+  
+  
+
            
 
-      
-  
            colorama_text() (in module src.colorama.initialise)
-  
            
+
            O
            
+
+  
+  
+
            
 
-      
-  
            ColoringStream (class in src.coloringSat)
-  
            
+
            P
            
+
+  
+  
+
            
 
-      
-  
            Command (class in commands.application)
-  
            
+
            Q
            
+
+  
+
            
 
-      
            
-        
-  
            (class in commands.check)
-  
            
+
            R
            
+
+  
+  
+
            
 
-        
-  
            (class in commands.clean)
-  
            
+
            S
            
+
+  
+  
+
            
 
-        
-  
            (class in commands.compile)
-  
            
+
            T
            
+
+  
+  
+
            
 
-        
-  
            (class in commands.config)
-  
            
+
            U
            
+
+  
+  
+
            
 
-        
-  
            (class in commands.configure)
-  
            
+
            W
            
+
+  
+  
+
            
 
-        
-  
            (class in commands.environ)
-  
            
+
            X
            
+
+  
+  
+
            
 
-        
-  
            (class in commands.find_duplicates)
-  
            
-
-        
-  
            (class in commands.generate)
-  
            
-
-        
-  
            (class in commands.init)
-  
            
-
-        
-  
            (class in commands.job)
-  
            
-
-        
-  
            (class in commands.jobs)
-  
            
-
-        
-  
            (class in commands.launcher)
-  
            
-
-        
-  
            (class in commands.log)
-  
            
-
-        
-  
            (class in commands.make)
-  
            
-
-        
-  
            (class in commands.makeinstall)
-  
            
-
-        
-  
            (class in commands.package)
-  
            
-
-        
-  
            (class in commands.patch)
-  
            
-
-        
-  
            (class in commands.prepare)
-  
            
-
-        
-  
            (class in commands.profile)
-  
            
-
-        
-  
            (class in commands.run)
-  
            
-
-        
-  
            (class in commands.script)
-  
            
-
-        
-  
            (class in commands.shell)
-  
            
-
-        
-  
            (class in commands.source)
-  
            
-
-        
-  
            (class in commands.template)
-  
            
-
-        
-  
            (class in commands.test)
-  
            
-
-      
            
-      
-  
            command_value() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.BashFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.BatFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            commands (module)
-  
            
-
-  
-  
            
-      
-  
            commands.application (module)
-  
            
-
-      
-  
            commands.check (module)
-  
            
-
-      
-  
            commands.clean (module)
-  
            
-
-      
-  
            commands.compile (module)
-  
            
-
-      
-  
            commands.config (module)
-  
            
-
-      
-  
            commands.configure (module)
-  
            
-
-      
-  
            commands.environ (module)
-  
            
-
-      
-  
            commands.find_duplicates (module)
-  
            
-
-      
-  
            commands.generate (module)
-  
            
-
-      
-  
            commands.init (module)
-  
            
-
-      
-  
            commands.job (module)
-  
            
-
-      
-  
            commands.jobs (module)
-  
            
-
-      
-  
            commands.launcher (module)
-  
            
-
-      
-  
            commands.log (module)
-  
            
-
-      
-  
            commands.make (module)
-  
            
-
-      
-  
            commands.makeinstall (module)
-  
            
-
-      
-  
            commands.package (module)
-  
            
-
-      
-  
            commands.patch (module)
-  
            
-
-      
-  
            commands.prepare (module)
-  
            
-
-      
-  
            commands.profile (module)
-  
            
-
-      
-  
            commands.run (module)
-  
            
-
-      
-  
            commands.script (module)
-  
            
-
-      
-  
            commands.shell (module)
-  
            
-
-      
-  
            commands.source (module)
-  
            
-
-      
-  
            commands.template (module)
-  
            
-
-      
-  
            commands.test (module)
-  
            
-
-      
-  
            Comment() (in module src.ElementTree)
-  
            
-
-      
-  
            compile_all_products() (in module commands.compile)
-  
            
-
-      
-  
            compile_product() (in module commands.compile)
-  
            
-
-      
-  
            compile_product_cmake_autotools() (in module commands.compile)
-  
            
-
-      
-  
            compile_product_script() (in module commands.compile)
-  
            
-
-      
-  
            complete_environment() (src.compilation.Builder method)
-  
            
-
-      
-  
            Config (class in src.pyconf)
-  
            
-
-      
-  
            Config.Namespace (class in src.pyconf)
-  
            
-
-      
-  
            config_has_application() (in module src.utilsSat)
-  
            
-
-      
-  
            ConfigError
-  
            
-
-      
-  
            ConfigFormatError
-  
            
-
-      
-  
            ConfigInputStream (class in src.pyconf)
-  
            
-
-      
-  
            ConfigList (class in src.pyconf)
-  
            
-
-      
-  
            ConfigManager (class in src.configManager)
-  
            
-
-      
-  
            ConfigMerger (class in src.pyconf)
-  
            
-
-      
-  
            ConfigOpener (class in src.configManager)
-  
            
-
-      
-  
            ConfigOutputStream (class in src.pyconf)
-  
            
-
-      
-  
            ConfigReader (class in src.pyconf)
-  
            
-
-      
-  
            ConfigResolutionError
-  
            
-
-      
-  
            configure() (src.compilation.Builder method)
-  
            
-
-      
-  
            configure_all_products() (in module commands.configure)
-  
            
-
-      
-  
            configure_product() (in module commands.configure)
-  
            
-
-      
-  
            connect() (commands.jobs.Machine method)
-  
            
-
-      
-  
            Container (class in src.pyconf)
-  
            
-
-      
-  
            ContextFileEnviron (class in src.fileEnviron)
-  
            
-
-      
-  
            convert_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            convert_osc() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            copy() (src.utilsSat.Path method)
-  
            
-
-      
-  
            copy_catalog() (in module commands.launcher)
-  
            
-
-      
-  
            copy_sat() (commands.jobs.Machine method)
-  
            
-
-      
-  
            copydir() (src.utilsSat.Path method)
-  
            
-
-      
-  
            copyfile() (src.utilsSat.Path method)
-  
            
-
-      
-  
            copylink() (src.utilsSat.Path method)
-  
            
-
-      
-  
            create_application() (in module commands.application)
-  
            
-
-      
-  
            create_config_file() (in module commands.application)
-  
            
-
-      
            
-        
-  
            (src.configManager.ConfigManager method)
-  
            
-
-      
            
-      
-  
            create_project_for_src_package() (in module commands.package)
-  
            
-
-      
-  
            create_test_report() (in module commands.test)
-  
            
-
-      
-  
            critical() (in module src.utilsSat)
-  
            
-
-      
-  
            cursor_adjust() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            customize_app() (in module commands.application)
-  
            
-
-      
-  
            cvs_extract() (in module src.system)
-  
            
-
-      
-  
            CYAN (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-      
-  
            cyan() (in module src.utilsSat)
-  
            
-
-  
            
-
-
-
            D
            
-
-  
-  
-
            
-      
-  
            data() (src.ElementTree.TreeBuilder method)
-  
            
-
-      
-  
            date_to_datetime() (in module src.utilsSat)
-  
            
-
-      
-  
            debug_write() (src.options.Options method)
-  
            
-
-      
-  
            deepcopy_list() (in module src.utilsSat)
-  
            
-
-      
-  
            deepCopyMapping() (in module src.pyconf)
-  
            
-
-      
-  
            DefaultFormatter (class in src.loggingSat)
-  
            
-
-      
-  
            defaultMergeResolve() (in module src.pyconf)
-  
            
-
-      
-  
            defaultStreamOpener() (in module src.pyconf)
-  
            
-
-      
-  
            define_job() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            deinit() (in module src.colorama.initialise)
-  
            
-
-      
-  
            delimiter (src.template.MyTemplate attribute)
-  
            
-
-      
-  
            determine_jobs_and_machines() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            develop_factorized_jobs() (in module commands.jobs)
-  
            
-
-      
-  
            DIM (src.colorama.ansi.AnsiStyle attribute)
-  
            
-
-  
            
-      
-  
            dir() (src.utilsSat.Path method)
-  
            
-
-      
-  
            dirLogger() (in module src.loggingSat)
-  
            
-
-      
-  
            display_local_values() (in module commands.init)
-  
            
-
-      
-  
            display_status() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            display_value_progression() (commands.find_duplicates.Progress_bar method)
-  
            
-
-      
-  
            do_batch_script_build() (src.compilation.Builder method)
-  
            
-
-      
-  
            do_default_build() (src.compilation.Builder method)
-  
            
-
-      
-  
            do_python_script_build() (src.compilation.Builder method)
-  
            
-
-      
-  
            do_script_build() (src.compilation.Builder method)
-  
            
-
-      
-  
            doctype() (src.ElementTree.XMLTreeBuilder method)
-  
            
-
-      
-  
            DOWN() (src.colorama.ansi.AnsiCursor method)
-  
            
-
-      
-  
            dump() (in module src.ElementTree)
-  
            
-
-      
            
-        
-  
            (src.environment.SalomeEnviron method)
-  
            
-
-      
            
-      
-  
            dumper() (in module src.catchAll)
-  
            
-
-      
-  
            dumperType() (in module src.catchAll)
-  
            
-
-  
            
-
-
            E
            
-
-  
-  
-
            
-      
-  
            Element() (in module src.ElementTree)
-  
            
-
-      
-  
            ElementTree (class in src.ElementTree)
-  
            
-
-      
-  
            end() (src.ElementTree.TreeBuilder method)
-  
            
-
-      
-  
            ensure_path_exists() (in module src.utilsSat)
-  
            
-
-      
-  
            Environ (class in src.environment)
-  
            
-
-      
-  
            erase_line() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            erase_screen() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            error() (in module src.utilsSat)
-  
            
-
-      
-  
            evaluate() (src.pyconf.Container method)
-  
            
-
-      
            
-        
-  
            (src.pyconf.Expression method)
-  
            
-
-      
            
-  
            
-      
-  
            ExceptionSat
-  
            
-
-      
-  
            exclude_VCS_and_extensions() (in module commands.package)
-  
            
-
-      
-  
            exec_command() (commands.jobs.Machine method)
-  
            
-
-      
-  
            execute_cli() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            exists() (src.utilsSat.Path method)
-  
            
-
-      
-  
            Expression (class in src.pyconf)
-  
            
-
-      
-  
            extend_with_children() (in module commands.compile)
-  
            
-
-      
-  
            extend_with_fathers() (in module commands.compile)
-  
            
-
-      
-  
            extract_params() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-  
            
-
-
            F
            
-
-  
-  
-
            
-      
-  
            feed() (src.ElementTree.XMLTreeBuilder method)
-  
            
-
-      
-  
            FileEnviron (class in src.fileEnviron)
-  
            
-
-      
-  
            FileEnvWriter (class in src.environment)
-  
            
-
-      
-  
            find() (src.ElementTree.ElementTree method)
-  
            
-
-      
-  
            find_application_pyconf() (in module commands.package)
-  
            
-
-      
-  
            find_command_list() (in module src.salomeTools)
-  
            
-
-      
-  
            find_file_in_lpath() (in module src.utilsSat)
-  
            
-
-      
-  
            find_history() (commands.jobs.Gui method)
-  
            
-
-      
-  
            find_job_that_has_name() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            find_node_by_attrib() (in module src.xmlManager)
-  
            
-
-      
-  
            find_product_scripts_and_pyconf() (in module commands.package)
-  
            
-
-      
-  
            find_products_already_getted() (in module commands.prepare)
-  
            
-
-      
-  
            find_products_with_patchs() (in module commands.prepare)
-  
            
-
-      
-  
            find_test_log() (commands.jobs.Gui method)
-  
            
-
-      
-  
            findall() (src.ElementTree.ElementTree method)
-  
            
-
-      
-  
            findConfig() (src.pyconf.Reference method)
-  
            
-
-      
-  
            findtext() (src.ElementTree.ElementTree method)
-  
            
-
-      
-  
            finish() (src.environment.SalomeEnviron method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.BashFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.BatFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-      
            
-  
            
-      
-  
            flush() (src.coloringSat.ColoringStream method)
-  
            
-
-      
            
-        
-  
            (src.loggingSat.UnittestStream method)
-  
            
-
-        
-  
            (src.pyconf.ConfigOutputStream method)
-  
            
-
-      
            
-      
-  
            fore() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            format() (src.example.essai_logging_2.MyFormatter method)
-  
            
-
-      
            
-        
-  
            (src.loggingSat.DefaultFormatter method)
-  
            
-
-        
-  
            (src.loggingSat.UnittestFormatter method)
-  
            
-
-      
            
-      
-  
            format_color_exception() (in module src.debug)
-  
            
-
-      
-  
            format_list_of_str() (in module commands.find_duplicates)
-  
            
-
-      
-  
            formatTuples() (in module src.utilsSat)
-  
            
-
-      
-  
            formatValue() (in module src.utilsSat)
-  
            
-
-      
-  
            FORWARD() (src.colorama.ansi.AnsiCursor method)
-  
            
-
-      
-  
            fromstring() (in module src.ElementTree)
-  
            
-
-  
            
-
-
            G
            
-
-  
-  
-
            
-      
-  
            generate_application() (in module commands.application)
-  
            
-
-      
-  
            generate_catalog() (in module commands.application)
-  
            
-
-      
            
-        
-  
            (in module commands.launcher)
-  
            
-
-      
            
-      
-  
            generate_component() (in module commands.generate)
-  
            
-
-      
-  
            generate_component_list() (in module commands.generate)
-  
            
-
-      
-  
            generate_history_xml_path() (in module commands.test)
-  
            
-
-      
-  
            generate_launch_file() (in module commands.application)
-  
            
-
-      
            
-        
-  
            (in module commands.launcher)
-  
            
-
-      
            
-      
-  
            generate_launching_commands() (src.test_module.Test method)
-  
            
-
-      
-  
            generate_profile_sources() (in module commands.profile)
-  
            
-
-      
-  
            generate_script() (src.test_module.Test method)
-  
            
-
-      
-  
            get() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.environment.SalomeEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.BatFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-        
-  
            (src.pyconf.Mapping method)
-  
            
-
-      
            
-      
-  
            get_all_product_sources() (in module commands.source)
-  
            
-
-      
-  
            get_archives() (in module commands.package)
-  
            
-
-      
-  
            get_archives_vcs() (in module commands.package)
-  
            
-
-      
-  
            get_attrib() (src.xmlManager.ReadXmlFile method)
-  
            
-
-      
-  
            get_attrs() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            get_base_install_dir() (in module src.product)
-  
            
-
-      
-  
            get_base_path() (in module src.utilsSat)
-  
            
-
-      
-  
            get_build_directories() (in module commands.clean)
-  
            
-
-      
-  
            get_cfg_param() (in module src.utilsSat)
-  
            
-
-      
-  
            get_children() (in module commands.compile)
-  
            
-
-      
-  
            get_command_line_overrides() (src.configManager.ConfigManager method)
-  
            
-
-      
-  
            get_config() (src.configManager.ConfigManager method)
-  
            
-
-      
-  
            get_config_children() (in module src.configManager)
-  
            
-
-      
-  
            get_config_file_path() (in module commands.jobs)
-  
            
-
-      
-  
            get_dico_param() (in module commands.template)
-  
            
-
-      
-  
            get_distrib_version() (in module src.architecture)
-  
            
-
-      
-  
            get_distribution() (in module src.architecture)
-  
            
-
-      
-  
            get_file_environ() (in module src.fileEnviron)
-  
            
-
-      
-  
            get_help() (src.options.Options method)
-  
            
-
-      
            
-        
-  
            (src.salomeTools.Sat method)
-  
            
-
-      
            
-      
-  
            get_install_dir() (in module src.product)
-  
            
-
-      
-  
            get_install_directories() (in module commands.clean)
-  
            
-
-      
-  
            get_last_log_file() (in module commands.log)
-  
            
-
-      
-  
            get_launcher_name() (in module src.utilsSat)
-  
            
-
-      
-  
            get_log_files() (commands.jobs.Job method)
-  
            
-
-      
-  
            get_log_path() (in module src.utilsSat)
-  
            
-
-      
-  
            get_names() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            get_nb_proc() (in module commands.make)
-  
            
-
-      
            
-        
-  
            (in module src.architecture)
-  
            
-
-      
            
-      
-  
            get_node_text() (src.xmlManager.ReadXmlFile method)
-  
            
-
-      
-  
            get_parameters() (commands.template.TemplateSettings method)
-  
            
-
-      
-  
            get_path() (src.configManager.ConfigOpener method)
-  
            
-
-      
-  
            get_pids() (commands.jobs.Job method)
-  
            
-
-      
-  
            get_position() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            get_product_components() (in module src.product)
-  
            
-
-      
-  
            get_product_config() (in module src.product)
-  
            
-
-      
-  
            get_product_dependencies() (in module src.product)
-  
            
-
-      
-  
            get_product_section() (in module src.product)
-  
            
-
-      
-  
            get_product_sources() (in module commands.source)
-  
            
-
-      
-  
            get_products_infos() (in module src.product)
-  
            
-
-      
-  
            get_products_list() (in module commands.check)
-  
            
-
-      
            
-        
-  
            (in module commands.compile)
-  
            
-
-        
-  
            (in module commands.configure)
-  
            
-
-        
-  
            (in module commands.make)
-  
            
-
-        
-  
            (in module commands.makeinstall)
-  
            
-
-        
-  
            (in module commands.script)
-  
            
-
-        
-  
            (in module src.configManager)
-  
            
-
-      
            
-      
-  
            get_profile_name() (in module commands.profile)
-  
            
-
-      
-  
            get_property_in_product_cfg() (in module src.utilsSat)
-  
            
-
-      
-  
            get_pyconf_parameters() (commands.template.TemplateSettings method)
-  
            
-
-      
-  
            get_python_version() (in module src.architecture)
-  
            
-
-      
-  
            get_recursive_children() (in module commands.compile)
-  
            
-
-      
-  
            get_recursive_fathers() (in module commands.compile)
-  
            
-
-      
-  
            get_SALOME_modules() (in module commands.application)
-  
            
-
-      
-  
            get_salome_version() (in module src.utilsSat)
-  
            
-
-      
-  
            get_source_directories() (in module commands.clean)
-  
            
-
-      
-  
            get_source_for_dev() (in module commands.source)
-  
            
-
-      
-  
            get_source_from_archive() (in module commands.source)
-  
            
-
-  
            
-      
-  
            get_source_from_cvs() (in module commands.source)
-  
            
-
-      
-  
            get_source_from_dir() (in module commands.source)
-  
            
-
-      
-  
            get_source_from_git() (in module commands.source)
-  
            
-
-      
-  
            get_source_from_svn() (in module commands.source)
-  
            
-
-      
-  
            get_status() (commands.jobs.Job method)
-  
            
-
-      
-  
            get_step() (in module commands.application)
-  
            
-
-      
-  
            get_template_info() (in module commands.template)
-  
            
-
-      
-  
            get_test_timeout() (src.test_module.Test method)
-  
            
-
-      
-  
            get_tmp_dir() (src.test_module.Test method)
-  
            
-
-      
-  
            get_tmp_filename() (in module src.utilsSat)
-  
            
-
-      
-  
            get_user() (in module src.architecture)
-  
            
-
-      
-  
            get_user_config_file() (src.configManager.ConfigManager method)
-  
            
-
-      
-  
            get_win32_calls() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            getByPath() (src.pyconf.Config method)
-  
            
-
-      
            
-        
-  
            (src.pyconf.ConfigList method)
-  
            
-
-      
            
-      
-  
            getChar() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            getColoredVersion() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getCommandAndAppli() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getCommandInstance() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getCommandsList() (in module src.salomeTools)
-  
            
-
-      
-  
            getConfig() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getConfigColored() (in module src.configManager)
-  
            
-
-      
-  
            getConfigManager() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getDefaultLogger() (in module src.loggingSat)
-  
            
-
-      
-  
            getDetailOption() (src.options.Options method)
-  
            
-
-      
-  
            getiterator() (src.ElementTree.ElementTree method)
-  
            
-
-      
-  
            getLocalEnv() (in module src.debug)
-  
            
-
-      
-  
            getLogger() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getLogs() (src.loggingSat.UnittestStream method)
-  
            
-
-      
-  
            getLogsAndClear() (src.loggingSat.UnittestStream method)
-  
            
-
-      
-  
            getMaxFormat() (in module commands.log)
-  
            
-
-      
-  
            getModule() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            getMyLogger() (in module src.example.essai_logging_1)
-  
            
-
-      
            
-        
-  
            (in module src.example.essai_logging_2)
-  
            
-
-      
            
-      
-  
            getParamiko() (in module commands.jobs)
-  
            
-
-      
-  
            getParser() (commands.application.Command method)
-  
            
-
-      
            
-        
-  
            (commands.check.Command method)
-  
            
-
-        
-  
            (commands.clean.Command method)
-  
            
-
-        
-  
            (commands.compile.Command method)
-  
            
-
-        
-  
            (commands.config.Command method)
-  
            
-
-        
-  
            (commands.configure.Command method)
-  
            
-
-        
-  
            (commands.environ.Command method)
-  
            
-
-        
-  
            (commands.find_duplicates.Command method)
-  
            
-
-        
-  
            (commands.generate.Command method)
-  
            
-
-        
-  
            (commands.init.Command method)
-  
            
-
-        
-  
            (commands.job.Command method)
-  
            
-
-        
-  
            (commands.jobs.Command method)
-  
            
-
-        
-  
            (commands.launcher.Command method)
-  
            
-
-        
-  
            (commands.log.Command method)
-  
            
-
-        
-  
            (commands.make.Command method)
-  
            
-
-        
-  
            (commands.makeinstall.Command method)
-  
            
-
-        
-  
            (commands.package.Command method)
-  
            
-
-        
-  
            (commands.patch.Command method)
-  
            
-
-        
-  
            (commands.prepare.Command method)
-  
            
-
-        
-  
            (commands.profile.Command method)
-  
            
-
-        
-  
            (commands.run.Command method)
-  
            
-
-        
-  
            (commands.script.Command method)
-  
            
-
-        
-  
            (commands.shell.Command method)
-  
            
-
-        
-  
            (commands.source.Command method)
-  
            
-
-        
-  
            (commands.template.Command method)
-  
            
-
-        
-  
            (commands.test.Command method)
-  
            
-
-      
            
-      
-  
            getroot() (src.ElementTree.ElementTree method)
-  
            
-
-      
-  
            getRootAttrib() (src.xmlManager.ReadXmlFile method)
-  
            
-
-      
-  
            getStrConfigDbg() (in module src.debug)
-  
            
-
-      
-  
            getStrConfigStd() (in module src.debug)
-  
            
-
-      
-  
            getTmpDirDEFAULT() (in module src.test_module)
-  
            
-
-      
-  
            getToken() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            getUnittestLogger() (in module src.loggingSat)
-  
            
-
-      
-  
            getValue() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            getVersion() (in module src.salomeTools)
-  
            
-
-      
-  
            getWhy() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            git_extract() (in module src.system)
-  
            
-
-      
-  
            GREEN (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-      
-  
            green() (in module src.utilsSat)
-  
            
-
-      
-  
            GREY (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
-  
            Gui (class in commands.jobs)
-  
            
-
-  
            
-
-
            H
            
-
-  
-  
-
            
-      
-  
            hack_for_distene_licence() (in module commands.package)
-  
            
-
-      
-  
            hack_libtool() (src.compilation.Builder method)
-  
            
-
-      
-  
            handleMismatch() (src.pyconf.ConfigMerger method)
-  
            
-
-      
-  
            handleRemoveReadonly() (in module src.utilsSat)
-  
            
-
-  
            
-      
-  
            has_begun() (commands.jobs.Job method)
-  
            
-
-      
-  
            has_failed() (commands.jobs.Job method)
-  
            
-
-      
-  
            has_finished() (commands.jobs.Job method)
-  
            
-
-      
-  
            has_pyconf() (commands.template.TemplateSettings method)
-  
            
-
-      
-  
            header() (in module src.utilsSat)
-  
            
-
-  
            
-
-
            I
            
-
-  
-  
-
            
-      
-  
            indent() (in module src.coloringSat)
-  
            
-
-      
            
-        
-  
            (in module src.debug)
-  
            
-
-        
-  
            (in module src.loggingSat)
-  
            
-
-        
-  
            (src.options.Options method)
-  
            
-
-        
-  
            (src.returnCode.ReturnCode method)
-  
            
-
-      
            
-      
-  
            indentUnittest() (in module src.loggingSat)
-  
            
-
-      
-  
            info() (in module src.utilsSat)
-  
            
-
-      
-  
            init() (in module src.colorama.initialise)
-  
            
-
-      
-  
            initialize_boards() (commands.jobs.Gui method)
-  
            
-
-      
-  
            initLoggerAsDefault() (in module src.loggingSat)
-  
            
-
-      
-  
            initLoggerAsUnittest() (in module src.loggingSat)
-  
            
-
-      
-  
            initMyLogger() (in module src.example.essai_logging_1)
-  
            
-
-      
            
-        
-  
            (in module src.example.essai_logging_2)
-  
            
-
-      
            
-      
-  
            install() (src.compilation.Builder method)
-  
            
-
-      
-  
            InStream (class in src.debug)
-  
            
-
-      
-  
            is_a_tty() (in module src.colorama.ansitowin32)
-  
            
-
-      
-  
            is_defined() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.environment.SalomeEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-  
            
-      
-  
            is_occupied() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            is_running() (commands.jobs.Job method)
-  
            
-
-      
-  
            is_stream_closed() (in module src.colorama.ansitowin32)
-  
            
-
-      
-  
            is_timeout() (commands.jobs.Job method)
-  
            
-
-      
-  
            is_windows() (in module src.architecture)
-  
            
-
-      
-  
            isdir() (src.utilsSat.Path method)
-  
            
-
-      
-  
            iselement() (in module src.ElementTree)
-  
            
-
-      
-  
            isfile() (src.utilsSat.Path method)
-  
            
-
-      
-  
            islink() (src.utilsSat.Path method)
-  
            
-
-      
-  
            isOk() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            isWord() (in module src.pyconf)
-  
            
-
-      
-  
            iteritems() (src.pyconf.Mapping method)
-  
            
-
-      
-  
            iterkeys() (src.pyconf.Mapping method)
-  
            
-
-      
-  
            iterparse (class in src.ElementTree)
-  
            
-
-  
            
-
-
            J
            
-
-  
-  
-
            
-      
-  
            Job (class in commands.jobs)
-  
            
-
-      
-  
            Jobs (class in commands.jobs)
-  
            
-
-  
            
-      
-  
            jsonDumps() (in module src.catchAll)
-  
            
-
-      
            
-        
-  
            (src.catchAll.CatchAll method)
-  
            
-
-      
            
-  
            
-
-
            K
            
-
-  
-  
-
            
-      
-  
            keys() (src.pyconf.Mapping method)
-  
            
-
-      
-  
            KFSYS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            kill_remote_process() (commands.jobs.Job method)
-  
            
-
-  
            
-      
-  
            KNOWNFAILURE_STATUS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            KO_STATUS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            KOSYS (src.returnCode.ReturnCode attribute)
-  
            
-
-  
            
-
-
            L
            
-
-  
-  
-
            
-      
-  
            label() (in module src.utilsSat)
-  
            
-
-      
-  
            last_update() (commands.jobs.Gui method)
-  
            
-
-      
-  
            launch_command() (in module src.fork)
-  
            
-
-      
-  
            LauncherFileEnviron (class in src.fileEnviron)
-  
            
-
-      
-  
            launchSat() (in module src.salomeTools)
-  
            
-
-      
-  
            LIGHTBLACK_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTBLUE_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTCYAN_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTGREEN_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTMAGENTA_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTRED_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTWHITE_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            LIGHTYELLOW_EX (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            list() (src.utilsSat.Path method)
-  
            
-
-      
-  
            list_directory() (in module commands.find_duplicates)
-  
            
-
-  
            
-      
-  
            list_log_file() (in module src.utilsSat)
-  
            
-
-      
-  
            load() (src.pyconf.Config method)
-  
            
-
-      
            
-        
-  
            (src.pyconf.ConfigReader method)
-  
            
-
-      
            
-      
-  
            load_cfg_environment() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            load_environment() (in module src.environment)
-  
            
-
-      
-  
            location() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            log() (in module src.coloringSat)
-  
            
-
-      
            
-        
-  
            (in module src.loggingSat)
-  
            
-
-        
-  
            (src.compilation.Builder method)
-  
            
-
-      
            
-      
-  
            log_command() (src.compilation.Builder method)
-  
            
-
-      
-  
            log_res_step() (in module commands.check)
-  
            
-
-      
            
-        
-  
            (in module commands.compile)
-  
            
-
-        
-  
            (in module commands.configure)
-  
            
-
-        
-  
            (in module commands.make)
-  
            
-
-        
-  
            (in module commands.makeinstall)
-  
            
-
-        
-  
            (in module commands.script)
-  
            
-
-      
            
-      
-  
            log_step() (in module commands.check)
-  
            
-
-      
            
-        
-  
            (in module commands.compile)
-  
            
-
-        
-  
            (in module commands.configure)
-  
            
-
-        
-  
            (in module commands.make)
-  
            
-
-        
-  
            (in module commands.makeinstall)
-  
            
-
-        
-  
            (in module commands.script)
-  
            
-
-      
            
-      
-  
            logger_info_tuples() (in module src.utilsSat)
-  
            
-
-  
            
-
-
            M
            
-
-  
-  
-
            
-      
-  
            Machine (class in commands.jobs)
-  
            
-
-      
-  
            MAGENTA (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-      
-  
            magenta() (in module src.utilsSat)
-  
            
-
-      
-  
            make() (src.compilation.Builder method)
-  
            
-
-      
            
-        
-  
            (src.utilsSat.Path method)
-  
            
-
-      
            
-      
-  
            make_alias() (in module commands.application)
-  
            
-
-      
-  
            make_all_products() (in module commands.make)
-  
            
-
-      
-  
            make_archive() (in module commands.package)
-  
            
-
-      
-  
            make_product() (in module commands.make)
-  
            
-
-      
-  
            makeinstall_all_products() (in module commands.makeinstall)
-  
            
-
-  
            
-      
-  
            makeinstall_product() (in module commands.makeinstall)
-  
            
-
-      
-  
            makePath() (in module src.pyconf)
-  
            
-
-      
-  
            Mapping (class in src.pyconf)
-  
            
-
-      
-  
            match() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            merge() (src.pyconf.ConfigMerger method)
-  
            
-
-      
-  
            merge_dicts() (in module src.utilsSat)
-  
            
-
-      
-  
            mergeMapping() (src.pyconf.ConfigMerger method)
-  
            
-
-      
-  
            mergeSequence() (src.pyconf.ConfigMerger method)
-  
            
-
-      
-  
            mkdir() (commands.jobs.Machine method)
-  
            
-
-      
-  
            move_test_results() (in module commands.test)
-  
            
-
-      
-  
            MyFormatter (class in src.example.essai_logging_2)
-  
            
-
-      
-  
            MyTemplate (class in src.template)
-  
            
-
-  
            
-
-
            N
            
-
-  
-  
-
            
-      
-  
            NA_STATUS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            name (commands.application.Command attribute)
-  
            
-
-      
            
-        
-  
            (commands.check.Command attribute)
-  
            
-
-        
-  
            (commands.clean.Command attribute)
-  
            
-
-        
-  
            (commands.compile.Command attribute)
-  
            
-
-        
-  
            (commands.config.Command attribute)
-  
            
-
-        
-  
            (commands.configure.Command attribute)
-  
            
-
-        
-  
            (commands.environ.Command attribute)
-  
            
-
-        
-  
            (commands.find_duplicates.Command attribute)
-  
            
-
-        
-  
            (commands.generate.Command attribute)
-  
            
-
-        
-  
            (commands.init.Command attribute)
-  
            
-
-        
-  
            (commands.job.Command attribute)
-  
            
-
-        
-  
            (commands.jobs.Command attribute)
-  
            
-
-        
-  
            (commands.launcher.Command attribute)
-  
            
-
-        
-  
            (commands.log.Command attribute)
-  
            
-
-        
-  
            (commands.make.Command attribute)
-  
            
-
-        
-  
            (commands.makeinstall.Command attribute)
-  
            
-
-        
-  
            (commands.package.Command attribute)
-  
            
-
-        
-  
            (commands.patch.Command attribute)
-  
            
-
-        
-  
            (commands.prepare.Command attribute)
-  
            
-
-        
-  
            (commands.profile.Command attribute)
-  
            
-
-        
-  
            (commands.run.Command attribute)
-  
            
-
-        
-  
            (commands.script.Command attribute)
-  
            
-
-        
-  
            (commands.shell.Command attribute)
-  
            
-
-        
-  
            (commands.source.Command attribute)
-  
            
-
-        
-  
            (commands.template.Command attribute)
-  
            
-
-        
-  
            (commands.test.Command attribute)
-  
            
-
-      
            
-  
            
-      
-  
            NASYS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            NDSYS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            next() (src.ElementTree.iterparse method)
-  
            
-
-      
            
-        
-  
            (src.pyconf.Sequence.SeqIter method)
-  
            
-
-      
            
-      
-  
            NORMAL (src.colorama.ansi.AnsiStyle attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.winterm.WinStyle attribute)
-  
            
-
-      
            
-      
-  
            normal() (in module src.utilsSat)
-  
            
-
-  
            
-
-
            O
            
-
-  
-  
-
            
-      
-  
            OK_STATUS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            OKSYS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            only_numbers() (in module src.utilsSat)
-  
            
-
-      
-  
            Options (class in src.options)
-  
            
-
-  
            
-      
-  
            OptResult (class in src.options)
-  
            
-
-      
-  
            OutStream (class in src.debug)
-  
            
-
-      
-  
            overwriteKeys() (src.pyconf.ConfigMerger method)
-  
            
-
-      
-  
            overwriteMergeResolve() (in module src.pyconf)
-  
            
-
-  
            
-
-
            P
            
-
-  
-  
-
            
-      
-  
            parse() (in module src.ElementTree)
-  
            
-
-      
            
-        
-  
            (src.ElementTree.ElementTree method)
-  
            
-
-      
            
-      
-  
            parse_args() (src.options.Options method)
-  
            
-
-      
-  
            parse_csv_boards() (commands.jobs.Gui method)
-  
            
-
-      
-  
            parse_date() (in module src.utilsSat)
-  
            
-
-      
-  
            parseArguments() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            parseFactor() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseKeyValuePair() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseMapping() (commands.profile.profileConfigReader method)
-  
            
-
-      
            
-        
-  
            (src.pyconf.ConfigReader method)
-  
            
-
-      
            
-      
-  
            parseMappingBody() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseReference() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseScalar() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseSequence() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseSuffix() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseTerm() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            parseValue() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            Path (class in src.utilsSat)
-  
            
-
-      
-  
            pattern (src.template.MyTemplate attribute)
-  
            
-
-      
-  
            PI() (in module src.ElementTree)
-  
            
-
-      
-  
            pop_debug() (in module src.debug)
-  
            
-
-      
-  
            POS() (src.colorama.ansi.AnsiCursor method)
-  
            
-
-      
-  
            prepare() (src.compilation.Builder method)
-  
            
-
-      
-  
            prepare_from_template() (in module commands.template)
-  
            
-
-      
-  
            prepare_testbase() (src.test_module.Test method)
-  
            
-
-      
-  
            prepare_testbase_from_dir() (src.test_module.Test method)
-  
            
-
-      
-  
            prepare_testbase_from_git() (src.test_module.Test method)
-  
            
-
-      
-  
            prepare_testbase_from_svn() (src.test_module.Test method)
-  
            
-
-      
-  
            prepend() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.environment.SalomeEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            prepend_value() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-      
            
-      
-  
            print_debug() (in module src.configManager)
-  
            
-
-      
-  
            print_grep_environs() (in module src.environs)
-  
            
-
-  
            
-      
-  
            print_help() (src.salomeTools.Sat method)
-  
            
-
-      
-  
            print_log_command_in_terminal() (in module commands.log)
-  
            
-
-      
-  
            print_split_environs() (in module src.environs)
-  
            
-
-      
-  
            print_split_pattern_environs() (in module src.environs)
-  
            
-
-      
-  
            print_value() (in module src.configManager)
-  
            
-
-      
-  
            ProcessingInstruction() (in module src.ElementTree)
-  
            
-
-      
-  
            produce_install_bin_file() (in module commands.package)
-  
            
-
-      
-  
            produce_relative_env_files() (in module commands.package)
-  
            
-
-      
-  
            produce_relative_launcher() (in module commands.package)
-  
            
-
-      
-  
            product_appli_creation_script() (in module commands.package)
-  
            
-
-      
-  
            product_compiles() (in module src.product)
-  
            
-
-      
-  
            product_has_dir() (in module commands.clean)
-  
            
-
-      
-  
            product_has_env_script() (in module src.product)
-  
            
-
-      
-  
            product_has_logo() (in module src.product)
-  
            
-
-      
-  
            product_has_patches() (in module src.product)
-  
            
-
-      
-  
            product_has_salome_gui() (in module src.product)
-  
            
-
-      
-  
            product_has_script() (in module src.product)
-  
            
-
-      
-  
            product_is_autotools() (in module src.product)
-  
            
-
-      
-  
            product_is_cmake() (in module src.product)
-  
            
-
-      
-  
            product_is_cpp() (in module src.product)
-  
            
-
-      
-  
            product_is_debug() (in module src.product)
-  
            
-
-      
-  
            product_is_dev() (in module src.product)
-  
            
-
-      
-  
            product_is_fixed() (in module src.product)
-  
            
-
-      
-  
            product_is_generated() (in module src.product)
-  
            
-
-      
-  
            product_is_mpi() (in module src.product)
-  
            
-
-      
-  
            product_is_native() (in module src.product)
-  
            
-
-      
-  
            product_is_SALOME() (in module src.product)
-  
            
-
-      
-  
            product_is_salome() (in module src.product)
-  
            
-
-      
-  
            product_is_sample() (in module src.product)
-  
            
-
-      
-  
            product_is_smesh_plugin() (in module src.product)
-  
            
-
-      
-  
            product_is_vcs() (in module src.product)
-  
            
-
-      
-  
            profileConfigReader (class in commands.profile)
-  
            
-
-      
-  
            profileReference (class in commands.profile)
-  
            
-
-      
-  
            Progress_bar (class in commands.find_duplicates)
-  
            
-
-      
-  
            project_package() (in module commands.package)
-  
            
-
-      
-  
            push_debug() (in module src.debug)
-  
            
-
-      
-  
            put_dir() (commands.jobs.Machine method)
-  
            
-
-      
-  
            put_jobs_not_today() (commands.jobs.Gui method)
-  
            
-
-      
-  
            put_txt_log_in_appli_log_dir() (src.compilation.Builder method)
-  
            
-
-  
            
-
-
            Q
            
-
-  
-
            
-      
-  
            QName (class in src.ElementTree)
-  
            
-
-  
            
-
-
            R
            
-
-  
-  
-
            
-      
-  
            raiseIfKo() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            read() (src.pyconf.ConfigInputStream method)
-  
            
-
-      
-  
            read_config_from_a_file() (in module src.utilsSat)
-  
            
-
-      
-  
            read_results() (src.test_module.Test method)
-  
            
-
-      
-  
            readline() (src.pyconf.ConfigInputStream method)
-  
            
-
-      
-  
            readlink() (src.utilsSat.Path method)
-  
            
-
-      
-  
            ReadXmlFile (class in src.xmlManager)
-  
            
-
-      
-  
            RED (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-      
-  
            red() (in module src.utilsSat)
-  
            
-
-      
-  
            Reference (class in src.pyconf)
-  
            
-
-      
-  
            reinit() (in module src.colorama.initialise)
-  
            
-
-      
-  
            remove_item_from_list() (in module src.utilsSat)
-  
            
-
-      
-  
            remove_log_file() (in module commands.log)
-  
            
-
-      
-  
            remove_products() (in module commands.prepare)
-  
            
-
-      
-  
            removeNamespace() (src.pyconf.Config method)
-  
            
-
-      
-  
            replace() (in module src.coloringSat)
-  
            
-
-      
-  
            replace_in_file() (in module src.utilsSat)
-  
            
-
-      
-  
            RESET (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            reset() (in module src.utilsSat)
-  
            
-
-      
-  
            RESET_ALL (src.colorama.ansi.AnsiStyle attribute)
-  
            
-
-      
-  
            reset_all() (in module src.colorama.initialise)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-        
-  
            (src.colorama.winterm.WinTerm method)
-  
            
-
-      
            
-      
-  
            resolve() (src.pyconf.Reference method)
-  
            
-
-      
-  
            ReturnCode (class in src.returnCode)
-  
            
-
-      
-  
            rm() (src.utilsSat.Path method)
-  
            
-
-      
-  
            run() (commands.application.Command method)
-  
            
-
-      
            
-        
-  
            (commands.check.Command method)
-  
            
-
-        
-  
            (commands.clean.Command method)
-  
            
-
-        
-  
            (commands.compile.Command method)
-  
            
-
-        
-  
            (commands.config.Command method)
-  
            
-
-        
-  
            (commands.configure.Command method)
-  
            
-
-        
-  
            (commands.environ.Command method)
-  
            
-
-        
-  
            (commands.find_duplicates.Command method)
-  
            
-
-        
-  
            (commands.generate.Command method)
-  
            
-
-        
-  
            (commands.init.Command method)
-  
            
-
-        
-  
            (commands.job.Command method)
-  
            
-
-        
-  
            (commands.jobs.Command method)
-  
            
-
-        
-  
            (commands.jobs.Job method)
-  
            
-
-        
-  
            (commands.launcher.Command method)
-  
            
-
-        
-  
            (commands.log.Command method)
-  
            
-
-        
-  
            (commands.make.Command method)
-  
            
-
-        
-  
            (commands.makeinstall.Command method)
-  
            
-
-        
-  
            (commands.package.Command method)
-  
            
-
-        
-  
            (commands.patch.Command method)
-  
            
-
-        
-  
            (commands.prepare.Command method)
-  
            
-
-        
-  
            (commands.profile.Command method)
-  
            
-
-        
-  
            (commands.run.Command method)
-  
            
-
-        
-  
            (commands.script.Command method)
-  
            
-
-        
-  
            (commands.shell.Command method)
-  
            
-
-        
-  
            (commands.source.Command method)
-  
            
-
-        
-  
            (commands.template.Command method)
-  
            
-
-        
-  
            (commands.test.Command method)
-  
            
-
-      
            
-  
            
-      
-  
            run_all_tests() (src.test_module.Test method)
-  
            
-
-      
-  
            run_env_script() (src.environment.SalomeEnviron method)
-  
            
-
-      
            
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            run_grid_tests() (src.test_module.Test method)
-  
            
-
-      
-  
            run_jobs() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            run_script() (src.test_module.Test method)
-  
            
-
-      
-  
            run_script_all_products() (in module commands.script)
-  
            
-
-      
-  
            run_script_of_product() (in module commands.script)
-  
            
-
-      
-  
            run_session_tests() (src.test_module.Test method)
-  
            
-
-      
-  
            run_simple_env_script() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            run_testbase_tests() (src.test_module.Test method)
-  
            
-
-      
-  
            run_tests() (src.test_module.Test method)
-  
            
-
-  
            
-
-
            S
            
-
-  
-  
-
            
-      
-  
            SalomeEnviron (class in src.environment)
-  
            
-
-      
-  
            Sat (class in src.salomeTools)
-  
            
-
-      
-  
            save_file() (in module commands.test)
-  
            
-
-      
-  
            saveConfigDbg() (in module src.debug)
-  
            
-
-      
-  
            saveConfigStd() (in module src.debug)
-  
            
-
-      
-  
            ScreenEnviron (class in src.fileEnviron)
-  
            
-
-      
-  
            search_known_errors() (src.test_module.Test method)
-  
            
-
-      
-  
            search_template() (in module commands.template)
-  
            
-
-      
-  
            Sequence (class in src.pyconf)
-  
            
-
-      
-  
            Sequence.SeqIter (class in src.pyconf)
-  
            
-
-      
-  
            set() (src.environment.Environ method)
-  
            
-
-      
            
-        
-  
            (src.environment.SalomeEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.BashFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.BatFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ContextFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.FileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.LauncherFileEnviron method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-      
            
-      
-  
            set_a_product() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_application_env() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_attrs() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            set_console() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            set_cpp_env() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_cursor_position() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            set_full_environ() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_local_value() (in module commands.init)
-  
            
-
-      
-  
            set_products() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_python_libdirs() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_salome_generic_product_env() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_salome_minimal_product_env() (src.environment.SalomeEnviron method)
-  
            
-
-      
-  
            set_title() (in module src.colorama.ansi)
-  
            
-
-      
            
-        
-  
            (src.colorama.winterm.WinTerm method)
-  
            
-
-      
            
-      
-  
            set_user_config_file() (src.configManager.ConfigManager method)
-  
            
-
-      
-  
            setColorLevelname() (src.loggingSat.DefaultFormatter method)
-  
            
-
-      
-  
            SetConsoleTextAttribute() (in module src.colorama.win32)
-  
            
-
-      
-  
            setLocale() (in module src.salomeTools)
-  
            
-
-      
-  
            setNotLocale() (in module src.salomeTools)
-  
            
-
-      
-  
            setPath() (src.pyconf.Container method)
-  
            
-
-      
-  
            setStatus() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            setStream() (src.pyconf.ConfigReader method)
-  
            
-
-      
-  
            setValue() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            setWhy() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            Shell (class in src.environment)
-  
            
-
-      
-  
            should_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            show_command_log() (in module src.utilsSat)
-  
            
-
-      
-  
            show_in_editor() (in module src.system)
-  
            
-
-      
-  
            show_last_logs() (in module commands.log)
-  
            
-
-      
-  
            show_patchs() (in module src.configManager)
-  
            
-
-      
-  
            show_product_info() (in module src.configManager)
-  
            
-
-      
-  
            show_product_last_logs() (in module commands.log)
-  
            
-
-  
            
-      
-  
            show_progress() (in module src.fork)
-  
            
-
-      
-  
            smartcopy() (src.utilsSat.Path method)
-  
            
-
-      
-  
            sort_products() (in module commands.compile)
-  
            
-
-      
-  
            source_package() (in module commands.package)
-  
            
-
-      
-  
            special_path_separator() (in module src.fileEnviron)
-  
            
-
-      
-  
            src (module)
-  
            
-
-      
-  
            src.architecture (module)
-  
            
-
-      
-  
            src.catchAll (module)
-  
            
-
-      
-  
            src.colorama (module)
-  
            
-
-      
-  
            src.colorama.ansi (module)
-  
            
-
-      
-  
            src.colorama.ansitowin32 (module)
-  
            
-
-      
-  
            src.colorama.initialise (module)
-  
            
-
-      
-  
            src.colorama.win32 (module)
-  
            
-
-      
-  
            src.colorama.winterm (module)
-  
            
-
-      
-  
            src.coloringSat (module)
-  
            
-
-      
-  
            src.compilation (module)
-  
            
-
-      
-  
            src.configManager (module)
-  
            
-
-      
-  
            src.debug (module)
-  
            
-
-      
-  
            src.ElementTree (module)
-  
            
-
-      
-  
            src.environment (module)
-  
            
-
-      
-  
            src.environs (module)
-  
            
-
-      
-  
            src.example (module)
-  
            
-
-      
-  
            src.example.essai_logging_1 (module)
-  
            
-
-      
-  
            src.example.essai_logging_2 (module)
-  
            
-
-      
-  
            src.exceptionSat (module)
-  
            
-
-      
-  
            src.fileEnviron (module)
-  
            
-
-      
-  
            src.fork (module)
-  
            
-
-      
-  
            src.loggingSat (module)
-  
            
-
-      
-  
            src.options (module)
-  
            
-
-      
-  
            src.product (module)
-  
            
-
-      
-  
            src.pyconf (module)
-  
            
-
-      
-  
            src.returnCode (module)
-  
            
-
-      
-  
            src.salomeTools (module)
-  
            
-
-      
-  
            src.system (module)
-  
            
-
-      
-  
            src.template (module)
-  
            
-
-      
-  
            src.test_module (module)
-  
            
-
-      
-  
            src.utilsSat (module)
-  
            
-
-      
-  
            src.xmlManager (module)
-  
            
-
-      
-  
            ssh_connection_all_machines() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            start() (src.ElementTree.TreeBuilder method)
-  
            
-
-      
-  
            str_of_length() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            StreamWrapper (class in src.colorama.ansitowin32)
-  
            
-
-      
-  
            style() (src.colorama.winterm.WinTerm method)
-  
            
-
-      
-  
            SubElement() (in module src.ElementTree)
-  
            
-
-      
-  
            substitute() (in module src.template)
-  
            
-
-      
-  
            success() (in module src.utilsSat)
-  
            
-
-      
-  
            successfully_connected() (commands.jobs.Machine method)
-  
            
-
-      
-  
            suppress_directories() (in module commands.clean)
-  
            
-
-      
-  
            svn_extract() (in module src.system)
-  
            
-
-      
-  
            symlink() (src.utilsSat.Path method)
-  
            
-
-  
            
-
-
            T
            
-
-  
-  
-
            
-      
-  
            TemplateSettings (class in commands.template)
-  
            
-
-      
-  
            Test (class in src.test_module)
-  
            
-
-      
-  
            testLogger1() (in module src.example.essai_logging_1)
-  
            
-
-      
            
-        
-  
            (in module src.example.essai_logging_2)
-  
            
-
-      
            
-      
-  
            testLogger_1() (in module src.loggingSat)
-  
            
-
-      
-  
            time_elapsed() (commands.jobs.Job method)
-  
            
-
-      
-  
            timedelta_total_seconds() (in module src.utilsSat)
-  
            
-
-      
-  
            TIMEOUT_STATUS (src.returnCode.ReturnCode attribute)
-  
            
-
-  
            
-      
-  
            toColor() (in module src.coloringSat)
-  
            
-
-      
-  
            toColor_AnsiToWin32() (in module src.coloringSat)
-  
            
-
-      
-  
            tofix() (in module src.debug)
-  
            
-
-      
-  
            tostring() (in module src.ElementTree)
-  
            
-
-      
-  
            TOSYS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            toSys() (src.returnCode.ReturnCode method)
-  
            
-
-      
-  
            total_duration() (commands.jobs.Job method)
-  
            
-
-      
-  
            TParam (class in commands.template)
-  
            
-
-      
-  
            TreeBuilder (class in src.ElementTree)
-  
            
-
-  
            
-
-
            U
            
-
-  
-  
-
            
-      
-  
            UnittestFormatter (class in src.loggingSat)
-  
            
-
-      
-  
            UnittestStream (class in src.loggingSat)
-  
            
-
-      
-  
            UNKNOWN_STATUS (src.returnCode.ReturnCode attribute)
-  
            
-
-      
-  
            UP() (src.colorama.ansi.AnsiCursor method)
-  
            
-
-      
-  
            update_config() (in module commands.package)
-  
            
-
-  
            
-      
-  
            update_hat_xml() (in module src.utilsSat)
-  
            
-
-      
-  
            update_jobs_states_list() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            update_pyconf() (in module commands.profile)
-  
            
-
-      
-  
            update_xml_file() (commands.jobs.Gui method)
-  
            
-
-      
-  
            update_xml_files() (commands.jobs.Gui method)
-  
            
-
-  
            
-
-
            W
            
-
-  
-  
-
            
-      
-  
            warning() (in module src.utilsSat)
-  
            
-
-      
-  
            WHITE (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-      
            
-      
-  
            white() (in module src.utilsSat)
-  
            
-
-      
-  
            winapi_test() (in module src.colorama.win32)
-  
            
-
-      
-  
            WinColor (class in src.colorama.winterm)
-  
            
-
-      
-  
            WinStyle (class in src.colorama.winterm)
-  
            
-
-      
-  
            WinTerm (class in src.colorama.winterm)
-  
            
-
-      
-  
            wmake() (src.compilation.Builder method)
-  
            
-
-      
-  
            wrap_stream() (in module src.colorama.initialise)
-  
            
-
-      
-  
            write() (in module src.debug)
-  
            
-
-      
            
-        
-  
            (src.ElementTree.ElementTree method)
-  
            
-
-        
-  
            (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-        
-  
            (src.colorama.ansitowin32.StreamWrapper method)
-  
            
-
-        
-  
            (src.coloringSat.ColoringStream method)
-  
            
-
-        
-  
            (src.fileEnviron.ScreenEnviron method)
-  
            
-
-        
-  
            (src.loggingSat.UnittestStream method)
-  
            
-
-        
-  
            (src.pyconf.ConfigOutputStream method)
-  
            
-
-      
            
-  
            
-      
-  
            write_all_results() (commands.jobs.Jobs method)
-  
            
-
-      
-  
            write_all_source_files() (in module commands.environ)
-  
            
-
-      
-  
            write_and_convert() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            write_back() (in module src.fork)
-  
            
-
-      
-  
            write_cfgForPy_file() (src.environment.FileEnvWriter method)
-  
            
-
-      
-  
            write_env_file() (src.environment.FileEnvWriter method)
-  
            
-
-      
-  
            write_info() (commands.jobs.Machine method)
-  
            
-
-      
-  
            write_plain_text() (src.colorama.ansitowin32.AnsiToWin32 method)
-  
            
-
-      
-  
            write_report() (in module src.xmlManager)
-  
            
-
-      
-  
            write_results() (commands.jobs.Job method)
-  
            
-
-      
-  
            write_test_margin() (src.test_module.Test method)
-  
            
-
-      
-  
            write_tree() (src.xmlManager.XmlLogFile method)
-  
            
-
-      
-  
            write_xml_file() (commands.jobs.Gui method)
-  
            
-
-      
-  
            write_xml_files() (commands.jobs.Gui method)
-  
            
-
-      
-  
            writeToStream() (src.pyconf.Container method)
-  
            
-
-      
            
-        
-  
            (src.pyconf.Mapping method)
-  
            
-
-        
-  
            (src.pyconf.Sequence method)
-  
            
-
-      
            
-      
-  
            writeValue() (src.pyconf.Container method)
-  
            
-
-  
            
-
-
            X
            
-
-  
-  
-
            
-      
-  
            XML() (in module src.ElementTree)
-  
            
-
-  
            
-      
-  
            XmlLogFile (class in src.xmlManager)
-  
            
-
-      
-  
            XMLTreeBuilder (class in src.ElementTree)
-  
            
-
-  
            
-
-
            Y
            
-
-  
-  
-
            
-      
-  
            YELLOW (src.colorama.ansi.AnsiBack attribute)
-  
            
-
-      
            
-        
-  
            (src.colorama.ansi.AnsiFore attribute)
-  
            
-
-        
-  
            (src.colorama.winterm.WinColor attribute)
-  
            
-
-      
            
-  
            
-      
-  
            yellow() (in module src.utilsSat)
-  
            
-
-  
            
+
            Y
            
+
+  
+  
+
            
 
 
 
@@ -4196,24 +2272,23 @@
         
            
             
-
-   
            
+            
            
 
            Related Topics
            
 
 
            
-
 
 
         
            
@@ -4224,8 +2299,8 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
     
            
 
diff --git a/doc/build/html/index.html b/doc/build/html/index.html
index 5c702b2..06395a0 100644
--- a/doc/build/html/index.html
+++ b/doc/build/html/index.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Salome Tools — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
    
   
@@ -34,8 +23,7 @@
   
   
 
-  
-  
+  
   
 
     
            
@@ -54,7 +42,7 @@
 
            
 
            The SalomeTools (sat) is a suite of commands
 that can be used to perform operations on SALOME.
            
-
            For example, sat allows you to compile SALOME's codes
+
            For example, sat allows you to compile SALOME’s codes
 (prerequisites, products)
 create application, run tests, create package, etc.
            
 
            This utility code is a set of Python scripts files.
            
@@ -144,18 +132,20 @@ create application, run tests, create package, etc.
            
   
            
     
            This Page
            
     
    
            
 
 
         
            
@@ -166,11 +156,11 @@ create application, run tests, create package, etc.
            
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/html/installation_of_sat.html b/doc/build/html/installation_of_sat.html
index 9e3b43d..d5977d2 100644
--- a/doc/build/html/installation_of_sat.html
+++ b/doc/build/html/installation_of_sat.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Installation — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
            
@@ -46,8 +34,8 @@
             
   
            
 
            Installation¶
            
-
            Usually user could find (and use) command sat directly after a 'detar' installation of SALOME.
            
-
            tar -xf .../SALOME_xx.tgz
+
            Usually user could find (and use) command sat directly after a ‘detar’ installation of SALOME.
            
+
            tar -xf .../SALOME_xx.tgz
 cd SALOME_xx
 ls -l sat      # sat -> salomeTools/sat
 
            
@@ -75,18 +63,20 @@ ls -l sat      # sat -> salomeTools/sat
   
            
     
            This Page
            
     
    
            
 
 
         
            
@@ -97,11 +87,11 @@ ls -l sat      # sat -> salomeTools/sat
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv
index 3972db0..d6a11c7 100644
Binary files a/doc/build/html/objects.inv and b/doc/build/html/objects.inv differ
diff --git a/doc/build/html/py-modindex.html b/doc/build/html/py-modindex.html
index 3dfa4ba..bf08238 100644
--- a/doc/build/html/py-modindex.html
+++ b/doc/build/html/py-modindex.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Python Module Index — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
 
    
   
@@ -36,8 +25,7 @@
 
 
 
-  
-  
+  
   
 
     
            
@@ -53,7 +41,7 @@
    s
    
            
 
-   
+   
            
@@ -381,12 +369,14 @@
 
@@ -397,8 +387,8 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
 
diff --git a/doc/build/html/release_notes/release_notes_5.0.0.html b/doc/build/html/release_notes/release_notes_5.0.0.html
index 6dcb2f4..b3a2cb0 100644
--- a/doc/build/html/release_notes/release_notes_5.0.0.html
+++ b/doc/build/html/release_notes/release_notes_5.0.0.html
@@ -1,32 +1,21 @@
+
 
 
-
 
+    
-    
     Release notes — salomeTools 5.0.0dev documentation
-    
     
-    
-    
+    
-    
+    
-    
@@ -34,8 +23,7 @@
   
   
 
-  
-  
+  
            
@@ -67,18 +55,20 @@
   
            
     
            This Page
            
     
    
            
 
 
         
            
@@ -89,11 +79,11 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
 
diff --git a/doc/build/html/search.html b/doc/build/html/search.html
index 09ca7ee..6ddceb1 100644
--- a/doc/build/html/search.html
+++ b/doc/build/html/search.html
@@ -1,33 +1,22 @@
+
 
 
-
 
+    
-    
     Search — salomeTools 5.0.0dev documentation
-    
     
-    
-    
+    
-    
+    
-    
@@ -41,8 +30,7 @@
   
 
 
-  
-  
+  
            
@@ -96,8 +84,8 @@
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
     
            
 
diff --git a/doc/build/html/searchindex.js b/doc/build/html/searchindex.js
index d54811a..b1ce587 100644
--- a/doc/build/html/searchindex.js
+++ b/doc/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:49,filenames:["apidoc_commands/commands","apidoc_commands/modules","apidoc_src/modules","apidoc_src/src","apidoc_src/src.colorama","apidoc_src/src.example","commands/application","commands/clean","commands/compile","commands/config","commands/environ","commands/generate","commands/launcher","commands/log","commands/package","commands/prepare","configuration","index","installation_of_sat","release_notes/release_notes_5.0.0","usage_of_sat","write_command"],objects:{"":{commands:[0,0,0,"-"],src:[3,0,0,"-"]},"commands.application":{Command:[0,1,1,""],add_module_to_appli:[0,4,1,""],create_application:[0,4,1,""],create_config_file:[0,4,1,""],customize_app:[0,4,1,""],generate_application:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""],get_SALOME_modules:[0,4,1,""],get_step:[0,4,1,""],make_alias:[0,4,1,""]},"commands.application.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.check":{Command:[0,1,1,""],check_all_products:[0,4,1,""],check_product:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""]},"commands.check.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.clean":{Command:[0,1,1,""],get_build_directories:[0,4,1,""],get_install_directories:[0,4,1,""],get_source_directories:[0,4,1,""],product_has_dir:[0,4,1,""],suppress_directories:[0,4,1,""]},"commands.clean.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.compile":{Command:[0,1,1,""],add_compile_config_file:[0,4,1,""],check_dependencies:[0,4,1,""],compile_all_products:[0,4,1,""],compile_product:[0,4,1,""],compile_product_cmake_autotools:[0,4,1,""],compile_product_script:[0,4,1,""],extend_with_children:[0,4,1,""],extend_with_fathers:[0,4,1,""],get_children:[0,4,1,""],get_products_list:[0,4,1,""],get_recursive_children:[0,4,1,""],get_recursive_fathers:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],sort_products:[0,4,1,""]},"commands.compile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.config":{Command:[0,1,1,""]},"commands.config.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.configure":{Command:[0,1,1,""],configure_all_products:[0,4,1,""],configure_product:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""]},"commands.configure.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.environ":{Command:[0,1,1,""],write_all_source_files:[0,4,1,""]},"commands.environ.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates":{Command:[0,1,1,""],Progress_bar:[0,1,1,""],format_list_of_str:[0,4,1,""],list_directory:[0,4,1,""]},"commands.find_duplicates.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates.Progress_bar":{display_value_progression:[0,2,1,""]},"commands.generate":{Command:[0,1,1,""],build_context:[0,4,1,""],check_module_generator:[0,4,1,""],check_yacsgen:[0,4,1,""],generate_component:[0,4,1,""],generate_component_list:[0,4,1,""]},"commands.generate.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.init":{Command:[0,1,1,""],check_path:[0,4,1,""],display_local_values:[0,4,1,""],set_local_value:[0,4,1,""]},"commands.init.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.job":{Command:[0,1,1,""]},"commands.job.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs":{Command:[0,1,1,""],Gui:[0,1,1,""],Job:[0,1,1,""],Jobs:[0,1,1,""],Machine:[0,1,1,""],develop_factorized_jobs:[0,4,1,""],getParamiko:[0,4,1,""],get_config_file_path:[0,4,1,""]},"commands.jobs.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs.Gui":{add_xml_board:[0,2,1,""],find_history:[0,2,1,""],find_test_log:[0,2,1,""],initialize_boards:[0,2,1,""],last_update:[0,2,1,""],parse_csv_boards:[0,2,1,""],put_jobs_not_today:[0,2,1,""],update_xml_file:[0,2,1,""],update_xml_files:[0,2,1,""],write_xml_file:[0,2,1,""],write_xml_files:[0,2,1,""]},"commands.jobs.Job":{cancel:[0,2,1,""],check_time:[0,2,1,""],get_log_files:[0,2,1,""],get_pids:[0,2,1,""],get_status:[0,2,1,""],has_begun:[0,2,1,""],has_failed:[0,2,1,""],has_finished:[0,2,1,""],is_running:[0,2,1,""],is_timeout:[0,2,1,""],kill_remote_process:[0,2,1,""],run:[0,2,1,""],time_elapsed:[0,2,1,""],total_duration:[0,2,1,""],write_results:[0,2,1,""]},"commands.jobs.Jobs":{cancel_dependencies_of_failing_jobs:[0,2,1,""],define_job:[0,2,1,""],determine_jobs_and_machines:[0,2,1,""],display_status:[0,2,1,""],find_job_that_has_name:[0,2,1,""],is_occupied:[0,2,1,""],run_jobs:[0,2,1,""],ssh_connection_all_machines:[0,2,1,""],str_of_length:[0,2,1,""],update_jobs_states_list:[0,2,1,""],write_all_results:[0,2,1,""]},"commands.jobs.Machine":{close:[0,2,1,""],connect:[0,2,1,""],copy_sat:[0,2,1,""],exec_command:[0,2,1,""],mkdir:[0,2,1,""],put_dir:[0,2,1,""],successfully_connected:[0,2,1,""],write_info:[0,2,1,""]},"commands.launcher":{Command:[0,1,1,""],copy_catalog:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""]},"commands.launcher.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.log":{Command:[0,1,1,""],ask_value:[0,4,1,""],getMaxFormat:[0,4,1,""],get_last_log_file:[0,4,1,""],print_log_command_in_terminal:[0,4,1,""],remove_log_file:[0,4,1,""],show_last_logs:[0,4,1,""],show_product_last_logs:[0,4,1,""]},"commands.log.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.make":{Command:[0,1,1,""],get_nb_proc:[0,4,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],make_all_products:[0,4,1,""],make_product:[0,4,1,""]},"commands.make.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.makeinstall":{Command:[0,1,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],makeinstall_all_products:[0,4,1,""],makeinstall_product:[0,4,1,""]},"commands.makeinstall.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.package":{Command:[0,1,1,""],add_files:[0,4,1,""],add_readme:[0,4,1,""],add_salomeTools:[0,4,1,""],binary_package:[0,4,1,""],create_project_for_src_package:[0,4,1,""],exclude_VCS_and_extensions:[0,4,1,""],find_application_pyconf:[0,4,1,""],find_product_scripts_and_pyconf:[0,4,1,""],get_archives:[0,4,1,""],get_archives_vcs:[0,4,1,""],hack_for_distene_licence:[0,4,1,""],make_archive:[0,4,1,""],produce_install_bin_file:[0,4,1,""],produce_relative_env_files:[0,4,1,""],produce_relative_launcher:[0,4,1,""],product_appli_creation_script:[0,4,1,""],project_package:[0,4,1,""],source_package:[0,4,1,""],update_config:[0,4,1,""]},"commands.package.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.patch":{Command:[0,1,1,""],apply_patch:[0,4,1,""]},"commands.patch.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.prepare":{Command:[0,1,1,""],find_products_already_getted:[0,4,1,""],find_products_with_patchs:[0,4,1,""],remove_products:[0,4,1,""]},"commands.prepare.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile":{Command:[0,1,1,""],generate_profile_sources:[0,4,1,""],get_profile_name:[0,4,1,""],profileConfigReader:[0,1,1,""],profileReference:[0,1,1,""],update_pyconf:[0,4,1,""]},"commands.profile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile.profileConfigReader":{parseMapping:[0,2,1,""]},"commands.run":{Command:[0,1,1,""]},"commands.run.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.script":{Command:[0,1,1,""],get_products_list:[0,4,1,""],log_res_step:[0,4,1,""],log_step:[0,4,1,""],run_script_all_products:[0,4,1,""],run_script_of_product:[0,4,1,""]},"commands.script.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.shell":{Command:[0,1,1,""]},"commands.shell.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.source":{Command:[0,1,1,""],check_sources:[0,4,1,""],get_all_product_sources:[0,4,1,""],get_product_sources:[0,4,1,""],get_source_for_dev:[0,4,1,""],get_source_from_archive:[0,4,1,""],get_source_from_cvs:[0,4,1,""],get_source_from_dir:[0,4,1,""],get_source_from_git:[0,4,1,""],get_source_from_svn:[0,4,1,""]},"commands.source.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template":{Command:[0,1,1,""],TParam:[0,1,1,""],TemplateSettings:[0,1,1,""],get_dico_param:[0,4,1,""],get_template_info:[0,4,1,""],prepare_from_template:[0,4,1,""],search_template:[0,4,1,""]},"commands.template.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template.TParam":{check_value:[0,2,1,""]},"commands.template.TemplateSettings":{check_file_for_substitution:[0,2,1,""],check_user_values:[0,2,1,""],get_parameters:[0,2,1,""],get_pyconf_parameters:[0,2,1,""],has_pyconf:[0,2,1,""]},"commands.test":{Command:[0,1,1,""],ask_a_path:[0,4,1,""],check_remote_machine:[0,4,1,""],create_test_report:[0,4,1,""],generate_history_xml_path:[0,4,1,""],move_test_results:[0,4,1,""],save_file:[0,4,1,""]},"commands.test.Command":{check_option:[0,2,1,""],getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"src.ElementTree":{Comment:[3,4,1,""],Element:[3,4,1,""],ElementTree:[3,1,1,""],PI:[3,4,1,""],ProcessingInstruction:[3,4,1,""],QName:[3,1,1,""],SubElement:[3,4,1,""],TreeBuilder:[3,1,1,""],XML:[3,4,1,""],XMLTreeBuilder:[3,1,1,""],dump:[3,4,1,""],fromstring:[3,4,1,""],iselement:[3,4,1,""],iterparse:[3,1,1,""],parse:[3,4,1,""],tostring:[3,4,1,""]},"src.ElementTree.ElementTree":{find:[3,2,1,""],findall:[3,2,1,""],findtext:[3,2,1,""],getiterator:[3,2,1,""],getroot:[3,2,1,""],parse:[3,2,1,""],write:[3,2,1,""]},"src.ElementTree.TreeBuilder":{close:[3,2,1,""],data:[3,2,1,""],end:[3,2,1,""],start:[3,2,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[3,2,1,""],doctype:[3,2,1,""],feed:[3,2,1,""]},"src.ElementTree.iterparse":{next:[3,2,1,""]},"src.architecture":{get_distrib_version:[3,4,1,""],get_distribution:[3,4,1,""],get_nb_proc:[3,4,1,""],get_python_version:[3,4,1,""],get_user:[3,4,1,""],is_windows:[3,4,1,""]},"src.catchAll":{CatchAll:[3,1,1,""],dumper:[3,4,1,""],dumperType:[3,4,1,""],jsonDumps:[3,4,1,""]},"src.catchAll.CatchAll":{jsonDumps:[3,2,1,""]},"src.colorama":{ansi:[4,0,0,"-"],ansitowin32:[4,0,0,"-"],initialise:[4,0,0,"-"],win32:[4,0,0,"-"],winterm:[4,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[4,1,1,""],AnsiCodes:[4,1,1,""],AnsiCursor:[4,1,1,""],AnsiFore:[4,1,1,""],AnsiStyle:[4,1,1,""],clear_line:[4,4,1,""],clear_screen:[4,4,1,""],code_to_chars:[4,4,1,""],set_title:[4,4,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[4,2,1,""],DOWN:[4,2,1,""],FORWARD:[4,2,1,""],POS:[4,2,1,""],UP:[4,2,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[4,3,1,""],DIM:[4,3,1,""],NORMAL:[4,3,1,""],RESET_ALL:[4,3,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[4,1,1,""],StreamWrapper:[4,1,1,""],is_a_tty:[4,4,1,""],is_stream_closed:[4,4,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[4,3,1,""],ANSI_OSC_RE:[4,3,1,""],call_win32:[4,2,1,""],convert_ansi:[4,2,1,""],convert_osc:[4,2,1,""],extract_params:[4,2,1,""],get_win32_calls:[4,2,1,""],reset_all:[4,2,1,""],should_wrap:[4,2,1,""],write:[4,2,1,""],write_and_convert:[4,2,1,""],write_plain_text:[4,2,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[4,2,1,""]},"src.colorama.initialise":{colorama_text:[4,4,1,""],deinit:[4,4,1,""],init:[4,4,1,""],reinit:[4,4,1,""],reset_all:[4,4,1,""],wrap_stream:[4,4,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[4,4,1,""],winapi_test:[4,4,1,""]},"src.colorama.winterm":{WinColor:[4,1,1,""],WinStyle:[4,1,1,""],WinTerm:[4,1,1,""]},"src.colorama.winterm.WinColor":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],GREY:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[4,3,1,""],BRIGHT_BACKGROUND:[4,3,1,""],NORMAL:[4,3,1,""]},"src.colorama.winterm.WinTerm":{back:[4,2,1,""],cursor_adjust:[4,2,1,""],erase_line:[4,2,1,""],erase_screen:[4,2,1,""],fore:[4,2,1,""],get_attrs:[4,2,1,""],get_position:[4,2,1,""],reset_all:[4,2,1,""],set_attrs:[4,2,1,""],set_console:[4,2,1,""],set_cursor_position:[4,2,1,""],set_title:[4,2,1,""],style:[4,2,1,""]},"src.coloringSat":{ColoringStream:[3,1,1,""],cleanColors:[3,4,1,""],indent:[3,4,1,""],log:[3,4,1,""],replace:[3,4,1,""],toColor:[3,4,1,""],toColor_AnsiToWin32:[3,4,1,""]},"src.coloringSat.ColoringStream":{flush:[3,2,1,""],write:[3,2,1,""]},"src.compilation":{Builder:[3,1,1,""]},"src.compilation.Builder":{build_configure:[3,2,1,""],check:[3,2,1,""],cmake:[3,2,1,""],complete_environment:[3,2,1,""],configure:[3,2,1,""],do_batch_script_build:[3,2,1,""],do_default_build:[3,2,1,""],do_python_script_build:[3,2,1,""],do_script_build:[3,2,1,""],hack_libtool:[3,2,1,""],install:[3,2,1,""],log:[3,2,1,""],log_command:[3,2,1,""],make:[3,2,1,""],prepare:[3,2,1,""],put_txt_log_in_appli_log_dir:[3,2,1,""],wmake:[3,2,1,""]},"src.configManager":{ConfigManager:[3,1,1,""],ConfigOpener:[3,1,1,""],check_path:[3,4,1,""],getConfigColored:[3,4,1,""],get_config_children:[3,4,1,""],get_products_list:[3,4,1,""],print_debug:[3,4,1,""],print_value:[3,4,1,""],show_patchs:[3,4,1,""],show_product_info:[3,4,1,""]},"src.configManager.ConfigManager":{create_config_file:[3,2,1,""],get_command_line_overrides:[3,2,1,""],get_config:[3,2,1,""],get_user_config_file:[3,2,1,""],set_user_config_file:[3,2,1,""]},"src.configManager.ConfigOpener":{get_path:[3,2,1,""]},"src.debug":{InStream:[3,1,1,""],OutStream:[3,1,1,""],format_color_exception:[3,4,1,""],getLocalEnv:[3,4,1,""],getStrConfigDbg:[3,4,1,""],getStrConfigStd:[3,4,1,""],indent:[3,4,1,""],pop_debug:[3,4,1,""],push_debug:[3,4,1,""],saveConfigDbg:[3,4,1,""],saveConfigStd:[3,4,1,""],tofix:[3,4,1,""],write:[3,4,1,""]},"src.debug.OutStream":{close:[3,2,1,""]},"src.environment":{Environ:[3,1,1,""],FileEnvWriter:[3,1,1,""],SalomeEnviron:[3,1,1,""],Shell:[3,1,1,""],load_environment:[3,4,1,""]},"src.environment.Environ":{append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[3,2,1,""],write_env_file:[3,2,1,""]},"src.environment.SalomeEnviron":{add_comment:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],dump:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],get_names:[3,2,1,""],is_defined:[3,2,1,""],load_cfg_environment:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],run_simple_env_script:[3,2,1,""],set:[3,2,1,""],set_a_product:[3,2,1,""],set_application_env:[3,2,1,""],set_cpp_env:[3,2,1,""],set_full_environ:[3,2,1,""],set_products:[3,2,1,""],set_python_libdirs:[3,2,1,""],set_salome_generic_product_env:[3,2,1,""],set_salome_minimal_product_env:[3,2,1,""]},"src.environs":{print_grep_environs:[3,4,1,""],print_split_environs:[3,4,1,""],print_split_pattern_environs:[3,4,1,""]},"src.example":{essai_logging_1:[5,0,0,"-"],essai_logging_2:[5,0,0,"-"]},"src.example.essai_logging_1":{getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2":{MyFormatter:[5,1,1,""],getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2.MyFormatter":{format:[5,2,1,""]},"src.exceptionSat":{ExceptionSat:[3,5,1,""]},"src.fileEnviron":{BashFileEnviron:[3,1,1,""],BatFileEnviron:[3,1,1,""],ContextFileEnviron:[3,1,1,""],FileEnviron:[3,1,1,""],LauncherFileEnviron:[3,1,1,""],ScreenEnviron:[3,1,1,""],get_file_environ:[3,4,1,""],special_path_separator:[3,4,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[3,2,1,""],finish:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[3,2,1,""],add_warning:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[3,2,1,""],add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],change_to_launcher:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],set:[3,2,1,""],write:[3,2,1,""]},"src.fork":{batch:[3,4,1,""],batch_salome:[3,4,1,""],launch_command:[3,4,1,""],show_progress:[3,4,1,""],write_back:[3,4,1,""]},"src.loggingSat":{DefaultFormatter:[3,1,1,""],UnittestFormatter:[3,1,1,""],UnittestStream:[3,1,1,""],dirLogger:[3,4,1,""],getDefaultLogger:[3,4,1,""],getUnittestLogger:[3,4,1,""],indent:[3,4,1,""],indentUnittest:[3,4,1,""],initLoggerAsDefault:[3,4,1,""],initLoggerAsUnittest:[3,4,1,""],log:[3,4,1,""],testLogger_1:[3,4,1,""]},"src.loggingSat.DefaultFormatter":{format:[3,2,1,""],setColorLevelname:[3,2,1,""]},"src.loggingSat.UnittestFormatter":{format:[3,2,1,""]},"src.loggingSat.UnittestStream":{flush:[3,2,1,""],getLogs:[3,2,1,""],getLogsAndClear:[3,2,1,""],write:[3,2,1,""]},"src.options":{OptResult:[3,1,1,""],Options:[3,1,1,""]},"src.options.Options":{add_option:[3,2,1,""],debug_write:[3,2,1,""],getDetailOption:[3,2,1,""],get_help:[3,2,1,""],indent:[3,2,1,""],parse_args:[3,2,1,""]},"src.product":{check_config_exists:[3,4,1,""],check_installation:[3,4,1,""],get_base_install_dir:[3,4,1,""],get_install_dir:[3,4,1,""],get_product_components:[3,4,1,""],get_product_config:[3,4,1,""],get_product_dependencies:[3,4,1,""],get_product_section:[3,4,1,""],get_products_infos:[3,4,1,""],product_compiles:[3,4,1,""],product_has_env_script:[3,4,1,""],product_has_logo:[3,4,1,""],product_has_patches:[3,4,1,""],product_has_salome_gui:[3,4,1,""],product_has_script:[3,4,1,""],product_is_SALOME:[3,4,1,""],product_is_autotools:[3,4,1,""],product_is_cmake:[3,4,1,""],product_is_cpp:[3,4,1,""],product_is_debug:[3,4,1,""],product_is_dev:[3,4,1,""],product_is_fixed:[3,4,1,""],product_is_generated:[3,4,1,""],product_is_mpi:[3,4,1,""],product_is_native:[3,4,1,""],product_is_salome:[3,4,1,""],product_is_sample:[3,4,1,""],product_is_smesh_plugin:[3,4,1,""],product_is_vcs:[3,4,1,""]},"src.pyconf":{Config:[3,1,1,""],ConfigError:[3,5,1,""],ConfigFormatError:[3,5,1,""],ConfigInputStream:[3,1,1,""],ConfigList:[3,1,1,""],ConfigMerger:[3,1,1,""],ConfigOutputStream:[3,1,1,""],ConfigReader:[3,1,1,""],ConfigResolutionError:[3,5,1,""],Container:[3,1,1,""],Expression:[3,1,1,""],Mapping:[3,1,1,""],Reference:[3,1,1,""],Sequence:[3,1,1,""],deepCopyMapping:[3,4,1,""],defaultMergeResolve:[3,4,1,""],defaultStreamOpener:[3,4,1,""],isWord:[3,4,1,""],makePath:[3,4,1,""],overwriteMergeResolve:[3,4,1,""]},"src.pyconf.Config":{Namespace:[3,1,1,""],addNamespace:[3,2,1,""],getByPath:[3,2,1,""],load:[3,2,1,""],removeNamespace:[3,2,1,""]},"src.pyconf.ConfigInputStream":{close:[3,2,1,""],read:[3,2,1,""],readline:[3,2,1,""]},"src.pyconf.ConfigList":{getByPath:[3,2,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[3,2,1,""],merge:[3,2,1,""],mergeMapping:[3,2,1,""],mergeSequence:[3,2,1,""],overwriteKeys:[3,2,1,""]},"src.pyconf.ConfigOutputStream":{close:[3,2,1,""],flush:[3,2,1,""],write:[3,2,1,""]},"src.pyconf.ConfigReader":{getChar:[3,2,1,""],getToken:[3,2,1,""],load:[3,2,1,""],location:[3,2,1,""],match:[3,2,1,""],parseFactor:[3,2,1,""],parseKeyValuePair:[3,2,1,""],parseMapping:[3,2,1,""],parseMappingBody:[3,2,1,""],parseReference:[3,2,1,""],parseScalar:[3,2,1,""],parseSequence:[3,2,1,""],parseSuffix:[3,2,1,""],parseTerm:[3,2,1,""],parseValue:[3,2,1,""],setStream:[3,2,1,""]},"src.pyconf.Container":{evaluate:[3,2,1,""],setPath:[3,2,1,""],writeToStream:[3,2,1,""],writeValue:[3,2,1,""]},"src.pyconf.Expression":{evaluate:[3,2,1,""]},"src.pyconf.Mapping":{addMapping:[3,2,1,""],get:[3,2,1,""],iteritems:[3,2,1,""],iterkeys:[3,2,1,""],keys:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Reference":{addElement:[3,2,1,""],findConfig:[3,2,1,""],resolve:[3,2,1,""]},"src.pyconf.Sequence":{SeqIter:[3,1,1,""],append:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Sequence.SeqIter":{next:[3,2,1,""]},"src.returnCode":{ReturnCode:[3,1,1,""]},"src.returnCode.ReturnCode":{KFSYS:[3,3,1,""],KNOWNFAILURE_STATUS:[3,3,1,""],KOSYS:[3,3,1,""],KO_STATUS:[3,3,1,""],NASYS:[3,3,1,""],NA_STATUS:[3,3,1,""],NDSYS:[3,3,1,""],OKSYS:[3,3,1,""],OK_STATUS:[3,3,1,""],TIMEOUT_STATUS:[3,3,1,""],TOSYS:[3,3,1,""],UNKNOWN_STATUS:[3,3,1,""],getValue:[3,2,1,""],getWhy:[3,2,1,""],indent:[3,2,1,""],isOk:[3,2,1,""],raiseIfKo:[3,2,1,""],setStatus:[3,2,1,""],setValue:[3,2,1,""],setWhy:[3,2,1,""],toSys:[3,2,1,""]},"src.salomeTools":{Sat:[3,1,1,""],assumeAsList:[3,4,1,""],find_command_list:[3,4,1,""],getCommandsList:[3,4,1,""],getVersion:[3,4,1,""],launchSat:[3,4,1,""],setLocale:[3,4,1,""],setNotLocale:[3,4,1,""]},"src.salomeTools.Sat":{assumeAsList:[3,2,1,""],execute_cli:[3,2,1,""],getColoredVersion:[3,2,1,""],getCommandAndAppli:[3,2,1,""],getCommandInstance:[3,2,1,""],getConfig:[3,2,1,""],getConfigManager:[3,2,1,""],getLogger:[3,2,1,""],getModule:[3,2,1,""],get_help:[3,2,1,""],parseArguments:[3,2,1,""],print_help:[3,2,1,""]},"src.system":{archive_extract:[3,4,1,""],cvs_extract:[3,4,1,""],git_extract:[3,4,1,""],show_in_editor:[3,4,1,""],svn_extract:[3,4,1,""]},"src.template":{MyTemplate:[3,1,1,""],substitute:[3,4,1,""]},"src.template.MyTemplate":{delimiter:[3,3,1,""],pattern:[3,3,1,""]},"src.test_module":{Test:[3,1,1,""],getTmpDirDEFAULT:[3,4,1,""]},"src.test_module.Test":{generate_launching_commands:[3,2,1,""],generate_script:[3,2,1,""],get_test_timeout:[3,2,1,""],get_tmp_dir:[3,2,1,""],prepare_testbase:[3,2,1,""],prepare_testbase_from_dir:[3,2,1,""],prepare_testbase_from_git:[3,2,1,""],prepare_testbase_from_svn:[3,2,1,""],read_results:[3,2,1,""],run_all_tests:[3,2,1,""],run_grid_tests:[3,2,1,""],run_script:[3,2,1,""],run_session_tests:[3,2,1,""],run_testbase_tests:[3,2,1,""],run_tests:[3,2,1,""],search_known_errors:[3,2,1,""],write_test_margin:[3,2,1,""]},"src.utilsSat":{Path:[3,1,1,""],black:[3,4,1,""],blue:[3,4,1,""],check_config_has_application:[3,4,1,""],check_config_has_profile:[3,4,1,""],config_has_application:[3,4,1,""],critical:[3,4,1,""],cyan:[3,4,1,""],date_to_datetime:[3,4,1,""],deepcopy_list:[3,4,1,""],ensure_path_exists:[3,4,1,""],error:[3,4,1,""],find_file_in_lpath:[3,4,1,""],formatTuples:[3,4,1,""],formatValue:[3,4,1,""],get_base_path:[3,4,1,""],get_cfg_param:[3,4,1,""],get_launcher_name:[3,4,1,""],get_log_path:[3,4,1,""],get_property_in_product_cfg:[3,4,1,""],get_salome_version:[3,4,1,""],get_tmp_filename:[3,4,1,""],green:[3,4,1,""],handleRemoveReadonly:[3,4,1,""],header:[3,4,1,""],info:[3,4,1,""],label:[3,4,1,""],list_log_file:[3,4,1,""],logger_info_tuples:[3,4,1,""],magenta:[3,4,1,""],merge_dicts:[3,4,1,""],normal:[3,4,1,""],only_numbers:[3,4,1,""],parse_date:[3,4,1,""],read_config_from_a_file:[3,4,1,""],red:[3,4,1,""],remove_item_from_list:[3,4,1,""],replace_in_file:[3,4,1,""],reset:[3,4,1,""],show_command_log:[3,4,1,""],success:[3,4,1,""],timedelta_total_seconds:[3,4,1,""],update_hat_xml:[3,4,1,""],warning:[3,4,1,""],white:[3,4,1,""],yellow:[3,4,1,""]},"src.utilsSat.Path":{base:[3,2,1,""],chmod:[3,2,1,""],copy:[3,2,1,""],copydir:[3,2,1,""],copyfile:[3,2,1,""],copylink:[3,2,1,""],dir:[3,2,1,""],exists:[3,2,1,""],isdir:[3,2,1,""],isfile:[3,2,1,""],islink:[3,2,1,""],list:[3,2,1,""],make:[3,2,1,""],readlink:[3,2,1,""],rm:[3,2,1,""],smartcopy:[3,2,1,""],symlink:[3,2,1,""]},"src.xmlManager":{ReadXmlFile:[3,1,1,""],XmlLogFile:[3,1,1,""],add_simple_node:[3,4,1,""],append_node_attrib:[3,4,1,""],find_node_by_attrib:[3,4,1,""],write_report:[3,4,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[3,2,1,""],get_attrib:[3,2,1,""],get_node_text:[3,2,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[3,2,1,""],append_node_attrib:[3,2,1,""],append_node_text:[3,2,1,""],write_tree:[3,2,1,""]},commands:{"package":[0,0,0,"-"],application:[0,0,0,"-"],check:[0,0,0,"-"],clean:[0,0,0,"-"],compile:[0,0,0,"-"],config:[0,0,0,"-"],configure:[0,0,0,"-"],environ:[0,0,0,"-"],find_duplicates:[0,0,0,"-"],generate:[0,0,0,"-"],init:[0,0,0,"-"],job:[0,0,0,"-"],jobs:[0,0,0,"-"],launcher:[0,0,0,"-"],log:[0,0,0,"-"],make:[0,0,0,"-"],makeinstall:[0,0,0,"-"],patch:[0,0,0,"-"],prepare:[0,0,0,"-"],profile:[0,0,0,"-"],run:[0,0,0,"-"],script:[0,0,0,"-"],shell:[0,0,0,"-"],source:[0,0,0,"-"],template:[0,0,0,"-"],test:[0,0,0,"-"]},src:{ElementTree:[3,0,0,"-"],architecture:[3,0,0,"-"],catchAll:[3,0,0,"-"],colorama:[4,0,0,"-"],coloringSat:[3,0,0,"-"],compilation:[3,0,0,"-"],configManager:[3,0,0,"-"],debug:[3,0,0,"-"],environment:[3,0,0,"-"],environs:[3,0,0,"-"],example:[5,0,0,"-"],exceptionSat:[3,0,0,"-"],fileEnviron:[3,0,0,"-"],fork:[3,0,0,"-"],loggingSat:[3,0,0,"-"],options:[3,0,0,"-"],product:[3,0,0,"-"],pyconf:[3,0,0,"-"],returnCode:[3,0,0,"-"],salomeTools:[3,0,0,"-"],system:[3,0,0,"-"],template:[3,0,0,"-"],test_module:[3,0,0,"-"],utilsSat:[3,0,0,"-"],xmlManager:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function","5":"py:exception"},terms:{"16be":3,"16le":3,"9abc":3,"boolean":[0,3,21],"case":[0,3],"char":3,"class":[0,3,4,5,21],"default":[0,3,6,8,9,10,12,13,14,15,20],"else":3,"export":15,"final":[3,9,15],"float":[0,3],"function":[0,3,4,21],"import":[3,10,21],"int":[0,3,13],"long":[3,7],"new":[0,3,15,21],"return":[0,3,10,21],"short":3,"true":[0,3,4],"try":3,"var":3,__init__:[3,5],__main__:3,__repr__:3,__save__:3,__setattr__:3,__str__:3,_appli:6,_basecmd:3,_basecommand:0,_blank:3,_build:10,_debug:3,_developp:3,_launch:10,_ld_library_path:10,_sre:[3,4],_type:3,_user:3,_verbos:3,a_b_c_:3,abool:3,about:[0,3,16],absolut:14,access:[4,13],account:10,act:[3,4],action:3,activ:[3,15],actual:[3,4,18],add:8,add_com:3,add_compile_config_fil:0,add_echo:3,add_fil:0,add_lin:3,add_module_to_appli:0,add_opt:[3,21],add_readm:0,add_salometool:0,add_simple_nod:3,add_warn:3,add_xml_board:0,addelement:3,addit:[0,3,8,16],additional_dir:3,additional_env:[0,3],addmap:3,addnamespac:3,adequ:3,advanc:3,affect:4,afil:3,after:[0,8,18],again:3,agent:15,aim:3,algorithm:21,alia:3,alias_path:0,alistofstr:0,all:[0,3,4,7,9,10,11,15,16,20,21],allow:[0,3,8,9,11,17,20],alphanumer:3,alreadi:[0,14,21],also:[0,3,10,15,16,21],alter:15,amount:3,ani:[0,3,4,9,13,15],anoth:[3,16],ansi:[],ansi_csi_re:4,ansi_escape_cod:4,ansi_osc_re:4,ansiback:4,ansicod:4,ansicursor:4,ansifor:4,ansistyl:4,ansitowin32:[],anyth:0,apart:4,apath:3,api:3,append:[3,10,14],append_node_attrib:3,append_node_text:3,append_valu:3,appli:[0,3,9,11,15],appli_dir:0,appli_gen:0,appli_path:0,application:[6,9,12],application_nam:6,application_tmp_dir:0,applilog:3,apply_patch:0,appropri:3,arch:14,architectur:[],archiv:[0,3,14,15],archive_extract:3,archive_info:15,arg:[3,4,21],arglist:3,argument:[0,3],argv:3,arrai:0,ascii:3,asctim:5,ask:[0,3],ask_a_path:0,ask_valu:0,assign:3,assum:3,assumeaslist:3,astr:3,astream:3,atitl:3,attibut:3,attr:[3,4],attrib:3,attribut:[3,4],authent:15,author:3,automat:[3,9,10],autoreset:4,autotool:[0,3,8],avail:9,avalu:3,avari:3,avoid:[0,15],award:3,back:4,backend:3,backtick:3,bar:0,base:[4,5],basenam:3,bash:[0,3,10,15],bashfileenviron:3,basic:[],bat:[3,10],batch:3,batch_salom:3,batfileenviron:3,becaus:3,been:[0,3,4],befor:[0,3,8],begin:3,begun:0,behavior:21,belong:3,below:10,between:[0,3],bienvenu:3,big:8,bin:10,binari:[0,14],binaries_dir_nam:0,binary_packag:0,biraries:0,black:[3,4],block:[],blogmatrix:3,blue:[3,4],board:0,bom:3,bonjour:21,bool:[0,3],boost:0,both:[3,10,11],bracket:3,branch:15,bright:4,bright_background:4,bring:[11,15],browser:[0,3,9,13,16],buf:3,build:[7,8,10,16],build_conf_opt:3,build_configur:[0,3],build_context:0,build_sourc:[0,8],builder:3,built:3,caa:3,call:[0,3,4,10,12,21],call_win32:4,callabl:3,can:[0,3,6,10,15,16,17,21],cancel:0,cancel_dependencies_of_failing_job:0,cannot:3,car:3,care:7,carri:3,catalog:[0,6,12],catalog_path:0,catchall:[],cfg:[0,3,10,21],cfg_env:3,cfgforpi:3,chang:[0,3,6,20,21],change_to_launch:3,channel:0,channelfil:0,charact:[3,4],charg:12,check_all_product:0,check_config_exist:3,check_config_has_appl:3,check_config_has_profil:3,check_depend:0,check_file_for_substitut:0,check_instal:3,check_module_gener:0,check_opt:0,check_path:[0,3],check_product:0,check_remote_machin:0,check_sourc:0,check_src:3,check_tim:0,check_user_valu:0,check_valu:0,check_yacsgen:0,checkout:[0,3,15],children:3,chmod:3,choic:9,choosen:3,circumst:3,clash:3,classic:3,clean_al:[0,8,20],clean_build_aft:8,clean_instal:8,cleancolor:3,clear_lin:4,clear_screen:4,clearpag:[6,7,8,9,10,11,12,13,14,15,17,20,21],cli:[3,13,20],cli_:21,cli_argu:3,client:3,clone:15,close:[0,3],closest:3,cmake:[0,3,8],cmake_opt:8,cmd:3,cmd_argument:0,cmd_list:[],co7:14,code:[4,10],code_to_char:4,color:[0,3,4],colorama:[],colorama_text:4,coloringsat:[],coloringstream:3,column:[0,3],com:[3,5],come:9,command_opt:20,command_valu:3,comment:[3,16],commentari:3,commit:7,commonli:3,compat:3,compil_script:8,compil_scripts_tmp_dir:0,compile_all_product:0,compile_product:0,compile_product_cmake_autotool:0,compile_product_script:0,complementari:10,complet:[3,8,9,15,16],complete_environ:3,compo:0,compo_nam:0,compon:[3,6,11],componon:11,compress:14,comput:[3,11,14],concaten:3,concern:15,conf_opt:0,conf_valu:0,config_fil:0,config_has_appl:3,config_job:0,configerror:3,configformaterror:3,configinputstream:3,configlist:3,configmanag:[],configmerg:3,configopen:3,configoutputstream:3,configread:[0,3],configresolutionerror:3,configure_all_product:0,configure_opt:3,configure_product:0,configut:6,conflict:3,conform:11,connect:0,consid:0,consist:3,consol:3,construct:[0,3,17,19],contain:[0,3,16,21],context:[0,3,20],contextfileenviron:3,continu:3,control:14,conveni:3,convert:4,convert_ansi:4,convert_osc:4,copi:[0,3,6,9,12,20],copy_catalog:0,copy_sat:0,copydir:3,copyfil:3,copylink:3,copyright:3,corba:11,correct:3,correctli:0,correl:3,correspond:[0,3,10,13,15],could:[0,3,7,10,18],cpp:[0,3,11],creat:[0,3,6,7,10,12,14,15,16,17],create_appl:0,create_config_fil:[0,3],create_project_for_src_packag:0,create_test_report:0,creation:14,critic:[3,5,21],critical:5,csv:0,current:[0,3,9,16,20,21],cursor_adjust:4,custom:[],customize_app:0,cvs:14,cvs_extract:3,cvs_info:15,cvspass:15,cwd:3,cyan:[3,4],d_content:0,d_input_board:0,d_sub:0,dai:[0,3],data:[0,3,9,21],datadir:3,date:[0,3,16],date_to_datetim:3,datefmt:[3,5],datetim:3,david:3,dbg:3,debug:[],debug_writ:3,decid:3,declar:15,dedic:0,deep:3,deepcopy_list:3,deepcopymap:3,def:[10,21],default_valu:3,defaultformatt:3,defaultmergeresolv:3,defaultstreamopen:3,defin:[0,3,7,8,9,10,11,16,21],define_job:0,definit:[0,3],deinit:4,delai:3,delaiapp:3,deleg:4,delet:[0,14],delimit:3,delta:3,depend:[0,3,8,14],deriv:3,describ:[0,3],descript:[],design:3,dest_path:0,destnam:3,detail:3,detar:18,detect:3,determin:3,determine_jobs_and_machin:0,dev:[],develop:[7,9,10,15],develop_factorized_job:0,dico:0,dict:[0,3],dict_arg:3,dictionari:[0,3,16],dictionnari:0,differ:[5,10],dim:4,dir:[0,3,9,15],dir_info:15,direct:3,directli:[10,13,18],directori:[0,3,6,7,8,9,10,12,13,14,15,16,18,20,21],directories_ignor:0,dirlogg:3,dirpath:3,displai:[0,3,8,9,13,21],display_local_valu:0,display_statu:0,display_value_progress:0,distant:6,disten:0,distinguish:10,distrib:3,distribut:[3,6,11],divis:3,do_batch_script_build:3,do_default_build:3,do_python_script_build:3,do_script_build:3,doc:[3,5],docstr:0,doctyp:3,document:[11,16],doe:[3,10,15],dog:3,dollar:3,don:11,done:[0,3,10,20],dosometh:3,dosomethingtoreturn:3,dot:3,dove:3,down:4,download:[3,15],dst:3,due:3,dump:3,dumper:3,dumpertyp:3,duplic:[0,8],durat:0,dure:15,dynam:[3,16],each:[0,3,6,12,15,16],earlier:3,earliest:3,echo:3,ecrir:[3,5],edf:0,edit:[0,9,15],editor:[3,9,16],either:[3,10],elaps:0,eleg:3,elem:3,element:[0,3],element_factori:3,elementari:3,elementtre:[],els:[0,3,21],embed:14,empti:3,enable_simple_env_script:3,encapsul:[],enclos:3,encod:3,end:[0,3,4,10],english:3,ensure:3,ensure_path_exist:3,enter:0,entir:3,entri:3,env:[0,3,10],env_build:10,env_fil:0,env_info:[0,3],env_launch:10,env_script:10,env_scripts_tmp_dir:0,equal:8,eras:13,erase_lin:4,erase_screen:4,err:0,error:[0,3,5,21],essai:5,essai_logging_1:[],essai_logging_2:[],etc:[0,3,16,17],etre:[0,3],etree:3,eval:3,evalu:3,evaluat:3,event:3,everi:0,everyth:8,exactli:3,exampl:[],exc:3,exceed:0,except:[3,15,20],exception:3,exceptionsat:[],exclud:0,exclude_vcs_and_extens:0,exec_command:0,execut:[0,3,8,15,20],execute_cli:3,exept:3,exhaust:[16,20],exist:[0,3,14,15,20],exit:[],exitstatu:[],exot:3,expect:[0,3],explain:10,explan:3,explicitli:3,explor:3,explore:9,express:[3,9],expression:3,ext:3,extend_with_children:0,extend_with_fath:0,extens:[0,3,21],extension_ignor:0,extern:3,extra:[0,3],extract:[0,3],extract_param:4,f_exclud:0,fact:21,factor:3,factori:3,fail:[0,3,8],fals:[0,3,4],far:3,favorit:9,feed:3,field:[0,3],file:[0,3,6,8,9,10,12,13,14,15,16,17,21],file_:0,file_board:0,file_dir:0,file_in:3,file_nam:[0,3],file_path:3,fileenviron:[],fileenvwrit:3,filenam:[0,3],filepath:[0,3],files_arb_out:0,files_ignor:0,files_out:0,fill:0,filnam:0,filter:[0,7],fin:3,find:[0,3,9,17,18],find_application_pyconf:0,find_command_list:3,find_file_in_lpath:3,find_histori:0,find_job_that_has_nam:0,find_node_by_attrib:3,find_product_scripts_and_pyconf:0,find_products_already_get:0,find_products_with_patch:0,find_test_log:0,findal:3,findconfig:3,findtext:3,finish:[0,3],finish_statu:0,firefox:[13,16],first:[0,3,10,15,21],fix:[0,3],flag:8,flaglin:0,flicacpp:0,flush:3,fmt:[3,5],folder:0,follow:[3,10,21],for_packag:3,forbuild:3,forc:[0,3,14,15],force_patch:15,fore:4,fork:[],form:3,format:[0,3,5,10,16],format_color_except:3,format_except:3,format_list_of_str:0,formatt:[3,5],formattupl:3,formatvalu:3,forward:[4,6,12],found:[0,3],four:10,french:21,from:[0,3,4,9,10,11,14,15,21],from_what:3,fromstr:3,full:[0,3],fun:9,func:3,futur:3,gap:0,gdb:10,gencat:[6,12],generate_appl:0,generate_catalog:0,generate_compon:0,generate_component_list:0,generate_history_xml_path:0,generate_launch_fil:0,generate_launching_command:3,generate_profile_sourc:0,generate_script:3,generic_opt:20,geom:[0,8],get:[9,15,16],get_all_product_sourc:0,get_arch:0,get_archives_vc:0,get_attr:4,get_attrib:3,get_base_install_dir:3,get_base_path:3,get_build_directori:0,get_cfg_param:3,get_children:0,get_command_line_overrid:3,get_config:3,get_config_children:3,get_config_file_path:0,get_dico_param:0,get_distrib_vers:3,get_distribut:3,get_file_environ:3,get_help:3,get_install_dir:3,get_install_directori:0,get_last_log_fil:0,get_launcher_nam:3,get_log_fil:0,get_log_path:3,get_method:15,get_nam:3,get_nb_proc:[0,3],get_node_text:3,get_paramet:0,get_path:3,get_pid:0,get_posit:4,get_product_compon:3,get_product_config:3,get_product_depend:3,get_product_sect:3,get_product_sourc:0,get_products_info:3,get_products_list:[0,3],get_profile_nam:0,get_property_in_product_cfg:3,get_pyconf_paramet:0,get_python_vers:3,get_recursive_children:0,get_recursive_fath:0,get_salome_modul:0,get_salome_vers:3,get_source_directori:0,get_source_for_dev:0,get_source_from_arch:0,get_source_from_cv:0,get_source_from_dir:0,get_source_from_git:0,get_source_from_svn:0,get_statu:0,get_step:0,get_template_info:0,get_test_timeout:3,get_tmp_dir:3,get_tmp_filenam:3,get_us:3,get_user_config_fil:3,get_win32_cal:4,getbypath:3,getchar:3,getcoloredvers:3,getcommandandappli:3,getcommandinst:3,getcommandslist:3,getconfig:[3,21],getconfigcolor:3,getconfigmanag:3,getdefaultlogg:3,getdetailopt:3,getiter:3,getlocalenv:3,getlog:3,getlogg:3,getlogsandclear:3,getmaxformat:0,getmodul:3,getmylogg:5,getoutput:[],getparamiko:0,getpars:0,getroot:3,getrootattrib:3,getstatu:[],getstatusoutput:[],getstrconfigdbg:3,getstrconfigstd:3,gettmpdir:3,gettmpdirdefault:3,gettoken:3,getunittestlogg:3,getvalu:3,getvers:3,getwhi:3,git:14,git_extract:3,git_info:15,gitconfig:15,give:[0,3,6,16,21],given:[0,3,4,6,10,12],global:[0,3],goe:3,green:[3,4],grep:[3,9],grey:4,grid:[0,3],gui:[0,3],hack_for_distene_lic:0,hack_libtool:3,had:3,handl:[3,4,10],handlemismatch:3,handler:[3,5],handleremovereadonli:3,harri:3,has_begun:0,has_fail:0,has_finish:0,has_gui:0,has_pyconf:0,has_salome_hui:3,has_timed_out:3,hat:3,have:[0,3,6,7,11,12,15],header:[0,3],help:[],helpstr:3,here:[0,3,10,16,21],hierarchi:3,himself:10,histori:0,hold:12,home:9,host:0,hostnam:0,hour:3,how:[3,10,15,16],html:[3,5],http:[3,4,5],human:3,hxx2salom:11,i18n:3,ident:[0,3],identifi:3,ignor:[0,3,11],ignore_exist:0,ignorelist:3,imag:15,implement:[3,4,10],in_dir:0,includ:[0,3,10,14,16],include:14,indent:3,indentunittest:3,index:3,indic:3,indirect:3,info:[0,3,5,9,15,21],inform:[0,3,9,14,15,16],inherit:3,initi:3,initialis:[],initialize_board:0,initiat:0,initloggerasdefault:3,initloggerasunittest:3,initmylogg:5,inmap:3,input:[0,3],input_list:3,insid:15,instal:[0,3,7,8,16,18,20],install:[0,7,20],install_dir:10,installat:[],instanc:[0,3,4,21],instanti:0,instantiat:3,instead:3,instream:3,instruct:[3,16],intal:14,integ:0,interact:[0,13],interfac:[3,20],intern:3,internation:3,interpret:[],invalid:3,ioerror:3,iostream:3,is_a_tti:4,is_defin:3,is_dev:0,is_occupi:0,is_run:0,is_salome_modul:[0,7,10],is_stream_clos:4,is_timeout:0,is_window:3,isdir:3,isel:3,isfil:3,islink:3,isok:3,issu:4,isword:3,item:3,iter:3,iteritem:3,iterkei:3,iterpars:3,ivar:3,jane:3,job_config_nam:0,job_def:0,job_fil:0,job_file_path:0,jobs_config:0,join:10,json:3,jsondump:3,just:8,keep:3,kei:[0,3,10,15],kernel:[0,9,20],kfsys:3,kill:0,kill_remote_process:0,killsalom:3,kind:0,know:[3,15],known:[3,14],knownfailure_status:3,ko_status:3,kosys:3,kwarg:4,kwd:4,l_cfg_dir:0,l_job:0,l_jobs_not_todai:0,l_path:0,l_pinfo_vc:0,l_product:0,l_products_info:0,l_remote_log_fil:0,l_salome_modul:0,l_str:0,label:[0,3,9],lang:3,lapack:10,lapack_root_dir:10,last:[0,3,10,13],last_termin:13,last_upd:0,later:14,latter:3,launch:[0,3,10],launch_command:3,launched_cmd:3,launcher_nam:[0,12],launcherfileenviron:3,launchsat:3,layer:11,ld_library_path:10,left:10,len_col:0,len_end:0,lenght:0,lenght_column:0,length:0,less:3,level:[3,5,20],levelnam:[3,5],lib:[5,10],librari:[3,5],licenc:0,light:[0,4],lightblack_ex:4,lightblue_ex:4,lightcyan_ex:4,lightgreen_ex:4,lightmagenta_ex:4,lightred_ex:4,lightwhite_ex:4,lightyellow_ex:4,like:[0,3,4,6,8,9,12,16],limit:3,line:[0,3,9,20],link:[0,3,15],list:[6,7,9,12,16],list_directori:0,list_log_fil:3,list_of_product:11,listtest:3,llvm:[6,12],load:[3,16],load_cfg_environ:3,load_environ:3,local:[0,3,9],locat:[0,3],log_command:3,log_dir:[0,13],log_res_step:0,log_step:0,logdir:[0,3],logfilepath:3,logger:5,logger_info_tupl:3,loggingsat:[],login:15,logo:[3,12],logs:3,lome:17,longnam:3,lost:3,lpath:[0,3],lproduct:3,machin:[0,3,6,11,12,14],machine1:6,machine2:6,machine3:6,machine_nam:0,magenta:[3,4],mai:15,main:[0,3,8],mainten:0,make_alia:0,make_all_product:0,make_arch:0,make_flag:8,make_opt:[0,3],make_product:0,makeinstall_all_product:0,makeinstall_product:0,makepath:3,manag:[0,3,9,15],manipul:[0,3,9],map1:3,map2:3,map:[0,3],match:3,max:3,max_product_name_len:0,maximum:0,mechan:[3,10],med:8,medcoupling:0,memori:[3,6,12],menu:13,merg:3,merge:3,merge_dict:3,mergemap:3,mergesequ:3,mesa:[6,12],messag:[0,3,5,21],method:[0,3,4,8,10,15,21],milou:3,minim:3,minut:3,mismatch:3,miss:[6,8],mistak:15,mix:0,mkdir:0,mode:[4,7,9,10,13],model:21,modifi:[0,3,10,15],module_gener:0,module_path:0,moment:3,mon:3,mond:21,more:[0,3,20],most:[0,3,10],move_test_result:0,msg:3,multi:3,multilin:3,multipl:3,must:[0,21],mutipl:3,my_application_directori:6,my_application_nam:6,my_job:0,my_product_nam:0,my_tag:15,mycommand:21,myformatt:5,mylogg:5,myoption:21,myspecificnam:14,mytempl:3,na_status:3,name:[0,3,6,7,9,10,12,14,15,16,20,21],name_arch:0,name_job:0,name_nod:3,name_product:0,namespac:3,nasys:3,nativ:[0,3,10],nb_line:3,nb_proc:[0,3,8],ndsys:3,necessari:3,need:[0,3,4,6,11,15],needs:0,new_nam:9,newer:0,newlin:[],next:3,nice:[],no_label:9,node:[0,3],node_nam:3,non:4,none:[0,3,4,5],nor:4,normal:[3,4],note:[6,10,12,16],noth:[0,3,14],notimplementederror:3,notion:3,notshowncommand:[0,3],now:0,number:[0,3,6,8,12,13],number_of_proc:3,numpi:0,obj1:3,obj2:3,obj:3,object:[0,3,4,16],obsolesc:0,obsolet:3,obsolete:21,obtain:3,obvious:3,occur:3,offset:0,ok_status:3,oksys:3,old:3,older:13,on_stderr:4,onc:15,one:3,onli:[0,3,6,7,8,9,10,11,12,13,15,20],only_numb:3,ool:17,open:3,openggl:[6,12],openmpi:3,oper:[0,3,9,17],operand:3,opt_nb_proc:3,option:[],optionali:3,optionn:3,optionnali:3,optiontyp:3,optresult:[0,3],order:[0,3,15,16,21],org:[3,4,5],other:[5,10,14,16],otherwis:[0,3,15],our:4,out:[0,3],out_dir:[0,3],output:[0,3,4],outstream:3,outtext:[],overrid:[3,6],overwrit:3,overwritekei:3,overwritemergeresolv:3,overwritten:3,own:3,p_info:0,p_name:0,p_name_info:0,p_name_p_info:0,pad:0,page:10,pair:[0,3],param:[3,4],param_def:0,param_nam:3,paramet:[0,3,9,16,21],parameter_path:9,paramiko:0,paramstr:4,paravi:[6,12],paraview:0,paravis:0,parent:[0,3],pars:[0,3,21],parse_arg:[3,21],parse_csv_board:0,parse_d:3,parseargu:3,parsefactor:3,parsekeyvaluepair:3,parsemap:[0,3],parsemappingbodi:3,parser:[3,21],parserefer:3,parsescalar:3,parsesequ:3,parsesuffix:3,parseterm:3,parsevalu:3,part:[3,6,10,12],particular:3,pass:[0,3,16,21],passphras:15,passwd:0,password:15,pat:3,patches_tmp_dir:0,path:[],path_in_arch:0,path_on_local_machin:0,path_to_catalog:6,path_to_check:0,path_to_yacsgen:11,pathlaunch:0,pathlist:3,paths:9,pattern:3,pdf:[9,17],pend:7,pendant:3,perform:[3,15,17],person:9,phase:3,pid:0,pipe:[],platform:[4,10],pleas:[10,11],plugin:[3,8],pluma:16,plusieur:5,point:[3,21],pop_debug:3,popen:3,popul:3,port:0,pos:4,posit:4,possibl:[0,3,10,15,21],post:3,potenti:3,pprty:3,preced:3,predefin:3,prefer:[9,16],prefix:[0,3,10,16],prepare_from_templ:0,prepare_testbas:3,prepare_testbase_from_dir:3,prepare_testbase_from_git:3,prepare_testbase_from_svn:3,prepend:[3,10],prepend_valu:3,prereq_dir:10,prerequisit:[10,14,16,17,20],presenc:3,present:3,pretti:3,previou:[0,3],previous:7,print:[0,3,4,9,13],print_debug:3,print_grep_environ:3,print_help:3,print_log_command_in_termin:0,print_split_environ:3,print_split_pattern_environ:3,print_valu:3,problem:[3,6,12],procedur:[0,3],process:[0,3,15],processinginstruct:3,processor:[0,3,6,12],prod_dir:3,prod_info:[0,3],prod_nam:0,produc:[0,3],produce_install_bin_fil:0,produce_relative_env_fil:0,produce_relative_launch:0,product1:[8,10,15],product2:[8,10,15],product:[],product_appli_creation_script:0,product_cfg:3,product_compil:3,product_has_dir:0,product_has_env_script:3,product_has_logo:3,product_has_patch:3,product_has_salome_gui:3,product_has_script:3,product_info:[0,3],product_inform:[0,3],product_is_autotool:3,product_is_cmak:3,product_is_cpp:3,product_is_debug:3,product_is_dev:3,product_is_fix:3,product_is_gener:3,product_is_mpi:3,product_is_n:3,product_is_salom:3,product_is_salome:3,product_is_sampl:3,product_is_smesh_plugin:3,product_is_vc:3,product_log_dir:0,product_nam:[0,3],products_info:0,products_pyconf_tmp_dir:0,profileconfigread:0,profilerefer:0,program:3,programmat:10,progress:[0,3],progress_bar:0,project:[0,3,9,10],project_file_path:0,project_packag:0,project_path:3,projects:3,prop:0,proper:0,properti:[0,3,7,10,11],protocol:[3,6],provid:[0,3,10,21],proxi:4,pubid:3,publish:0,pure:0,push:15,push_debug:3,put:[0,3],put_dir:0,put_jobs_not_todai:0,put_txt_log_in_appli_log_dir:3,pv_plugin_path:3,pwd:3,pyc:5,pyconf:[],python2:5,python:[0,3,5,10,12,16,17,18,21],python_config:3,pythoncompon:0,pythonpath:10,pythonpath_:10,qname:3,queri:[6,12],question:3,rais:[3,20],raiseifko:3,raw:3,raw_input:0,rc1:3,rc2:3,rcfinal:3,rco:[0,3],reach:0,read:[0,3],read_config_from_a_fil:3,read_result:3,readabl:3,reader:3,readi:15,readlin:3,readlink:3,readxmlfil:3,record:[3,5],recurs:[0,3,9],red:[3,4],redefin:3,redirect:3,reduc:0,ref:3,refer:[0,3,11,16],reflect:3,regard:[0,3],regular:3,reinit:[3,4],rel:[0,3,14],remain:[13,18],remark:6,remor:11,remot:[0,3,14],remov:[0,3,7,8,15],remove_item_from_list:3,remove_log_fil:0,remove_product:0,removenamespac:3,renam:3,renint:3,replac:[0,3,6],replace_in_fil:3,report:[0,3],repositori:[0,3,15],repr:3,repres:3,represent:3,request:4,requir:[4,10,11],reserv:3,reset:[3,4],reset_al:4,reset_all:4,resolut:3,resolv:3,resourc:[6,12],respect:10,restor:[3,7],result:[0,3],retcod:0,retriev:3,returncod:[],right:[0,3,10],root:[3,21],root_nod:3,rootnam:3,rtype:3,run_all_test:3,run_env_script:3,run_grid_test:3,run_job:0,run_script:3,run_script_all_product:0,run_script_of_product:0,run_session_test:3,run_simple_env_script:3,run_test:3,run_testbase_test:3,runappli:6,runner:[0,3,21],ruud:3,sajip:3,salom:[6,10,12],salome:[6,7,8,9,10,11,12,14,16,18],salome_modules:3,salome_session_serv:3,salome_xx:[7,14,18,20],salome_xx_:14,salomeapp:0,salomecontext:3,salomeenviron:3,salometool:[],same:[0,3],sametmax:[3,5],sampl:3,samples:20,sat:[6,7,8,9,10,11,12,13,14,15,16,18],sat_local_path:0,sat_path:0,save:10,save_fil:0,saveconfigdbg:3,saveconfigstd:3,scalar:3,scratch:3,screenenviron:3,script_nam:3,script_path:3,search:[0,3],search_known_error:3,search_templ:0,second:[0,3,10],section:[6,10,15],secur:15,see:[0,3,4,16,20],seen:3,select:[3,14],self:[0,3],semant:3,sep:[3,10],separ:3,seq1:3,seq2:3,seq:3,seqiter:3,sequenc:[3,4],server:[3,15],servic:21,session:[0,3],set:[0,3,6,7,10,12,16,17,21],set_a_product:3,set_application_env:3,set_attr:4,set_consol:4,set_cpp_env:3,set_cursor_posit:4,set_env:[3,10],set_env_build:10,set_env_launch:10,set_full_environ:3,set_local_valu:0,set_native_env:[3,10],set_product:3,set_python_libdir:3,set_salome_generic_product_env:3,set_salome_minimal_product_env:3,set_titl:4,set_user_config_fil:3,setcolorlevelnam:3,setconsoletextattribut:4,setlocal:3,setnotlocal:3,setpath:3,setstatu:3,setstream:3,settings_fil:0,setvalu:3,setwhi:3,sever:[0,10,16],shallow:3,shortcut:3,shortnam:3,should:[3,10,11],should_wrap:4,show:[0,3,8,13],show_command_log:3,show_desktop:3,show_full_path:3,show_in_editor:3,show_label:3,show_last_log:0,show_patch:[0,3,9],show_product_info:3,show_product_last_log:0,show_progress:3,show_warn:3,showinfo:3,shown:[3,8],sign:3,silent:[0,3],similar:3,simpl:[3,20,21],sinc:[0,3],site:0,size:[0,3],slogan:0,small:3,smart:3,smartcopi:3,smesh:3,softwar:15,some:[],someon:10,sometim:7,sommeil:3,soon:8,sort:0,sort_product:0,source_dir:0,source_packag:0,sourcepackag:0,sources:[7,15,20],sources_without_dev:7,space:3,special_path_separ:3,specif:[0,3,6,7,10,11,12,14,16,20],specifi:[3,6,10,11,12,15],splashscreen:12,split:3,src:[],src_root:[0,3],sre_pattern:[3,4],srsc:3,ssh:[0,6,12,15],ssh_connection_all_machin:0,stack:[3,20],stackoverflow:3,start:[4,6,8,12],state:0,statu:[0,3],stderr:[0,3],stdin:0,stdout:[0,3,4],step:[0,3],stop:[0,8],stop_first_fail:8,store:[0,3,8,9,13,15,16],str:[0,3],str_in:3,str_num:3,str_of_length:0,str_out:3,stream:[0,3,4],streamopen:3,streamorfil:3,streamwrapp:4,strftime:[3,5],string:[0,3],stringio:3,strip:4,strorlist:3,structur:16,stuff:[3,12],style:[0,3,4],stylesheet:[0,3],sub:[0,3,16],subclass:3,subelement:3,subpackag:[],subprocess:3,subsect:10,subset:14,subst_dic:3,substitut:[0,3],substr:3,subtract:3,succe:0,success:[0,3,8],success_fail:0,successfulli:3,successfully_connect:0,suffici:10,suffix:[0,3],suit:17,suitabl:3,sum:3,summari:[],support:3,suppos:3,supposedli:3,suppress:[0,7],suppress_directori:0,sur:5,svn:14,svn_extract:3,svn_info:15,symlink:3,syntax:7,syss:3,system:[],tab:3,tabl:3,tabul:3,tag:[3,15],take:[0,3,7],taken:[3,10],tar:[0,14,18],tarfil:0,target:[0,3,6,10],target_dir:0,tcllibpath:3,template_fil:3,template_nam:0,templateset:0,temporari:0,term:3,termin:[0,3,4,8,13,21],test_bas:0,test_base_nam:3,test_config:3,test_grid:3,test_modul:[],test_nam:3,test_sess:3,testbas:3,testbase_bas:3,testbase_dir:3,testbase_nam:3,testbase_tag:3,testlogger1:5,testlogger_1:3,text:[0,3,4,20],text_or_uri:3,tgz:[14,18],thank:3,thei:[0,7,9,10,15],them:[4,15],thi:[0,3,4,6,8,9,10,11,12,14,15,16,17,21],thing:21,those:11,through:[3,6,10,12,13],thrown:3,time:[0,3,5,7,10,15,16],time_elaps:0,timedelta:3,timedelta_total_second:3,timeout:[0,3],timeout_status:3,tintin:3,tip:3,titl:[3,4],tklibpath:3,tmp:[0,3],tmp_working_dir:[0,3],tocolor:3,tocolor_ansitowin32:3,todai:0,todo:3,tofix:3,token:3,token_typ:3,token_valu:3,too:3,top:3,tosi:3,tostr:3,tosys:3,total:0,total_dur:0,total_second:3,tout:21,tparam:0,trace:[0,3,20],traceback:3,trail:[],transform:[0,3],transpar:4,tree:3,treebuild:3,trust_root_dir:10,tty:4,tupl:[0,3],turn:3,tutori:3,two:[3,10],txt:3,type:[0,3,15],typeerror:3,unabl:3,unchang:3,unconditionali:[3,20],under:[0,3,17],underscor:[3,10],unicod:3,unit:8,unittest:3,unittestformatt:3,unitteststream:3,unix:3,unknown_status:3,unless:[4,15],updat:0,update:[0,3],update_config:0,update_hat_xml:3,update_jobs_states_list:0,update_pyconf:0,update_xml_fil:0,updatehatxml:3,upload:0,urllib2:3,urlopen:3,usag:[3,20],use:[0,6,7,8,9,10,11,12,15],use_mesa:[6,12],used:[0,3],useful:[3,20],user:[9,10,13,14],usernam:3,username:3,users:9,using:21,usr:[3,5,10],usual:[3,7,11,14,16,20],usualli:[14,18],utf:[3,10],util:[3,14,17],utilis:5,utiliti:3,utilssat:[],uts:3,val:0,valid:3,valmax:0,valmin:0,valu:[0,3,4,6,7,9,15,16],variabl:[0,3,10,11,21],vars:10,vcs:[7,14],verbos:[],verifi:[0,3,15],version:[0,3,10,11,14,16,17],via:3,viewer:9,vinai:3,virtual:[3,6],virtual_app:6,visualis:10,wai:[0,3,8,21],wait:0,want:[0,3,7,10],warn:[0,3,5,8,21],warning:[3,5],web:[9,13,16],week:0,welcom:3,welkom:3,well:3,were:3,what:[0,3,7],when:[0,3,6,10,15,16,21],whenev:3,where:[0,3,6,8,9,14],which:[0,3,4,10,11,16,21],white:[3,4],who:11,why:3,width:0,wiki:4,wikipedia:4,wil:10,win32:[],winapi_test:4,wincolor:4,window:[3,4,10],winstyl:4,winterm:[],with_children:8,with_commerci:[0,3],with_fath:8,with_install_dir:3,with_vc:[0,14],within:10,without:[3,9,15],without_dev:0,without_native_fix:0,without_properti:14,wmake:3,word:3,work:[0,3,9,14,15,16],workdir:[3,6,9,12,14,16,20,21],world:21,would:3,wrap:[3,4],wrap_stream:4,writabl:3,write:[0,3,4,21],write_all_result:0,write_all_source_fil:0,write_and_convert:4,write_back:3,write_cfgforpy_fil:3,write_env_fil:3,write_info:0,write_plain_text:4,write_report:3,write_result:0,write_test_margin:3,write_tre:3,write_xml_fil:0,writetostream:3,writevalu:3,written:21,www:3,xa4:3,xc2:3,xml:[0,3,21],xml_dir_path:0,xml_file:0,xml_history_path:0,xml_node_job:0,xmllogfil:[0,3],xmlmanag:[],xmlmgr:3,xmlname:0,xmlroot:3,xmltreebuild:3,xxx:[3,7,16],xxx_root_dir:3,xxx_src_dir:3,yacsgen:[0,3,11],yacsgen_root_dir:11,year:3,yellow:[3,4],yet:[3,20],yield:3,you:[0,3,6,7,10,12,15,17,21],your:[0,3,10,15,20,21],yourspecificnam:14,yve:3,yyy:16,yyyy:3,yyyymmdd_hhmmss:3,yyyymmdd_hhmmss_namecmd:3,zelaunch:12,zero:3,zerodivideerror:3},titles:["commands package","commands","src","src package","src.colorama package","src.example package","Command application","Command clean","Command compile","Command config","Command environ","Command generate","Command launcher","Command log","Command package","Command prepare","Configuration","Salome Tools","Installation","Release notes","Usage of SAlomeTools","Add a user custom command"],titleterms:{access:21,add:21,ansi:4,ansitowin32:4,applic:[0,6],application:16,architectur:3,avail:20,availabl:7,base:15,basic:21,build:20,catchall:3,check:0,clean:[0,7],code:17,colorama:4,coloringsat:3,command:[0,1,6,7,8,9,10,11,12,13,14,15,17,21],compil:[0,3,8,20],config:[0,9,21],configmanag:3,configur:[0,6,7,8,9,10,12,13,14,15,16],content:[0,3,4,5],custom:21,debug:[3,20],descript:[6,7,8,9,10,11,12,13,14,15,16],dev:15,develop:17,document:17,elementtre:3,environ:[0,3,10],essai_logging_1:5,essai_logging_2:5,exampl:[5,21],exceptionsat:3,fileenviron:3,find_dupl:0,fork:3,gener:[0,11],get:20,git:15,hello:21,help:20,howto:21,init:0,initialis:4,installat:18,introduct:21,job:0,launcher:[0,12],list:[17,20],log:[0,13],logger:21,loggingsat:3,make:0,makeinstal:0,mode:15,modul:[0,3,4,5],note:[17,19],option:[3,7,20],other:21,packag:[0,3,4,5,14],patch:0,path:[6,7,8,9,13,14,15],prepar:[0,15,20],product:[3,20],products:16,profil:0,pyconf:3,quick:17,releas:[17,19],remark:[11,15],requir:21,returncod:3,run:0,salom:17,salome:20,salometool:[3,20,21],sat:20,script:0,section:16,shell:0,some:[6,7,8,9,13,14,15],sourc:[0,20],src:[2,3,4,5],start:17,submodul:[0,3,4,5],subpackag:3,svn:15,syntax:16,system:3,templat:[0,3],test:0,test_modul:3,tool:17,usage:[6,7,8,9,10,11,12,13,14,15,20],user:[16,21],utilssat:3,vars:16,vcs:15,verbos:20,win32:4,winterm:4,xmlmanag:3}})
\ No newline at end of file
+Search.setIndex({docnames:["apidoc_commands/commands","apidoc_commands/modules","apidoc_src/modules","apidoc_src/src","apidoc_src/src.colorama","apidoc_src/src.example","commands/application","commands/clean","commands/compile","commands/config","commands/environ","commands/generate","commands/launcher","commands/log","commands/package","commands/prepare","configuration","index","installation_of_sat","release_notes/release_notes_5.0.0","usage_of_sat","write_command"],envversion:52,filenames:["apidoc_commands/commands.rst","apidoc_commands/modules.rst","apidoc_src/modules.rst","apidoc_src/src.rst","apidoc_src/src.colorama.rst","apidoc_src/src.example.rst","commands/application.rst","commands/clean.rst","commands/compile.rst","commands/config.rst","commands/environ.rst","commands/generate.rst","commands/launcher.rst","commands/log.rst","commands/package.rst","commands/prepare.rst","configuration.rst","index.rst","installation_of_sat.rst","release_notes/release_notes_5.0.0.rst","usage_of_sat.rst","write_command.rst"],objects:{"":{commands:[0,0,0,"-"],src:[3,0,0,"-"]},"commands.application":{Command:[0,1,1,""],add_module_to_appli:[0,4,1,""],create_application:[0,4,1,""],create_config_file:[0,4,1,""],customize_app:[0,4,1,""],generate_application:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""],get_SALOME_modules:[0,4,1,""],get_step:[0,4,1,""],make_alias:[0,4,1,""]},"commands.application.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.check":{Command:[0,1,1,""],check_all_products:[0,4,1,""],check_product:[0,4,1,""],get_products_list:[0,4,1,""]},"commands.check.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.clean":{Command:[0,1,1,""],get_build_directories:[0,4,1,""],get_install_directories:[0,4,1,""],get_source_directories:[0,4,1,""],product_has_dir:[0,4,1,""],suppress_directories:[0,4,1,""]},"commands.clean.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.compile":{Command:[0,1,1,""],add_compile_config_file:[0,4,1,""],check_dependencies:[0,4,1,""],compile_all_products:[0,4,1,""],compile_product:[0,4,1,""],compile_product_cmake_autotools:[0,4,1,""],compile_product_script:[0,4,1,""],extend_with_children:[0,4,1,""],extend_with_fathers:[0,4,1,""],get_children:[0,4,1,""],get_products_list:[0,4,1,""],get_recursive_children:[0,4,1,""],get_recursive_fathers:[0,4,1,""],sort_products:[0,4,1,""]},"commands.compile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.config":{Command:[0,1,1,""]},"commands.config.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.configure":{Command:[0,1,1,""],configure_all_products:[0,4,1,""],configure_product:[0,4,1,""],get_products_list:[0,4,1,""]},"commands.configure.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.environ":{Command:[0,1,1,""],write_all_source_files:[0,4,1,""]},"commands.environ.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates":{Command:[0,1,1,""],Progress_bar:[0,1,1,""],format_list_of_str:[0,4,1,""],list_directory:[0,4,1,""]},"commands.find_duplicates.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.find_duplicates.Progress_bar":{display_value_progression:[0,2,1,""]},"commands.generate":{Command:[0,1,1,""],build_context:[0,4,1,""],check_module_generator:[0,4,1,""],check_yacsgen:[0,4,1,""],generate_component:[0,4,1,""],generate_component_list:[0,4,1,""]},"commands.generate.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.init":{Command:[0,1,1,""],check_path:[0,4,1,""],display_local_values:[0,4,1,""],set_local_value:[0,4,1,""]},"commands.init.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.job":{Command:[0,1,1,""]},"commands.job.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs":{Command:[0,1,1,""],Gui:[0,1,1,""],Job:[0,1,1,""],Jobs:[0,1,1,""],Machine:[0,1,1,""],develop_factorized_jobs:[0,4,1,""],getParamiko:[0,4,1,""],get_config_file_path:[0,4,1,""]},"commands.jobs.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.jobs.Gui":{add_xml_board:[0,2,1,""],find_history:[0,2,1,""],find_test_log:[0,2,1,""],initialize_boards:[0,2,1,""],last_update:[0,2,1,""],parse_csv_boards:[0,2,1,""],put_jobs_not_today:[0,2,1,""],update_xml_file:[0,2,1,""],update_xml_files:[0,2,1,""],write_xml_file:[0,2,1,""],write_xml_files:[0,2,1,""]},"commands.jobs.Job":{cancel:[0,2,1,""],check_time:[0,2,1,""],get_log_files:[0,2,1,""],get_pids:[0,2,1,""],get_status:[0,2,1,""],has_begun:[0,2,1,""],has_failed:[0,2,1,""],has_finished:[0,2,1,""],is_running:[0,2,1,""],is_timeout:[0,2,1,""],kill_remote_process:[0,2,1,""],run:[0,2,1,""],time_elapsed:[0,2,1,""],total_duration:[0,2,1,""],write_results:[0,2,1,""]},"commands.jobs.Jobs":{cancel_dependencies_of_failing_jobs:[0,2,1,""],define_job:[0,2,1,""],determine_jobs_and_machines:[0,2,1,""],display_status:[0,2,1,""],find_job_that_has_name:[0,2,1,""],is_occupied:[0,2,1,""],run_jobs:[0,2,1,""],ssh_connection_all_machines:[0,2,1,""],str_of_length:[0,2,1,""],update_jobs_states_list:[0,2,1,""],write_all_results:[0,2,1,""]},"commands.jobs.Machine":{close:[0,2,1,""],connect:[0,2,1,""],copy_sat:[0,2,1,""],exec_command:[0,2,1,""],mkdir:[0,2,1,""],put_dir:[0,2,1,""],successfully_connected:[0,2,1,""],write_info:[0,2,1,""]},"commands.launcher":{Command:[0,1,1,""],copy_catalog:[0,4,1,""],generate_catalog:[0,4,1,""],generate_launch_file:[0,4,1,""]},"commands.launcher.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.log":{Command:[0,1,1,""],ask_value:[0,4,1,""],getMaxFormat:[0,4,1,""],get_last_log_file:[0,4,1,""],print_log_command_in_terminal:[0,4,1,""],remove_log_file:[0,4,1,""],show_last_logs:[0,4,1,""],show_product_last_logs:[0,4,1,""]},"commands.log.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.make":{Command:[0,1,1,""],get_nb_proc:[0,4,1,""],get_products_list:[0,4,1,""],make_all_products:[0,4,1,""],make_product:[0,4,1,""]},"commands.make.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.makeinstall":{Command:[0,1,1,""],get_products_list:[0,4,1,""],makeinstall_all_products:[0,4,1,""],makeinstall_product:[0,4,1,""]},"commands.makeinstall.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.package":{Command:[0,1,1,""],add_files:[0,4,1,""],add_readme:[0,4,1,""],add_salomeTools:[0,4,1,""],binary_package:[0,4,1,""],create_project_for_src_package:[0,4,1,""],exclude_VCS_and_extensions:[0,4,1,""],find_application_pyconf:[0,4,1,""],find_product_scripts_and_pyconf:[0,4,1,""],get_archives:[0,4,1,""],get_archives_vcs:[0,4,1,""],hack_for_distene_licence:[0,4,1,""],make_archive:[0,4,1,""],produce_install_bin_file:[0,4,1,""],produce_relative_env_files:[0,4,1,""],produce_relative_launcher:[0,4,1,""],product_appli_creation_script:[0,4,1,""],project_package:[0,4,1,""],source_package:[0,4,1,""],update_config:[0,4,1,""]},"commands.package.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.patch":{Command:[0,1,1,""],apply_patch:[0,4,1,""]},"commands.patch.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.prepare":{Command:[0,1,1,""],find_products_already_getted:[0,4,1,""],find_products_with_patchs:[0,4,1,""],remove_products:[0,4,1,""]},"commands.prepare.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile":{Command:[0,1,1,""],generate_profile_sources:[0,4,1,""],get_profile_name:[0,4,1,""],profileConfigReader:[0,1,1,""],profileReference:[0,1,1,""],update_pyconf:[0,4,1,""]},"commands.profile.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.profile.profileConfigReader":{parseMapping:[0,2,1,""]},"commands.run":{Command:[0,1,1,""]},"commands.run.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.script":{Command:[0,1,1,""],get_products_list:[0,4,1,""],run_script_all_products:[0,4,1,""],run_script_of_product:[0,4,1,""]},"commands.script.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.shell":{Command:[0,1,1,""]},"commands.shell.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.source":{Command:[0,1,1,""],check_sources:[0,4,1,""],get_all_product_sources:[0,4,1,""],get_product_sources:[0,4,1,""],get_source_for_dev:[0,4,1,""],get_source_from_archive:[0,4,1,""],get_source_from_cvs:[0,4,1,""],get_source_from_dir:[0,4,1,""],get_source_from_git:[0,4,1,""],get_source_from_svn:[0,4,1,""]},"commands.source.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template":{Command:[0,1,1,""],TParam:[0,1,1,""],TemplateSettings:[0,1,1,""],get_dico_param:[0,4,1,""],get_template_info:[0,4,1,""],prepare_from_template:[0,4,1,""],search_template:[0,4,1,""]},"commands.template.Command":{getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"commands.template.TParam":{check_value:[0,2,1,""]},"commands.template.TemplateSettings":{check_file_for_substitution:[0,2,1,""],check_user_values:[0,2,1,""],get_parameters:[0,2,1,""],get_pyconf_parameters:[0,2,1,""],has_pyconf:[0,2,1,""]},"commands.test":{Command:[0,1,1,""],ask_a_path:[0,4,1,""],check_remote_machine:[0,4,1,""],create_test_report:[0,4,1,""],generate_history_xml_path:[0,4,1,""],move_test_results:[0,4,1,""],save_file:[0,4,1,""]},"commands.test.Command":{check_option:[0,2,1,""],getParser:[0,2,1,""],name:[0,3,1,""],run:[0,2,1,""]},"src.ElementTree":{Comment:[3,4,1,""],Element:[3,4,1,""],ElementTree:[3,1,1,""],PI:[3,4,1,""],ProcessingInstruction:[3,4,1,""],QName:[3,1,1,""],SubElement:[3,4,1,""],TreeBuilder:[3,1,1,""],XML:[3,4,1,""],XMLTreeBuilder:[3,1,1,""],dump:[3,4,1,""],fromstring:[3,4,1,""],iselement:[3,4,1,""],iterparse:[3,1,1,""],parse:[3,4,1,""],tostring:[3,4,1,""]},"src.ElementTree.ElementTree":{find:[3,2,1,""],findall:[3,2,1,""],findtext:[3,2,1,""],getiterator:[3,2,1,""],getroot:[3,2,1,""],parse:[3,2,1,""],write:[3,2,1,""]},"src.ElementTree.TreeBuilder":{close:[3,2,1,""],data:[3,2,1,""],end:[3,2,1,""],start:[3,2,1,""]},"src.ElementTree.XMLTreeBuilder":{close:[3,2,1,""],doctype:[3,2,1,""],feed:[3,2,1,""]},"src.ElementTree.iterparse":{next:[3,2,1,""]},"src.architecture":{get_distrib_version:[3,4,1,""],get_distribution:[3,4,1,""],get_nb_proc:[3,4,1,""],get_python_version:[3,4,1,""],get_user:[3,4,1,""],is_windows:[3,4,1,""]},"src.catchAll":{CatchAll:[3,1,1,""],dumper:[3,4,1,""],dumperType:[3,4,1,""],jsonDumps:[3,4,1,""]},"src.catchAll.CatchAll":{jsonDumps:[3,2,1,""]},"src.colorama":{ansi:[4,0,0,"-"],ansitowin32:[4,0,0,"-"],initialise:[4,0,0,"-"],win32:[4,0,0,"-"],winterm:[4,0,0,"-"]},"src.colorama.ansi":{AnsiBack:[4,1,1,""],AnsiCodes:[4,1,1,""],AnsiCursor:[4,1,1,""],AnsiFore:[4,1,1,""],AnsiStyle:[4,1,1,""],clear_line:[4,4,1,""],clear_screen:[4,4,1,""],code_to_chars:[4,4,1,""],set_title:[4,4,1,""]},"src.colorama.ansi.AnsiBack":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiCursor":{BACK:[4,2,1,""],DOWN:[4,2,1,""],FORWARD:[4,2,1,""],POS:[4,2,1,""],UP:[4,2,1,""]},"src.colorama.ansi.AnsiFore":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],LIGHTBLACK_EX:[4,3,1,""],LIGHTBLUE_EX:[4,3,1,""],LIGHTCYAN_EX:[4,3,1,""],LIGHTGREEN_EX:[4,3,1,""],LIGHTMAGENTA_EX:[4,3,1,""],LIGHTRED_EX:[4,3,1,""],LIGHTWHITE_EX:[4,3,1,""],LIGHTYELLOW_EX:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],RESET:[4,3,1,""],WHITE:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.ansi.AnsiStyle":{BRIGHT:[4,3,1,""],DIM:[4,3,1,""],NORMAL:[4,3,1,""],RESET_ALL:[4,3,1,""]},"src.colorama.ansitowin32":{AnsiToWin32:[4,1,1,""],StreamWrapper:[4,1,1,""],is_a_tty:[4,4,1,""],is_stream_closed:[4,4,1,""]},"src.colorama.ansitowin32.AnsiToWin32":{ANSI_CSI_RE:[4,3,1,""],ANSI_OSC_RE:[4,3,1,""],call_win32:[4,2,1,""],convert_ansi:[4,2,1,""],convert_osc:[4,2,1,""],extract_params:[4,2,1,""],get_win32_calls:[4,2,1,""],reset_all:[4,2,1,""],should_wrap:[4,2,1,""],write:[4,2,1,""],write_and_convert:[4,2,1,""],write_plain_text:[4,2,1,""]},"src.colorama.ansitowin32.StreamWrapper":{write:[4,2,1,""]},"src.colorama.initialise":{colorama_text:[4,4,1,""],deinit:[4,4,1,""],init:[4,4,1,""],reinit:[4,4,1,""],reset_all:[4,4,1,""],wrap_stream:[4,4,1,""]},"src.colorama.win32":{SetConsoleTextAttribute:[4,4,1,""],winapi_test:[4,4,1,""]},"src.colorama.winterm":{WinColor:[4,1,1,""],WinStyle:[4,1,1,""],WinTerm:[4,1,1,""]},"src.colorama.winterm.WinColor":{BLACK:[4,3,1,""],BLUE:[4,3,1,""],CYAN:[4,3,1,""],GREEN:[4,3,1,""],GREY:[4,3,1,""],MAGENTA:[4,3,1,""],RED:[4,3,1,""],YELLOW:[4,3,1,""]},"src.colorama.winterm.WinStyle":{BRIGHT:[4,3,1,""],BRIGHT_BACKGROUND:[4,3,1,""],NORMAL:[4,3,1,""]},"src.colorama.winterm.WinTerm":{back:[4,2,1,""],cursor_adjust:[4,2,1,""],erase_line:[4,2,1,""],erase_screen:[4,2,1,""],fore:[4,2,1,""],get_attrs:[4,2,1,""],get_position:[4,2,1,""],reset_all:[4,2,1,""],set_attrs:[4,2,1,""],set_console:[4,2,1,""],set_cursor_position:[4,2,1,""],set_title:[4,2,1,""],style:[4,2,1,""]},"src.coloringSat":{ColoringStream:[3,1,1,""],cleanColors:[3,4,1,""],indent:[3,4,1,""],log:[3,4,1,""],replace:[3,4,1,""],toColor:[3,4,1,""],toColor_AnsiToWin32:[3,4,1,""]},"src.coloringSat.ColoringStream":{flush:[3,2,1,""],write:[3,2,1,""]},"src.compilation":{Builder:[3,1,1,""]},"src.compilation.Builder":{build_configure:[3,2,1,""],check:[3,2,1,""],cmake:[3,2,1,""],complete_environment:[3,2,1,""],configure:[3,2,1,""],do_batch_script_build:[3,2,1,""],do_default_build:[3,2,1,""],do_python_script_build:[3,2,1,""],do_script_build:[3,2,1,""],hack_libtool:[3,2,1,""],install:[3,2,1,""],log:[3,2,1,""],log_command:[3,2,1,""],make:[3,2,1,""],prepare:[3,2,1,""],put_txt_log_in_appli_log_dir:[3,2,1,""],wmake:[3,2,1,""]},"src.configManager":{ConfigManager:[3,1,1,""],ConfigOpener:[3,1,1,""],check_path:[3,4,1,""],getConfigColored:[3,4,1,""],get_config_children:[3,4,1,""],get_products_list:[3,4,1,""],print_debug:[3,4,1,""],print_value:[3,4,1,""],show_patchs:[3,4,1,""],show_product_info:[3,4,1,""]},"src.configManager.ConfigManager":{create_config_file:[3,2,1,""],get_command_line_overrides:[3,2,1,""],get_config:[3,2,1,""],get_user_config_file:[3,2,1,""],set_user_config_file:[3,2,1,""]},"src.configManager.ConfigOpener":{get_path:[3,2,1,""]},"src.debug":{InStream:[3,1,1,""],OutStream:[3,1,1,""],format_color_exception:[3,4,1,""],getLocalEnv:[3,4,1,""],getStrConfigDbg:[3,4,1,""],getStrConfigStd:[3,4,1,""],indent:[3,4,1,""],isTypeConfig:[3,4,1,""],pop_debug:[3,4,1,""],push_debug:[3,4,1,""],saveConfigDbg:[3,4,1,""],saveConfigStd:[3,4,1,""],tofix:[3,4,1,""],write:[3,4,1,""]},"src.debug.OutStream":{close:[3,2,1,""]},"src.environment":{Environ:[3,1,1,""],FileEnvWriter:[3,1,1,""],SalomeEnviron:[3,1,1,""],Shell:[3,1,1,""],load_environment:[3,4,1,""]},"src.environment.Environ":{append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.environment.FileEnvWriter":{write_cfgForPy_file:[3,2,1,""],write_env_file:[3,2,1,""]},"src.environment.SalomeEnviron":{add_comment:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],dump:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],get_names:[3,2,1,""],is_defined:[3,2,1,""],load_cfg_environment:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],run_simple_env_script:[3,2,1,""],set:[3,2,1,""],set_a_product:[3,2,1,""],set_application_env:[3,2,1,""],set_cpp_env:[3,2,1,""],set_full_environ:[3,2,1,""],set_products:[3,2,1,""],set_python_libdirs:[3,2,1,""],set_salome_generic_product_env:[3,2,1,""],set_salome_minimal_product_env:[3,2,1,""]},"src.environs":{print_grep_environs:[3,4,1,""],print_split_environs:[3,4,1,""],print_split_pattern_environs:[3,4,1,""]},"src.example":{essai_logging_1:[5,0,0,"-"],essai_logging_2:[5,0,0,"-"]},"src.example.essai_logging_1":{getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2":{MyFormatter:[5,1,1,""],getMyLogger:[5,4,1,""],initMyLogger:[5,4,1,""],testLogger1:[5,4,1,""]},"src.example.essai_logging_2.MyFormatter":{format:[5,2,1,""]},"src.exceptionSat":{ExceptionSat:[3,5,1,""]},"src.fileEnviron":{BashFileEnviron:[3,1,1,""],BatFileEnviron:[3,1,1,""],ContextFileEnviron:[3,1,1,""],FileEnviron:[3,1,1,""],LauncherFileEnviron:[3,1,1,""],ScreenEnviron:[3,1,1,""],get_file_environ:[3,4,1,""],special_path_separator:[3,4,1,""]},"src.fileEnviron.BashFileEnviron":{command_value:[3,2,1,""],finish:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.BatFileEnviron":{add_comment:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ContextFileEnviron":{add_echo:[3,2,1,""],add_warning:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.FileEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.LauncherFileEnviron":{add:[3,2,1,""],add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],append_value:[3,2,1,""],change_to_launcher:[3,2,1,""],command_value:[3,2,1,""],finish:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],prepend_value:[3,2,1,""],set:[3,2,1,""]},"src.fileEnviron.ScreenEnviron":{add_comment:[3,2,1,""],add_echo:[3,2,1,""],add_line:[3,2,1,""],add_warning:[3,2,1,""],append:[3,2,1,""],command_value:[3,2,1,""],get:[3,2,1,""],is_defined:[3,2,1,""],prepend:[3,2,1,""],run_env_script:[3,2,1,""],set:[3,2,1,""],write:[3,2,1,""]},"src.fork":{batch:[3,4,1,""],batch_salome:[3,4,1,""],launch_command:[3,4,1,""],show_progress:[3,4,1,""],write_back:[3,4,1,""]},"src.loggingSat":{DefaultFormatter:[3,1,1,""],UnittestFormatter:[3,1,1,""],UnittestStream:[3,1,1,""],dirLogger:[3,4,1,""],getDefaultLogger:[3,4,1,""],getUnittestLogger:[3,4,1,""],indent:[3,4,1,""],indentUnittest:[3,4,1,""],initLoggerAsDefault:[3,4,1,""],initLoggerAsUnittest:[3,4,1,""],log:[3,4,1,""],testLogger_1:[3,4,1,""]},"src.loggingSat.DefaultFormatter":{format:[3,2,1,""],setColorLevelname:[3,2,1,""]},"src.loggingSat.UnittestFormatter":{format:[3,2,1,""]},"src.loggingSat.UnittestStream":{flush:[3,2,1,""],getLogs:[3,2,1,""],getLogsAndClear:[3,2,1,""],write:[3,2,1,""]},"src.options":{OptResult:[3,1,1,""],Options:[3,1,1,""]},"src.options.Options":{add_option:[3,2,1,""],debug_write:[3,2,1,""],getDetailOption:[3,2,1,""],get_help:[3,2,1,""],indent:[3,2,1,""],parse_args:[3,2,1,""]},"src.product":{check_config_exists:[3,4,1,""],check_installation:[3,4,1,""],get_base_install_dir:[3,4,1,""],get_install_dir:[3,4,1,""],get_product_components:[3,4,1,""],get_product_config:[3,4,1,""],get_product_dependencies:[3,4,1,""],get_product_section:[3,4,1,""],get_products_infos:[3,4,1,""],product_compiles:[3,4,1,""],product_has_env_script:[3,4,1,""],product_has_logo:[3,4,1,""],product_has_patches:[3,4,1,""],product_has_salome_gui:[3,4,1,""],product_has_script:[3,4,1,""],product_is_SALOME:[3,4,1,""],product_is_autotools:[3,4,1,""],product_is_cmake:[3,4,1,""],product_is_cpp:[3,4,1,""],product_is_debug:[3,4,1,""],product_is_dev:[3,4,1,""],product_is_fixed:[3,4,1,""],product_is_generated:[3,4,1,""],product_is_mpi:[3,4,1,""],product_is_native:[3,4,1,""],product_is_salome:[3,4,1,""],product_is_sample:[3,4,1,""],product_is_smesh_plugin:[3,4,1,""],product_is_vcs:[3,4,1,""]},"src.pyconf":{Config:[3,1,1,""],ConfigError:[3,5,1,""],ConfigFormatError:[3,5,1,""],ConfigInputStream:[3,1,1,""],ConfigList:[3,1,1,""],ConfigMerger:[3,1,1,""],ConfigOutputStream:[3,1,1,""],ConfigReader:[3,1,1,""],ConfigResolutionError:[3,5,1,""],Container:[3,1,1,""],Expression:[3,1,1,""],Mapping:[3,1,1,""],Reference:[3,1,1,""],Sequence:[3,1,1,""],deepCopyMapping:[3,4,1,""],defaultMergeResolve:[3,4,1,""],defaultStreamOpener:[3,4,1,""],isWord:[3,4,1,""],makePath:[3,4,1,""],overwriteMergeResolve:[3,4,1,""]},"src.pyconf.Config":{Namespace:[3,1,1,""],addNamespace:[3,2,1,""],getByPath:[3,2,1,""],load:[3,2,1,""],removeNamespace:[3,2,1,""]},"src.pyconf.ConfigInputStream":{close:[3,2,1,""],read:[3,2,1,""],readline:[3,2,1,""]},"src.pyconf.ConfigList":{getByPath:[3,2,1,""]},"src.pyconf.ConfigMerger":{handleMismatch:[3,2,1,""],merge:[3,2,1,""],mergeMapping:[3,2,1,""],mergeSequence:[3,2,1,""],overwriteKeys:[3,2,1,""]},"src.pyconf.ConfigOutputStream":{close:[3,2,1,""],flush:[3,2,1,""],write:[3,2,1,""]},"src.pyconf.ConfigReader":{getChar:[3,2,1,""],getToken:[3,2,1,""],load:[3,2,1,""],location:[3,2,1,""],match:[3,2,1,""],parseFactor:[3,2,1,""],parseKeyValuePair:[3,2,1,""],parseMapping:[3,2,1,""],parseMappingBody:[3,2,1,""],parseReference:[3,2,1,""],parseScalar:[3,2,1,""],parseSequence:[3,2,1,""],parseSuffix:[3,2,1,""],parseTerm:[3,2,1,""],parseValue:[3,2,1,""],setStream:[3,2,1,""]},"src.pyconf.Container":{evaluate:[3,2,1,""],setPath:[3,2,1,""],writeToStream:[3,2,1,""],writeValue:[3,2,1,""]},"src.pyconf.Expression":{evaluate:[3,2,1,""]},"src.pyconf.Mapping":{addMapping:[3,2,1,""],get:[3,2,1,""],iteritems:[3,2,1,""],iterkeys:[3,2,1,""],keys:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Reference":{addElement:[3,2,1,""],findConfig:[3,2,1,""],resolve:[3,2,1,""]},"src.pyconf.Sequence":{SeqIter:[3,1,1,""],append:[3,2,1,""],writeToStream:[3,2,1,""]},"src.pyconf.Sequence.SeqIter":{next:[3,2,1,""]},"src.returnCode":{ReturnCode:[3,1,1,""]},"src.returnCode.ReturnCode":{KFSYS:[3,3,1,""],KNOWNFAILURE_STATUS:[3,3,1,""],KOSYS:[3,3,1,""],KO_STATUS:[3,3,1,""],NASYS:[3,3,1,""],NA_STATUS:[3,3,1,""],NDSYS:[3,3,1,""],OKSYS:[3,3,1,""],OK_STATUS:[3,3,1,""],TIMEOUT_STATUS:[3,3,1,""],TOSYS:[3,3,1,""],UNKNOWN_STATUS:[3,3,1,""],getValue:[3,2,1,""],getWhy:[3,2,1,""],indent:[3,2,1,""],isOk:[3,2,1,""],raiseIfKo:[3,2,1,""],setStatus:[3,2,1,""],setValue:[3,2,1,""],setWhy:[3,2,1,""],toSys:[3,2,1,""]},"src.salomeTools":{Sat:[3,1,1,""],assumeAsList:[3,4,1,""],find_command_list:[3,4,1,""],getCommandsList:[3,4,1,""],getVersion:[3,4,1,""],launchSat:[3,4,1,""],setLocale:[3,4,1,""],setNotLocale:[3,4,1,""]},"src.salomeTools.Sat":{assumeAsList:[3,2,1,""],execute_cli:[3,2,1,""],getColoredVersion:[3,2,1,""],getCommandAndAppli:[3,2,1,""],getCommandInstance:[3,2,1,""],getConfig:[3,2,1,""],getConfigManager:[3,2,1,""],getLogger:[3,2,1,""],getModule:[3,2,1,""],get_help:[3,2,1,""],parseArguments:[3,2,1,""],print_help:[3,2,1,""]},"src.system":{archive_extract:[3,4,1,""],cvs_extract:[3,4,1,""],git_extract:[3,4,1,""],show_in_editor:[3,4,1,""],svn_extract:[3,4,1,""]},"src.template":{MyTemplate:[3,1,1,""],substitute:[3,4,1,""]},"src.template.MyTemplate":{delimiter:[3,3,1,""],pattern:[3,3,1,""]},"src.test_module":{Test:[3,1,1,""],getTmpDirDEFAULT:[3,4,1,""]},"src.test_module.Test":{generate_launching_commands:[3,2,1,""],generate_script:[3,2,1,""],get_test_timeout:[3,2,1,""],get_tmp_dir:[3,2,1,""],prepare_testbase:[3,2,1,""],prepare_testbase_from_dir:[3,2,1,""],prepare_testbase_from_git:[3,2,1,""],prepare_testbase_from_svn:[3,2,1,""],read_results:[3,2,1,""],run_all_tests:[3,2,1,""],run_grid_tests:[3,2,1,""],run_script:[3,2,1,""],run_session_tests:[3,2,1,""],run_testbase_tests:[3,2,1,""],run_tests:[3,2,1,""],search_known_errors:[3,2,1,""],write_test_margin:[3,2,1,""]},"src.utilsSat":{Path:[3,1,1,""],black:[3,4,1,""],blue:[3,4,1,""],check_config_has_application:[3,4,1,""],check_config_has_profile:[3,4,1,""],check_has_key:[3,4,1,""],config_has_application:[3,4,1,""],critical:[3,4,1,""],cyan:[3,4,1,""],date_to_datetime:[3,4,1,""],deepcopy_list:[3,4,1,""],ensure_path_exists:[3,4,1,""],error:[3,4,1,""],find_file_in_lpath:[3,4,1,""],formatTuples:[3,4,1,""],formatValue:[3,4,1,""],get_base_path:[3,4,1,""],get_cfg_param:[3,4,1,""],get_launcher_name:[3,4,1,""],get_log_path:[3,4,1,""],get_property_in_product_cfg:[3,4,1,""],get_salome_version:[3,4,1,""],get_tmp_filename:[3,4,1,""],green:[3,4,1,""],handleRemoveReadonly:[3,4,1,""],header:[3,4,1,""],info:[3,4,1,""],label:[3,4,1,""],list_log_file:[3,4,1,""],log_res_step:[3,4,1,""],log_step:[3,4,1,""],logger_info_tuples:[3,4,1,""],magenta:[3,4,1,""],merge_dicts:[3,4,1,""],normal:[3,4,1,""],only_numbers:[3,4,1,""],parse_date:[3,4,1,""],read_config_from_a_file:[3,4,1,""],red:[3,4,1,""],remove_item_from_list:[3,4,1,""],replace_in_file:[3,4,1,""],reset:[3,4,1,""],show_command_log:[3,4,1,""],success:[3,4,1,""],timedelta_total_seconds:[3,4,1,""],update_hat_xml:[3,4,1,""],warning:[3,4,1,""],white:[3,4,1,""],yellow:[3,4,1,""]},"src.utilsSat.Path":{base:[3,2,1,""],chmod:[3,2,1,""],copy:[3,2,1,""],copydir:[3,2,1,""],copyfile:[3,2,1,""],copylink:[3,2,1,""],dir:[3,2,1,""],exists:[3,2,1,""],isdir:[3,2,1,""],isfile:[3,2,1,""],islink:[3,2,1,""],list:[3,2,1,""],make:[3,2,1,""],readlink:[3,2,1,""],rm:[3,2,1,""],smartcopy:[3,2,1,""],symlink:[3,2,1,""]},"src.xmlManager":{ReadXmlFile:[3,1,1,""],XmlLogFile:[3,1,1,""],add_simple_node:[3,4,1,""],append_node_attrib:[3,4,1,""],find_node_by_attrib:[3,4,1,""],write_report:[3,4,1,""]},"src.xmlManager.ReadXmlFile":{getRootAttrib:[3,2,1,""],get_attrib:[3,2,1,""],get_node_text:[3,2,1,""]},"src.xmlManager.XmlLogFile":{add_simple_node:[3,2,1,""],append_node_attrib:[3,2,1,""],append_node_text:[3,2,1,""],write_tree:[3,2,1,""]},commands:{"package":[0,0,0,"-"],application:[0,0,0,"-"],check:[0,0,0,"-"],clean:[0,0,0,"-"],compile:[0,0,0,"-"],config:[0,0,0,"-"],configure:[0,0,0,"-"],environ:[0,0,0,"-"],find_duplicates:[0,0,0,"-"],generate:[0,0,0,"-"],init:[0,0,0,"-"],job:[0,0,0,"-"],jobs:[0,0,0,"-"],launcher:[0,0,0,"-"],log:[0,0,0,"-"],make:[0,0,0,"-"],makeinstall:[0,0,0,"-"],patch:[0,0,0,"-"],prepare:[0,0,0,"-"],profile:[0,0,0,"-"],run:[0,0,0,"-"],script:[0,0,0,"-"],shell:[0,0,0,"-"],source:[0,0,0,"-"],template:[0,0,0,"-"],test:[0,0,0,"-"]},src:{ElementTree:[3,0,0,"-"],architecture:[3,0,0,"-"],catchAll:[3,0,0,"-"],colorama:[4,0,0,"-"],coloringSat:[3,0,0,"-"],compilation:[3,0,0,"-"],configManager:[3,0,0,"-"],debug:[3,0,0,"-"],environment:[3,0,0,"-"],environs:[3,0,0,"-"],example:[5,0,0,"-"],exceptionSat:[3,0,0,"-"],fileEnviron:[3,0,0,"-"],fork:[3,0,0,"-"],loggingSat:[3,0,0,"-"],options:[3,0,0,"-"],product:[3,0,0,"-"],pyconf:[3,0,0,"-"],returnCode:[3,0,0,"-"],salomeTools:[3,0,0,"-"],system:[3,0,0,"-"],template:[3,0,0,"-"],test_module:[3,0,0,"-"],utilsSat:[3,0,0,"-"],xmlManager:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function","5":"py:exception"},terms:{"0x3504970":4,"0x350dc10":4,"0x3561c80":3,"0x39a7938":[],"0x3a4a520":[],"0x412cde0":3,"16be":3,"16le":3,"30s":0,"9abc":3,"boolean":[0,3,21],"case":[0,3],"char":3,"class":[0,3,4,5,21],"default":[0,3,6,8,9,10,12,13,14,15,20],"export":15,"final":[3,9,15],"float":[0,3],"function":[0,3,4,21],"import":[3,10,21],"int":[0,3,13],"long":[3,7],"new":[0,3,15,21],"return":[0,3,5,10,21],"short":3,"true":[0,3,4],"try":3,"var":[0,3,10,21],And:[3,9,10],But:21,CVS:14,FOR:21,For:[0,3,10,15,17,21],Has:3,NOT:3,One:3,POS:4,The:[0,3,5,6,7,8,9,10,11,12,13,14,15,16,17,20,21],Then:[15,16],There:[0,16],These:[0,10],Theses:7,UTS:3,Use:[0,6,7,8,9,10,11,12,15],Used:[0,3],Useful:[3,20],Using:21,VCS:[0,7,14],__init__:[3,5],__main__:3,__repr__:3,__save__:3,__setattr__:3,__str__:3,_appli:6,_basecmd:3,_basecommand:0,_blank:3,_build:10,_debug:3,_developp:3,_launch:10,_ld_library_path:10,_sre:[3,4],_type:3,_user:3,_verbos:3,a_b_c_:3,abool:3,about:[0,3,16],absolut:14,access:[0,3,4,13],account:10,act:[3,4],action:3,activ:[3,15],actual:[3,4,18],add:[0,3,8,17],add_com:3,add_compile_config_fil:0,add_echo:3,add_fil:0,add_lin:3,add_module_to_appli:0,add_opt:[3,21],add_readm:0,add_salometool:0,add_simple_nod:3,add_warn:3,add_xml_board:0,added:[0,3],addel:3,adding:[0,21],addit:[0,3,8,16],additional_dir:3,additional_env:[0,3],addmap:3,addnamespac:3,adequ:3,advanc:3,affect:4,afil:3,after:[0,8,18],again:3,agent:15,aim:3,algorithm:21,alia:3,alias_path:0,alistofstr:0,all:[0,3,4,7,9,10,11,15,16,20,21],allow:[0,3,8,9,11,17,20],alphanumer:3,alreadi:[0,14,21],also:[0,3,10,15,16,21],alter:15,amount:3,ani:[0,3,4,9,13,15],anoth:[3,16],ansi:[2,3],ansi_csi_r:4,ansi_escape_cod:4,ansi_osc_r:4,ansiback:4,ansicod:4,ansicursor:4,ansifor:4,ansistyl:4,ansitowin32:[2,3],anyth:0,apart:4,apath:3,api:3,append:[3,5,10,14],append_node_attrib:3,append_node_text:3,append_valu:3,appli:[0,3,9,11,15],appli_dir:0,appli_gen:0,appli_path:0,applic:[1,3,7,8,9,10,11,12,13,15,17,21],application_nam:6,application_tmp_dir:0,applilog:3,apply_patch:0,appropri:3,arch:14,architectur:[2,14,16],archiv:[0,3,14,15],archive_extract:3,archive_info:15,arg:[3,4,21],arglist:3,argument:[0,3],argv:3,arrai:0,ascii:3,asctim:5,ask:[0,3],ask_a_path:0,ask_valu:0,assign:3,assum:3,assumeaslist:3,astr:3,astream:3,atitl:3,attibut:3,attr:[3,4],attrib:3,attribut:[3,4,5],authent:15,author:3,automat:[3,9,10],autoreset:4,autotool:[0,3,8],avail:[0,9],avalu:3,avari:3,avoid:[0,15],award:3,back:4,backend:3,backtick:3,bar:0,base:[0,3,4,5,16],basenam:3,bash:[0,3,10,15],bashfileenviron:3,basic:3,bat:[3,10],batch:3,batch_salom:3,batfileenviron:3,becaus:3,been:[0,3,4],befor:[0,3,5,8],begin:3,begun:0,behavior:21,being:3,belong:3,below:10,between:[0,3],bienvenu:3,big:8,bin:10,binari:[0,14],binaries_dir_nam:0,binary_packag:0,birari:0,black:[3,4],blogmatrix:3,blue:[3,4],board:0,bom:3,bonjour:21,bool:[0,3],boost:0,both:[3,10,11],bracket:3,branch:15,bright:4,bright_background:4,bring:[11,15],browser:[0,3,9,13,16],buf:3,build:[0,3,7,8,10,16],build_conf_opt:3,build_configur:[0,3],build_context:0,build_sourc:[0,8],builder:3,built:3,caa:3,call:[0,3,4,5,10,12,21],call_win32:4,callabl:3,can:[0,3,6,10,15,16,17,21],cancel:0,cancel_dependencies_of_failing_job:0,cannot:3,car:3,care:7,carri:[3,5],catalog:[0,6,12],catalog_path:0,catchal:2,cfg:[0,3,10,21],cfg_env:3,cfgforpi:3,chang:[0,3,6,20,21],change_to_launch:3,channel:0,channelfil:0,charact:[3,4],charg:12,check:[1,3,8,10],check_all_product:0,check_config_exist:3,check_config_has_appl:3,check_config_has_profil:3,check_depend:0,check_file_for_substitut:0,check_has_kei:3,check_instal:3,check_module_gener:0,check_opt:0,check_path:[0,3],check_product:0,check_remote_machin:0,check_sourc:0,check_src:3,check_tim:0,check_user_valu:0,check_valu:0,check_yacsgen:0,checkout:[0,3,15],children:3,chmod:3,choic:9,choosen:3,circumst:3,clash:3,classic:3,clean:[1,3,8,13,17],clean_al:[0,8,20],clean_build_aft:8,clean_instal:8,cleancolor:3,clear_lin:4,clear_screen:4,cli:[3,13,20],cli_:21,cli_argu:3,client:3,clone:15,close:[0,3],closest:3,cmake:[0,3,8],cmake_opt:8,cmd:3,cmd_argument:0,co7:14,code:[3,4,10],code_to_char:4,col:3,color:[0,3,4],colorama:[2,3],colorama_text:4,coloringsat:2,coloringstream:3,column:[0,3],com:[3,5],come:9,command:[3,4,16,18,20],command_opt:20,command_valu:3,comment:[3,16],commentari:3,commit:7,commonli:3,compat:3,compil:[1,2,10,11,13,15,17],compil_script:8,compil_scripts_tmp_dir:0,compile_all_product:0,compile_product:0,compile_product_cmake_autotool:0,compile_product_script:0,complementari:10,complet:[3,8,9,15,16],complete_environ:3,compo:0,compo_nam:0,compon:[3,6,11],componon:11,compress:14,comput:[3,5,11,14],concaten:3,concern:15,conf_opt:0,conf_valu:0,config:[1,3,15,16,17,20],config_fil:0,config_has_appl:3,config_job:0,configerror:3,configformaterror:[0,3],configinputstream:3,configlist:3,configmanag:2,configmerg:3,configopen:3,configoutputstream:3,configread:[0,3],configresolutionerror:3,configur:[1,3,17,21],configure_all_product:0,configure_opt:3,configure_product:0,configut:6,conflict:3,conform:11,connect:0,consid:0,consist:3,consol:3,construct:[0,3,17,19],contain:[0,3,16,21],content:[1,2],context:[0,3,20],contextfileenviron:3,continu:3,control:14,conveni:3,convert:4,convert_ansi:4,convert_osc:4,copi:[0,3,6,9,12,20],copy_catalog:0,copy_sat:0,copydir:3,copyfil:3,copylink:3,copyright:3,corba:11,correct:3,correctli:0,correl:3,correspond:[0,3,10,13,15],could:[0,3,7,10,18],coupl:[3,5],cpp:[0,3,11],creat:[0,3,6,7,10,12,14,15,16,17],create_appl:0,create_config_fil:[0,3],create_project_for_src_packag:0,create_test_report:0,creation:14,critic:[3,5,21],csv:0,current:[0,3,9,16,20,21],cursor_adjust:4,custom:0,customize_app:0,cvs:[0,3],cvs_extract:3,cvs_info:15,cvspass:15,cwd:3,cyan:[3,4],d_content:0,d_input_board:0,d_sub:0,dai:[0,3],data:[0,3,9,21],datadir:3,date:[0,3,16],date_to_datetim:3,datefmt:[3,5],datetim:3,david:3,dbg:3,debug:[0,2,5,9,10,15,21],debug_writ:3,decid:3,declar:15,dedic:0,deep:3,deepcopy_list:3,deepcopymap:3,def:[10,21],default_valu:3,defaultformatt:3,defaultmergeresolv:3,defaultstreamopen:3,defin:[0,3,7,8,9,10,11,16,21],define_job:0,definit:[0,3],deinit:4,delai:3,delaiapp:3,deleg:4,delet:[0,14],delimit:3,delta:3,depend:[0,3,8,14],deriv:3,des:[3,5],describ:[0,3],descript:[0,3,21],design:3,dest_path:0,destnam:3,detail:[],detar:18,detect:3,determin:[3,5],determine_jobs_and_machin:0,dev:[0,3],develop:[0,3,7,9,10,15,21],develop_factorized_job:0,dico:0,dict:[0,3],dict_arg:3,dictionari:[0,3,5,16],dictionnari:0,differ:[5,10],dim:4,dir:[0,3,9,15],dir_info:15,direct:3,directli:[10,13,18],directori:[0,3,6,7,8,9,10,12,13,14,15,16,18,20,21],directories_ignor:0,dirlogg:3,dirpath:3,displai:[0,3,8,9,13,21],display_local_valu:0,display_statu:0,display_value_progress:0,distant:6,disten:0,distinguish:10,distrib:3,distribut:[3,6,11],divis:3,do_batch_script_build:3,do_default_build:3,do_python_script_build:3,do_script_build:3,doc:[3,5],docstr:0,doctyp:3,document:[11,16,21],doe:[3,10,15],dog:3,doing:3,dollar:3,don:11,done:[0,3,10,20],dosometh:3,dosomethingtoreturn:3,dot:3,dove:3,down:4,download:[3,15],dst:3,due:3,dump:3,dumper:3,dumpertyp:3,duplic:[0,8],durat:0,dure:15,dynam:[3,16],each:[0,3,6,12,15,16],earlier:3,earliest:3,echo:3,ecrir:[3,5],edf:0,edit:[0,9,15],editor:[3,9,16],either:[3,10],elaps:0,eleg:3,elem:3,element:[0,3],element_factori:3,elementari:3,elementtre:2,els:[0,3,21],embed:14,empti:3,enable_simple_env_script:3,encapsul:[],enclos:3,encod:3,end:[0,3,4,10],english:3,ensur:3,ensure_path_exist:3,enter:0,entir:3,entri:3,env:[0,3,10],env_build:10,env_fil:0,env_info:[0,3],env_launch:10,env_script:10,env_scripts_tmp_dir:0,environ:[1,2,11,16,17],equal:8,eras:13,erase_lin:4,erase_screen:4,err:0,error:[0,3,5,21],essai:5,essai_logging_1:[2,3],essai_logging_2:[2,3],etc:[0,3,16,17],etre:[0,3],eval:3,evalu:3,event:[3,5],everi:0,everyth:8,exactli:3,exampl:[0,2,3,7,8,9,10,14,15,17,20],exc:3,exceed:0,except:[3,5,15,20],exceptionsat:2,exclud:0,exclude_vcs_and_extens:0,exec_command:0,execut:[0,3,8,15,20],execute_cli:3,exept:3,exhaust:[16,20],exist:[0,3,14,15,20],exit:[],exitstatu:[],exot:3,expect:[0,3],explain:10,explan:3,explicitli:3,explor:[3,9],express:[3,9],ext:3,extend_with_children:0,extend_with_fath:0,extens:[0,3,21],extension_ignor:0,extern:3,extra:[0,3],extract:[0,3],extract_param:4,f_exclud:0,fact:21,factor:3,factori:3,fail:[0,3,8],fals:[0,3,4],far:3,favorit:9,feed:3,field:[0,3],file:[0,3,6,8,9,10,12,13,14,15,16,17,21],file_:0,file_board:0,file_dir:0,file_in:3,file_nam:[0,3],file_path:3,fileenviron:2,fileenvwrit:3,filenam:[0,3],filepath:[0,3],files_arb_out:0,files_ignor:0,files_out:0,fill:0,filnam:0,filter:[0,7],fin:3,find:[0,3,9,17,18],find_application_pyconf:0,find_command_list:3,find_dupl:1,find_file_in_lpath:3,find_histori:0,find_job_that_has_nam:0,find_node_by_attrib:3,find_product_scripts_and_pyconf:0,find_products_already_get:0,find_products_with_patch:0,find_test_log:0,findal:3,findconfig:3,findtext:3,finish:[0,3],finish_statu:0,firefox:[13,16],first:[0,3,10,15,21],fix:[0,3],flag:8,flaglin:0,flicacpp:0,flush:3,fmt:[3,5],folder:0,follow:[3,10,21],for_packag:3,forbuild:3,forc:[0,3,14,15],force_patch:15,fore:4,fork:2,form:3,format:[0,3,5,10,16],format_color_except:3,format_except:3,format_list_of_str:0,formatexcept:[3,5],formatt:[3,5],formattim:[3,5],formattupl:3,formatvalu:3,forward:[4,6,12],found:[0,3],four:10,french:21,from:[0,3,4,9,10,11,14,15,21],from_what:3,fromstr:3,full:[0,3],fun:9,func:3,futur:3,gap:0,gdb:10,gencat:[6,12],gener:[1,3,4,6,10,12,17,20],generate_appl:0,generate_catalog:0,generate_compon:0,generate_component_list:0,generate_history_xml_path:0,generate_launch_fil:0,generate_launching_command:3,generate_profile_sourc:0,generate_script:3,generic_opt:20,geom:[0,8],get:[0,3,9,15,16,21],get_all_product_sourc:0,get_arch:0,get_archives_vc:0,get_attr:4,get_attrib:3,get_base_install_dir:3,get_base_path:3,get_build_directori:0,get_cfg_param:3,get_children:0,get_command_line_overrid:3,get_config:3,get_config_children:3,get_config_file_path:0,get_dico_param:0,get_distrib_vers:3,get_distribut:3,get_file_environ:3,get_help:3,get_install_dir:3,get_install_directori:0,get_last_log_fil:0,get_launcher_nam:3,get_log_fil:0,get_log_path:3,get_method:15,get_nam:3,get_nb_proc:[0,3],get_node_text:3,get_paramet:0,get_path:3,get_pid:0,get_posit:4,get_product_compon:3,get_product_config:3,get_product_depend:3,get_product_sect:3,get_product_sourc:0,get_products_info:3,get_products_list:[0,3],get_profile_nam:0,get_property_in_product_cfg:3,get_pyconf_paramet:0,get_python_vers:3,get_recursive_children:0,get_recursive_fath:0,get_salome_modul:0,get_salome_vers:3,get_source_directori:0,get_source_for_dev:0,get_source_from_arch:0,get_source_from_cv:0,get_source_from_dir:0,get_source_from_git:0,get_source_from_svn:0,get_statu:0,get_step:0,get_template_info:0,get_test_timeout:3,get_tmp_dir:3,get_tmp_filenam:3,get_us:3,get_user_config_fil:3,get_win32_cal:4,getbypath:3,getchar:3,getcoloredvers:3,getcommandandappli:3,getcommandinst:3,getcommandslist:3,getconfig:[3,21],getconfigcolor:3,getconfigmanag:3,getdefaultlogg:3,getdetailopt:3,getiter:3,getlocalenv:3,getlog:3,getlogg:3,getlogsandclear:3,getmaxformat:0,getmessag:[3,5],getmodul:3,getmylogg:5,getoutput:[],getparamiko:0,getpars:0,getroot:3,getrootattrib:3,getstatu:[],getstatusoutput:[],getstrconfigdbg:3,getstrconfigstd:3,gettmpdir:3,gettmpdirdefault:3,gettoken:3,getunittestlogg:3,getvalu:3,getvers:3,getwhi:3,git:[0,3,14],git_extract:3,git_info:15,gitconfig:15,give:[0,3,6,16,21],given:[0,3,4,6,10,12],global:[0,3],goe:3,green:[3,4],grei:4,grep:[3,9],grid:[0,3],gui:[0,3],hack_for_distene_lic:0,hack_libtool:3,had:3,handl:[3,4,10],handlemismatch:3,handler:[3,5],handleremovereadonli:3,harri:3,has:[0,3,4,10],has_begun:0,has_fail:0,has_finish:0,has_gui:0,has_pyconf:0,has_salome_hui:3,has_timed_out:3,hat:3,have:[0,3,6,7,11,12,15],header:[0,3],help:[0,3,21],helpstr:3,here:[0,3,10,16,21],hierarchi:3,himself:10,histori:0,hold:12,home:9,host:0,hostnam:0,hour:3,how:[3,10,15,16],html:[3,5],http:[3,4,5],human:3,hxx2salom:11,i18n:3,ident:[0,3],identifi:3,ignor:[0,3,11],ignore_exist:0,ignorelist:3,imag:15,implement:[3,4,10],in_dir:0,includ:[0,3,10,14,16],inconfig:3,indent:3,indentunittest:3,index:3,indic:3,indirect:3,info:[0,3,5,9,15,21],inform:[0,3,5,9,14,15,16],inherit:3,init:[1,3,4,5],initi:[0,3],initialis:[2,3],initialize_board:0,initloggerasdefault:3,initloggerasunittest:3,initmylogg:5,inmap:3,input:[0,3],input_list:3,insid:15,instal:[0,3,7,8,16,17,20],install_dir:10,instanc:[0,3,4,21],instanti:[0,3],instead:3,instream:3,instruct:[3,16],intal:14,integ:0,interact:[0,13],interfac:[3,20],intern:3,internation:3,interpret:[],invalid:3,ioerror:3,ios:3,iostream:3,is_a_tti:4,is_defin:3,is_dev:0,is_occupi:0,is_run:0,is_salome_modul:[0,7,10],is_stream_clos:4,is_timeout:0,is_window:3,isdir:3,isel:3,isfil:3,islink:3,isok:3,issu:4,istypeconfig:3,isword:3,item:3,iter:3,iteritem:3,iterkei:3,iterpars:3,its:[0,3,8,9,10,16],ivar:3,jane:3,job:[1,8],job_config_nam:0,job_def:0,job_fil:0,job_file_path:0,jobs_config:0,join:10,jos:0,json:3,jsondump:3,just:8,keep:3,kei:[0,3,10,15],kernel:[0,9,20],kfsy:3,kill:0,kill_remote_process:0,killsalom:3,kind:0,know:[3,15],known:[3,14],knownfailure_statu:3,ko_statu:3,kosi:3,kwarg:4,kwd:4,l_cfg_dir:0,l_job:0,l_jobs_not_todai:0,l_path:0,l_pinfo_vc:0,l_product:0,l_products_info:0,l_remote_log_fil:0,l_salome_modul:0,l_str:0,label:[0,3,9],lang:3,lapack:10,lapack_root_dir:10,last:[0,3,10,13],last_termin:13,last_upd:0,later:14,latter:3,launch:[0,3,10],launch_command:3,launched_cmd:3,launcher:[1,3,6,10,17],launcher_nam:[0,12],launcherfileenviron:3,launchsat:3,layer:11,ld_library_path:10,left:10,len_col:0,len_end:0,lenght:0,lenght_column:0,length:0,less:3,level:[3,5,20],levelnam:[3,5],lhs:3,lib:[5,10],librari:[3,5],licenc:0,light:[0,4],lightblack_ex:4,lightblue_ex:4,lightcyan_ex:4,lightgreen_ex:4,lightmagenta_ex:4,lightred_ex:4,lightwhite_ex:4,lightyellow_ex:4,like:[0,3,4,6,8,9,12,16],limit:3,line:[0,3,9,20],link:[0,3,15],list:[0,3,6,7,9,12,16],list_directori:0,list_log_fil:3,list_of_product:11,listtest:3,llvm:[6,12],load:[3,16],load_cfg_environ:3,load_environ:3,local:[0,3,9],locat:[0,3],log:[1,3,5,8,17,21],log_command:3,log_dir:[0,13],log_res_step:3,log_step:3,logdir:[0,3],logfilepath:3,logger:[0,3,5],logger_info_tupl:3,loggingsat:2,login:15,logo:[3,12],logrecord:[3,5],lome:17,longnam:3,lost:3,lpath:[0,3],lproduct:3,machin:[0,3,6,11,12,14],machine1:6,machine2:6,machine3:6,machine_nam:0,magenta:[3,4],mai:15,main:[0,3,8],mainten:0,make:[1,3,8],make_alia:0,make_all_product:0,make_arch:0,make_flag:8,make_opt:[0,3],make_product:0,makeinstal:1,makeinstall_all_product:0,makeinstall_product:0,makepath:3,manag:[0,3,9,15],manipul:[0,3,9],map1:3,map2:3,map:[0,3],match:3,max:3,max_product_name_len:0,maximum:0,mechan:[3,10],med:8,medcoupl:0,memori:[3,6,12],menu:13,merg:3,merge:3,merge_dict:3,mergemap:3,mergesequ:3,mesa:[6,12],messag:[0,3,5,21],method:[0,3,4,8,10,15,21],milou:3,minim:3,minut:3,mismatch:3,miss:[6,8],mistak:15,mix:0,mkdir:0,mode:[0,3,4,7,9,10,13,20],model:21,modifi:[0,3,10,15],modul:[1,2,6,8,11,12,15,16,17],module_gener:0,module_path:0,moment:3,mon:3,mond:21,more:[0,3,20],most:[0,3,10],move_test_result:0,msg:3,multi:3,multilin:3,multipl:3,must:[0,21],mutipl:3,my_application_directori:6,my_application_nam:6,my_job:0,my_product_nam:0,my_tag:15,mycommand:21,myformatt:5,mylogg:5,myoption:21,myspecificnam:14,mytempl:3,na_statu:3,name:[0,3,6,7,9,10,12,14,15,16,20,21],name_arch:0,name_job:0,name_nod:3,name_product:0,namespac:3,nasi:3,nativ:[0,3,10],nb_line:3,nb_proc:[0,3,8],ndsy:3,necessari:3,need:[0,3,4,6,11,15],new_nam:9,newer:0,newlin:[],next:3,nice:[],no_label:9,node:[0,3],node_nam:3,non:4,none:[0,3,4,5],nor:4,normal:[3,4],note:[3,6,10,12,16],noth:[0,3,14],notimplementederror:3,notion:3,notshowncommand:[0,3],now:0,number:[0,3,6,8,12,13],number_of_proc:3,numpi:0,obj1:3,obj2:3,obj:3,object:[0,3,4,16],obsolesc:0,obsolet:[3,21],obtain:3,obvious:3,occur:3,offset:0,ok_statu:3,oksi:3,old:3,older:13,on_stderr:4,onc:15,one:[0,3,9],onli:[0,3,6,7,8,9,10,11,12,13,15,20],only_numb:3,ool:17,open:3,openggl:[6,12],openmpi:3,oper:[0,3,5,9,17],operand:[3,5],opt_nb_proc:3,option:[0,2,4,6,8,9,10,11,12,13,14,15,16,21],optionali:3,optionn:3,optionnali:3,optiontyp:3,optresult:[0,3],order:[0,3,15,16,21],org:[3,4,5],other:[3,5,10,14,16],otherwis:[0,3,15],our:4,out:[0,3,5],out_dir:[0,3],output:[0,3,4],outstream:3,outtext:[],overrid:[3,6],overwrit:3,overwritekei:3,overwritemergeresolv:3,overwritten:3,own:3,p_info:0,p_name:0,p_name_info:0,p_name_p_info:0,packag:[1,2,17,18,21],pad:0,page:10,pair:[0,3],param:[0,3,4],param_def:0,param_nam:3,paramet:[0,3,9,16,21],parameter_path:9,paramiko:0,paramstr:4,paravi:[0,6,12],paraview:0,parent:[0,3],pars:[0,3,21],parse_arg:[3,21],parse_csv_board:0,parse_d:3,parseargu:3,parsefactor:3,parsekeyvaluepair:3,parsemap:[0,3],parsemappingbodi:3,parser:[3,21],parserefer:3,parsescalar:3,parsesequ:3,parsesuffix:3,parseterm:3,parsevalu:3,part:[3,6,10,12],particular:3,pas:5,pass:[0,3,16,21],passphras:15,passwd:0,password:15,pat:3,patch:[1,3,9,15],patches_tmp_dir:0,path:[0,3,10,12],path_in_arch:0,path_on_local_machin:0,path_to_catalog:6,path_to_check:0,path_to_yacsgen:11,pathlaunch:0,pathlist:3,pattern:3,pdf:[9,17],pend:7,pendant:3,perform:[3,15,17],person:9,phase:3,pid:0,pipe:[],platform:[4,10],pleas:[10,11],plugin:[3,8],pluma:16,plusieur:5,point:[3,21],pop_debug:3,popen:3,popul:3,port:0,posit:4,possibl:[0,3,10,15,21],post:3,potenti:3,pprty:3,preced:3,predefin:3,prefer:[9,16],prefix:[0,3,10,16],prepar:[1,3,17,21],preparatori:[3,5],prepare_from_templ:0,prepare_testbas:3,prepare_testbase_from_dir:3,prepare_testbase_from_git:3,prepare_testbase_from_svn:3,prepend:[3,10],prepend_valu:3,prereq_dir:10,prerequisit:[10,14,16,17,20],presenc:3,present:3,pretti:3,previou:[0,3],previous:7,print:[0,3,4,9,13],print_debug:3,print_grep_environ:3,print_help:3,print_log_command_in_termin:0,print_split_environ:3,print_split_pattern_environ:3,print_valu:3,problem:[3,6,12],procedur:[0,3],process:[0,3,15],processinginstruct:3,processor:[0,3,6,12],prod_dir:3,prod_info:[0,3],prod_nam:0,produc:[0,3],produce_install_bin_fil:0,produce_relative_env_fil:0,produce_relative_launch:0,product1:[8,10,15],product2:[8,10,15],product:[0,2,7,8,9,10,11,12,14,15,17,21],product_appli_creation_script:0,product_cfg:3,product_compil:3,product_has_dir:0,product_has_env_script:3,product_has_logo:3,product_has_patch:3,product_has_salome_gui:3,product_has_script:3,product_info:[0,3],product_inform:[0,3],product_is_autotool:3,product_is_cmak:3,product_is_cpp:3,product_is_debug:3,product_is_dev:3,product_is_fix:3,product_is_gener:3,product_is_mpi:3,product_is_n:3,product_is_salom:3,product_is_sampl:3,product_is_smesh_plugin:3,product_is_vc:3,product_log_dir:0,product_nam:[0,3],products_info:0,products_pyconf_tmp_dir:0,profil:[1,3,12],profileconfigread:0,profilerefer:0,program:3,programmat:10,progress:[0,3],progress_bar:0,project:[0,3,9,10],project_file_path:0,project_packag:0,project_path:3,prop:0,proper:0,properti:[0,3,7,10,11],protocol:[3,6],provid:[0,3,10,21],proxi:4,pubid:3,publish:0,pure:0,push:15,push_debug:3,put:[0,3],put_dir:0,put_jobs_not_todai:0,put_txt_log_in_appli_log_dir:3,pv_plugin_path:3,pwd:3,pyc:5,pyconf:[0,2,8,9,10,15,16,21],python2:5,python:[0,3,5,10,12,16,17,18,21],python_config:3,pythoncompon:0,pythonpath:10,pythonpath_:10,qname:3,queri:[6,12],question:3,rais:[0,3,20],raiseifko:3,raw:3,raw_input:0,rc1:3,rc2:3,rcfinal:3,rco:[0,3],reach:0,read:[0,3],read_config_from_a_fil:3,read_result:3,readabl:3,reader:3,readi:15,readlin:3,readlink:3,readxmlfil:3,record:[3,5],recurs:[0,3,9],red:[3,4],redefin:3,redirect:3,reduc:0,ref:3,refer:[0,3,11,16],reflect:3,regard:[0,3],regular:3,reinit:[3,4],rel:[0,3,14],remain:[13,18],remark:6,remor:11,remot:[0,3,14],remov:[0,3,7,8,15],remove_item_from_list:3,remove_log_fil:0,remove_product:0,removenamespac:3,renam:3,renint:3,replac:[0,3,6],replace_in_fil:3,report:[0,3],repositori:[0,3,15],repr:3,repres:[0,3],represent:3,request:4,requir:[0,3,4,10,11],res:[0,3],reserv:3,reset:[3,4],reset_al:4,resolut:3,resolv:3,resourc:[6,12],respect:10,restor:[3,7],result:[0,3],retcod:0,retriev:3,returncod:[0,2],rhs:3,right:[0,3,10],root:[3,21],root_nod:3,rootnam:3,rtype:[0,3],run:[1,3,10,16,17,21],run_all_test:3,run_env_script:3,run_grid_test:3,run_job:0,run_script:3,run_script_all_product:0,run_script_of_product:0,run_session_test:3,run_simple_env_script:3,run_test:3,run_testbase_test:3,runappli:6,runner:[0,3,21],ruud:3,sajip:3,salom:[0,3,6,7,8,9,10,11,12,14,16,18],salome_modul:3,salome_session_serv:3,salome_xx:[7,14,18,20],salome_xx_:14,salomeapp:0,salomecontext:3,salomeenviron:3,salometool:[0,2,6,9,10,14,16,17,18],same:[0,3],sametmax:[3,5],sampl:[3,20],sat:[0,3,6,7,8,9,10,11,12,13,14,15,16,17,18,21],sat_local_path:0,sat_path:0,save:10,save_fil:0,saveconfigdbg:3,saveconfigstd:3,scalar:3,scratch:3,screenenviron:3,script:[1,3,8,9,10,12,16,17,18],script_nam:3,script_path:3,search:[0,3],search_known_error:3,search_templ:0,second:[0,3,10],section:[3,6,10,15],secur:15,see:[0,3,4,16,20],seen:3,select:[3,14],self:[0,3],semant:3,sep:[3,10],separ:3,seq1:3,seq2:3,seq:3,seqit:3,sequenc:[3,4],server:[3,15],servic:21,session:[0,3],set:[0,3,6,7,10,12,16,17,21],set_a_product:3,set_application_env:3,set_attr:4,set_consol:4,set_cpp_env:3,set_cursor_posit:4,set_env:[3,10],set_env_build:10,set_env_launch:10,set_full_environ:3,set_local_valu:0,set_native_env:[3,10],set_product:3,set_python_libdir:3,set_salome_generic_product_env:3,set_salome_minimal_product_env:3,set_titl:4,set_user_config_fil:3,setcolorlevelnam:3,setconsoletextattribut:4,setlocal:3,setnotlocal:3,setpath:3,setstatu:3,setstream:3,settings_fil:0,setvalu:3,setwhi:3,sever:[0,10,16],shallow:3,shell:[1,3,10],shortcut:3,shortnam:3,should:[3,10,11],should_wrap:4,show:[0,3,8,13],show_command_log:3,show_desktop:3,show_full_path:3,show_in_editor:3,show_label:3,show_last_log:0,show_patch:[0,3,9],show_product_info:3,show_product_last_log:0,show_progress:3,show_warn:3,showinfo:3,shown:[3,8],sign:3,silent:[0,3],similar:3,simpl:[3,20,21],sinc:[0,3],site:0,size:[0,3],slogan:0,small:3,smart:3,smartcopi:3,smesh:3,softwar:15,some:[0,3,10,12,16,21],someon:10,sometim:7,sommeil:3,soon:8,sort:0,sort_product:0,sourc:[1,3,4,5,7,9,14,15],source_dir:0,source_packag:0,sourcepackag:0,sources_without_dev:7,space:3,special_path_separ:3,specif:[0,3,6,7,10,11,12,14,16,20],specifi:[3,5,6,10,11,12,15],splashscreen:12,split:3,src:[0,17,21],src_root:[0,3],sre_pattern:[3,4],srs:3,srsc:3,ssh:[0,6,12,15],ssh_connection_all_machin:0,stack:[3,20],stackoverflow:3,start:[3,4,6,8,12],state:0,statu:[0,3],stderr:[0,3],stdin:0,stdout:[0,3,4],step:[3,5],stop:[0,8],stop_first_fail:8,store:[0,3,8,9,13,15,16],str:[0,3],str_in:3,str_num:3,str_of_length:0,str_out:3,stream:[0,3,4],streamopen:3,streamorfil:3,streamwrapp:4,strftime:[3,5],string:[0,3,5],stringio:3,strip:4,strorlist:3,structur:16,sts:[],stuff:[3,12],style:[0,3,4],stylesheet:[0,3],sub:[0,3,16],subclass:3,subel:3,submodul:[1,2],subpackag:2,subprocess:3,subsect:10,subset:14,subst_dic:3,substitut:[0,3],substr:3,subtract:3,succe:0,success:[0,3,8],success_fail:0,successfulli:3,successfully_connect:0,suffici:10,suffix:[0,3],suit:17,suitabl:3,sum:3,summari:[],support:3,suppos:3,supposedli:3,suppress:[0,7],suppress_directori:0,sur:5,svn:[0,3,14],svn_extract:3,svn_info:15,symlink:3,syntax:[0,3,7],sys:3,syss:3,system:[2,14],tab:3,tabl:3,tabul:3,tag:[3,15],take:[0,3,7],taken:[3,10],tar:[0,14,18],tarfil:0,target:[0,3,6,10],target_dir:0,tcllibpath:3,templat:[1,2],template_fil:3,template_nam:0,templateset:0,temporari:0,term:3,termin:[0,3,4,8,13,21],test:[1,3,5,8,17],test_bas:0,test_base_nam:3,test_config:3,test_grid:3,test_modul:2,test_nam:3,test_sess:3,testbas:3,testbase_bas:3,testbase_dir:3,testbase_nam:3,testbase_tag:3,testlogger1:5,testlogger_1:3,text:[0,3,4,5,20],text_or_uri:3,tgz:[14,18],thank:3,thei:[0,7,9,10,15],them:[4,15],thi:[0,3,4,6,8,9,10,11,12,14,15,16,17,21],thing:21,those:11,through:[3,6,10,12,13],thrown:3,time:[0,3,5,7,10,15,16],time_elaps:0,timedelta:3,timedelta_total_second:3,timeout:[0,3],timeout_statu:3,tintin:3,tip:3,titl:[3,4],tklibpath:3,tmp:[0,3],tmp_working_dir:[0,3],tocolor:3,tocolor_ansitowin32:3,todai:0,todo:3,tofix:3,token:3,token_typ:3,token_valu:3,too:3,top:3,tosi:3,tostr:3,total:0,total_dur:0,total_second:3,tout:21,tparam:0,trace:[0,3,20],traceback:3,trail:[],transform:[0,3],transpar:4,tree:3,treebuild:3,trust_root_dir:10,tty:4,tupl:[0,3],turn:3,tutori:3,two:[3,10],txt:3,type:[0,3,15],typeerror:3,unabl:3,unchang:3,unconditionali:[3,20],under:[0,3,17],underscor:[3,10],unicod:3,unit:8,unittest:3,unittestformatt:3,unitteststream:3,unix:3,unknown_statu:3,unless:[4,15],updat:[0,3],update_config:0,update_hat_xml:3,update_jobs_states_list:0,update_pyconf:0,update_xml_fil:0,updatehatxml:3,upload:0,urllib2:3,urlopen:3,usag:[3,17],use:[0,3,6,8,10,12,13,14,15,16,18],use_mesa:[6,12],used:[0,3,5,6,8,9,10,13,14,15,16,17],useful:[3,10,12,21],user:[0,3,9,10,13,14,18,20],usernam:3,uses:[0,3,5,10,11,15,16],usestim:[3,5],using:[0,3,4,5,11],usr:[3,5,10],usual:[3,7,11,14,16,18,20],utf:[3,10],util:[3,14,17],utilis:5,utilssat:2,val:0,valid:3,valmax:0,valmin:0,valu:[0,3,4,6,7,9,15,16],variabl:[0,3,10,11,21],vcs:[0,3],verbos:3,verifi:[0,3,15],version:[0,3,10,11,14,16,17],via:3,viewer:9,vinai:3,virtual:[3,6],virtual_app:6,visualis:10,wai:[0,3,8,21],wait:0,want:[0,3,7,10],warn:[0,3,5,8,21],web:[9,13,16],week:0,welcom:3,welkom:3,well:3,were:3,what:[0,3,7],when:[0,3,6,10,15,16,21],whenev:3,where:[0,3,6,8,9,14],which:[0,3,4,5,10,11,16,21],white:[3,4],who:11,why:3,width:0,wiki:4,wikipedia:4,wil:10,win32:[2,3],winapi_test:4,wincolor:4,window:[3,4,10],winstyl:4,winterm:[2,3],with_children:8,with_commerci:[0,3],with_fath:8,with_install_dir:3,with_vc:[0,14],within:10,without:[3,9,15],without_dev:0,without_native_fix:0,without_properti:14,wmake:3,word:3,work:[0,3,9,14,15,16],workdir:[3,6,9,12,14,16,20,21],world:21,would:3,wrap:[3,4],wrap_stream:4,writabl:3,write:[0,3,4],write_all_result:0,write_all_source_fil:0,write_and_convert:4,write_back:3,write_cfgforpy_fil:3,write_env_fil:3,write_info:0,write_plain_text:4,write_report:3,write_result:0,write_test_margin:3,write_tre:3,write_xml_fil:0,writeinfo:21,writetostream:3,writevalu:3,written:21,www:3,xa4:3,xc2:3,xml:[0,3,21],xml_dir_path:0,xml_file:0,xml_history_path:0,xml_node_job:0,xmllogfil:[0,3],xmlmanag:[0,2],xmlmgr:3,xmlname:0,xmlroot:3,xmltreebuild:3,xxx:[3,7,16],xxx_root_dir:3,xxx_src_dir:3,yacsgen:[0,3,11],yacsgen_root_dir:11,year:3,yellow:[3,4],yes:[0,3,7,10,11,15],yet:[3,20],yield:[3,5],you:[0,3,6,7,10,12,15,17,21],your:[0,3,10,15,20,21],yourspecificnam:14,yve:3,yyi:16,yyyi:3,yyyymmdd_hhmmss:3,yyyymmdd_hhmmss_namecmd:3,zelaunch:12,zero:3,zerodivideerror:3},titles:["commands package","commands","src","src package","src.colorama package","src.example package","Command application","Command clean","Command compile","Command config","Command environ","Command generate","Command launcher","Command log","Command package","Command prepare","Configuration","Salome Tools","Installation","Release notes","Usage of SAlomeTools","Add a user custom command"],titleterms:{"var":16,VCS:15,access:21,add:21,ansi:4,ansitowin32:4,applic:[0,6,16],architectur:3,avail:[7,20],base:15,basic:21,build:20,catchal:3,check:0,clean:[0,7],code:17,colorama:4,coloringsat:3,command:[0,1,6,7,8,9,10,11,12,13,14,15,17,21],compil:[0,3,8,20],config:[0,9,21],configmanag:3,configur:[0,6,7,8,9,10,12,13,14,15,16],content:[0,3,4,5],custom:21,cvs:15,debug:[3,20],descript:[6,7,8,9,10,11,12,13,14,15,16],dev:15,develop:17,document:17,elementtre:3,environ:[0,3,10],essai_logging_1:5,essai_logging_2:5,exampl:[5,21],exceptionsat:3,fileenviron:3,find_dupl:0,fork:3,gener:[0,11],get:20,git:15,hello:21,help:20,howto:21,init:0,initialis:4,instal:18,introduct:21,job:0,launcher:[0,12],list:[17,20],log:[0,13],logger:21,loggingsat:3,make:0,makeinstal:0,mode:15,modul:[0,3,4,5],note:[17,19],option:[3,7,20],other:21,packag:[0,3,4,5,14],patch:0,path:[6,7,8,9,13,14,15],prepar:[0,15,20],product:[3,16,20],profil:0,pyconf:3,quick:17,releas:[17,19],remark:[11,15],requir:21,returncod:3,run:0,salom:[17,20],salometool:[3,20,21],sat:20,script:0,section:16,shell:0,some:[6,7,8,9,13,14,15],sourc:[0,20],src:[2,3,4,5],start:17,submodul:[0,3,4,5],subpackag:3,svn:15,syntax:16,system:3,templat:[0,3],test:0,test_modul:3,tool:17,usag:[6,7,8,9,10,11,12,13,14,15,20],useful:[6,7,8,9,13,14,15],user:[16,21],utilssat:3,verbos:20,win32:4,winterm:4,xmlmanag:3}})
\ No newline at end of file
diff --git a/doc/build/html/usage_of_sat.html b/doc/build/html/usage_of_sat.html
index 66d8975..6c926c6 100644
--- a/doc/build/html/usage_of_sat.html
+++ b/doc/build/html/usage_of_sat.html
@@ -1,32 +1,21 @@
+
 
 
-
 
+    
-    
     Usage of SAlomeTools — salomeTools 5.0.0dev documentation
-    
     
-    
-    
+    
-    
+    
-    
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
            
@@ -49,28 +37,28 @@
 
            
 
            Usage¶
            
 
            sat usage is a Command Line Interface (CLI).
            
-
            sat [generic_options] [command] [product] [command_options]
+
            sat [generic_options] [command] [product] [command_options]
 
            
 
            
 
            
 
            Options of sat¶
            
 
            Useful not exhaustive generic options of sat CLI.
            
 
            
-
            --help or -h¶
            
+
            –help or -h¶
            
 
            Get help as simple text.
            
-
            sat --help          # get the list of existing commands
+
            sat --help          # get the list of existing commands
 sat --help compile  # get the help on a specific command 'compile'
 
            
 
            
 
            
 
            
-
            --debug or -g¶
            
+
            –debug or -g¶
            
 
            Execution in debug mode allows to see more trace and stack if an exception is raised.
            
 
            
 
            
-
            --verbose or -v¶
            
+
            –verbose or -v¶
            
 
            Change verbosity level (default is 3).
            
-
            # for product 'SALOME_xx' for example
+
            # for product 'SALOME_xx' for example
 # execute compile command in debug mode with trace level 4
 sat -g -v 4 compile SALOME_xx
 
            
@@ -83,25 +71,25 @@ sat -g -v 4 compile SALOME_xx
 
            
 
            Get the list of available products¶
            
 
            To get the list of the current available products in your context:
            
-
            sat config --list
+
            sat config --list
 
            
 
            
 
            
 
            
 
            Prepare sources of a product¶
            
 
            To prepare (get) all the sources of a product (SALOME_xx for example):
            
-
            sat prepare SALOME_xx
+
            sat prepare SALOME_xx
 
            
 
            
 
            
 
            The sources are usually copied in directories
            
-
            $USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name
            
+
            $USER.workDir + SALOME_xx… + SOURCES + $PRODUCT.name
            
 
            
 
            
 
            
 
            Compile SALOME¶
            
 
            To compile products:
            
-
            # compile all prerequisites/products
+
            # compile all prerequisites/products
 sat compile SALOME_xx
 
 # compile only 2 products (KERNEL and SAMPLES), if not done yet
@@ -113,10 +101,10 @@ sat compile SALOME_xx ---products SAMPLES --clean_all
 
            
 
            
 
            The products are usually build in the directories
            
-
            $USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name
            
+
            $USER.workDir + SALOME_xx… + BUILD + $PRODUCT.name
            
 

            
 
            The products are usually installed in the directories
            
-
            $USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name
            
+
            $USER.workDir + SALOME_xx… + INSTALL + $PRODUCT.name
            
 
            
 
            
 
            
@@ -136,9 +124,9 @@ sat compile SALOME_xx ---products SAMPLES --clean_all
 
          • Usage of SAlomeTools
            • 
@@ -186,11 +176,11 @@ sat compile SALOME_xx ---products SAMPLES --clean_all
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/html/write_command.html b/doc/build/html/write_command.html
index a7a2b3e..20db9d6 100644
--- a/doc/build/html/write_command.html
+++ b/doc/build/html/write_command.html
@@ -1,32 +1,21 @@
+
 
 
-
 
   
+    
     
-    
     Add a user custom command — salomeTools 5.0.0dev documentation
-    
     
     
-    
-    
+    
     
     
     
-    
+    
     
     
-    
     
     
    
@@ -35,8 +24,7 @@
   
   
 
-  
-  
+  
   
 
     
            
@@ -53,7 +41,7 @@
 
            This documentation is for Python developers.
            
 
            
 
            The salomeTools product provides a simple way to develop commands.
-The first thing to do is to add a file with .py extension in the commands directory of salomeTools.
            
+The first thing to do is to add a file with .py extension in the commands directory of salomeTools.
            
 
            Here are the basic requirements that must be followed in this file in order to add a command.
            
 
            
 
            
@@ -62,9 +50,9 @@ The first thing to do is to add a file with .py extension in the Warning
            
 
            ALL THIS IS OBSOLETE FOR SAT 5.1
            
 
            
-
            By adding a file mycommand.py in the commands directory, salomeTools will define a new command named mycommand.
            
+
            By adding a file mycommand.py in the commands directory, salomeTools will define a new command named mycommand.
            
 
            In mycommand.py, there must be the following method:
            
-
            def run(args, runner, logger):
+
            def run(args, runner, logger):
     # your algorithm ...
     pass
 
            
@@ -74,7 +62,7 @@ But there are some useful services provided by salomeTools :
            
 
              
 
            • You can give some options to your command:
              • 
 
            
-
            import src
+
            import src
 
 # Define all possible option for mycommand command :  'sat mycommand <options>'
 parser = src.options.Options()
@@ -91,7 +79,7 @@ But there are some useful services provided by salomeTools :
            
 
              
 
            • You can add a description method that will display a message when the user will call the help:
              • 
 
            
-
             import src
+
             import src
 
  # Define all possible option for mycommand command : 'sat mycommand <options>'
  parser = src.options.Options()
@@ -117,25 +105,25 @@ It gives access to runner.getConfig() which is the data model defined f
 For example, runner.cfg.APPLICATION.workdir
 contains the root directory of the current application.
            
 
            The runner variable gives also access to other commands of salomeTools:
            
-
            # as CLI_ 'sat prepare ...'
+
            # as CLI_ 'sat prepare ...'
 runner.prepare(runner.cfg.VARS.application)
 
            
 
            
 
            
 
            
 
            HowTo logger¶
            
-
            The logger variable is an instance of the python logging package class.
-It gives access to debug, info, warning, error, critical methods.
            
+
            The logger variable is an instance of the python logging package class.
+It gives access to debug, info, warning, error, critical methods.
            
 
            Using these methods, the message passed as parameter
 will be displayed in the terminal and written in an xml log file.
            
-
            logger.info("My message")
+
            logger.info("My message")
 
            
 
            
 
            
 
            
 
            HELLO example¶
            
 
            Here is a hello command, file commands/hello.py:
            
-
            import src
+
            import src
 
 """
 hello.py
@@ -154,13 +142,13 @@ will be displayed in the terminal and written in an xml log file.
            
     (options, args) = parser.parse_args(args)
     # algorithm
     if not options.french:
-        logger.write('HELLO! WORLD!\n')
+        logger.info('HELLO! WORLD!\n')
     else:
-        logger.write('Bonjour tout le monde!\n')
+        logger.writeinfo('Bonjour tout le monde!\n')
 
            
 
            
 
            A first call of hello:
            
-
            # Get the help of hello:
+
            # Get the help of hello:
 ./sat --help hello
 
 # To get bonjour
@@ -210,18 +198,20 @@ HELLO! WORLD!
   
            
     
            This Page
            
     
    
            
 
 
         
            
@@ -232,11 +222,11 @@ HELLO! WORLD!
       ©2018, CEA.
       
       |
-      Powered by Sphinx 1.4.9
-      & Alabaster 0.7.8
+      Powered by Sphinx 1.7.3
+      & Alabaster 0.7.10
       
       |
-      Page source
     
            
 
diff --git a/doc/build/latex/Makefile b/doc/build/latex/Makefile
new file mode 100644
index 0000000..c561680
--- /dev/null
+++ b/doc/build/latex/Makefile
@@ -0,0 +1,68 @@
+# Makefile for Sphinx LaTeX output
+
+ALLDOCS = $(basename $(wildcard *.tex))
+ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
+ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
+ALLXDV =
+ALLPS  = $(addsuffix .ps,$(ALLDOCS))
+ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
+
+# Prefix for archive names
+ARCHIVEPREFIX =
+# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file)
+export LATEXOPTS =
+# Additional latexmk options
+LATEXMKOPTS =
+# format: pdf or dvi (used only by archive targets)
+FMT = pdf
+
+LATEX = latexmk -dvi
+PDFLATEX = latexmk -pdf -dvi- -ps-
+
+
+%.png %.gif %.jpg %.jpeg: FORCE_MAKE
+	extractbb '$@'
+
+%.dvi: %.tex FORCE_MAKE
+	$(LATEX) $(LATEXMKOPTS) '$<'
+
+%.ps: %.dvi
+	dvips '$<'
+
+%.pdf: %.tex FORCE_MAKE
+	$(PDFLATEX) $(LATEXMKOPTS) '$<'
+
+all: $(ALLPDF)
+
+all-dvi: $(ALLDVI)
+
+all-ps: $(ALLPS)
+
+all-pdf: $(ALLPDF)
+
+zip: all-$(FMT)
+	mkdir $(ARCHIVEPREFIX)docs-$(FMT)
+	cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
+	zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT)
+	rm -r $(ARCHIVEPREFIX)docs-$(FMT)
+
+tar: all-$(FMT)
+	mkdir $(ARCHIVEPREFIX)docs-$(FMT)
+	cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
+	tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT)
+	rm -r $(ARCHIVEPREFIX)docs-$(FMT)
+
+gz: tar
+	gzip -9 < $(ARCHIVEPREFIX)docs-$(FMT).tar > $(ARCHIVEPREFIX)docs-$(FMT).tar.gz
+
+bz2: tar
+	bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
+
+xz: tar
+	xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
+
+clean:
+	rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk
+
+.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz
+.PHONY: FORCE_MAKE
\ No newline at end of file
diff --git a/doc/build/latex/footnotehyper-sphinx.sty b/doc/build/latex/footnotehyper-sphinx.sty
new file mode 100644
index 0000000..5995f01
--- /dev/null
+++ b/doc/build/latex/footnotehyper-sphinx.sty
@@ -0,0 +1,269 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{footnotehyper-sphinx}%
+ [2017/10/27 v1.7 hyperref aware footnote.sty for sphinx (JFB)]
+%%
+%% Package: footnotehyper-sphinx
+%% Version: based on footnotehyper.sty 2017/03/07 v1.0
+%% as available at http://www.ctan.org/pkg/footnotehyper
+%% License: the one applying to Sphinx
+%%
+%% Refer to the PDF documentation  at http://www.ctan.org/pkg/footnotehyper for
+%% the code comments.
+%%
+%% Differences:
+%% 1. a partial tabulary compatibility layer added (enough for Sphinx mark-up),
+%% 2. use of \spx@opt@BeforeFootnote from sphinx.sty,
+%% 3. use of \sphinxunactivateextrasandspace from sphinx.sty,
+%% 4. macro definition \sphinxfootnotemark,
+%% 5. macro definition \sphinxlongtablepatch
+%% 6. replaced an \undefined by \@undefined
+\DeclareOption*{\PackageWarning{footnotehyper-sphinx}{Option `\CurrentOption' is unknown}}%
+\ProcessOptions\relax
+\newbox\FNH@notes
+\newdimen\FNH@width
+\let\FNH@colwidth\columnwidth
+\newif\ifFNH@savingnotes
+\AtBeginDocument {%
+    \let\FNH@latex@footnote    \footnote
+    \let\FNH@latex@footnotetext\footnotetext
+    \let\FNH@H@@footnotetext   \@footnotetext
+    \newenvironment{savenotes}
+        {\FNH@savenotes\ignorespaces}{\FNH@spewnotes\ignorespacesafterend}%
+    \let\spewnotes      \FNH@spewnotes
+    \let\footnote       \FNH@footnote
+    \let\footnotetext   \FNH@footnotetext
+    \let\endfootnote    \FNH@endfntext
+    \let\endfootnotetext\FNH@endfntext
+    \@ifpackageloaded{hyperref}
+     {\ifHy@hyperfootnotes
+         \let\FNH@H@@footnotetext\H@@footnotetext
+      \else
+         \let\FNH@hyper@fntext\FNH@nohyp@fntext
+      \fi}%
+     {\let\FNH@hyper@fntext\FNH@nohyp@fntext}%
+}%
+\def\FNH@hyper@fntext{\FNH@fntext\FNH@hyper@fntext@i}%
+\def\FNH@nohyp@fntext{\FNH@fntext\FNH@nohyp@fntext@i}%
+\def\FNH@fntext #1{%
+  \ifx\ifmeasuring@\@undefined
+    \expandafter\@secondoftwo\else\expandafter\@firstofone\fi
+% these two lines modified for Sphinx (tabulary compatibility):
+    {\ifmeasuring@\expandafter\@gobbletwo\else\expandafter\@firstofone\fi}%
+    {\ifx\equation$\expandafter\@gobbletwo\fi #1}%$
+}%
+\long\def\FNH@hyper@fntext@i#1{%
+  \global\setbox\FNH@notes\vbox
+  {\unvbox\FNH@notes
+   \FNH@startnote
+   \@makefntext
+    {\rule\z@\footnotesep\ignorespaces
+     \ifHy@nesting\expandafter\ltx@firstoftwo
+             \else\expandafter\ltx@secondoftwo
+     \fi
+     {\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}{#1}}%
+     {\Hy@raisedlink
+       {\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}%
+       {\relax}}%
+      \let\@currentHref\Hy@footnote@currentHref
+      \let\@currentlabelname\@empty
+      #1}%
+     \@finalstrut\strutbox
+    }%
+   \FNH@endnote
+  }%
+}%
+\long\def\FNH@nohyp@fntext@i#1{%
+  \global\setbox\FNH@notes\vbox
+  {\unvbox\FNH@notes
+   \FNH@startnote
+   \@makefntext{\rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}%
+   \FNH@endnote
+  }%
+}%
+\def\FNH@startnote{%
+  \hsize\FNH@colwidth
+  \interlinepenalty\interfootnotelinepenalty
+  \reset@font\footnotesize
+  \floatingpenalty\@MM
+  \@parboxrestore
+  \protected@edef\@currentlabel{\csname p@\@mpfn\endcsname\@thefnmark}%
+  \color@begingroup
+}%
+\def\FNH@endnote{\color@endgroup}%
+\def\FNH@savenotes{%
+  \begingroup
+  \ifFNH@savingnotes\else
+    \FNH@savingnotestrue
+    \let\@footnotetext    \FNH@hyper@fntext
+    \let\@mpfootnotetext  \FNH@hyper@fntext
+    \let\H@@mpfootnotetext\FNH@nohyp@fntext
+    \FNH@width\columnwidth
+    \let\FNH@colwidth\FNH@width
+    \global\setbox\FNH@notes\box\voidb@x
+    \let\FNH@thempfn\thempfn
+    \let\FNH@mpfn\@mpfn
+    \ifx\@minipagerestore\relax\let\@minipagerestore\@empty\fi
+    \expandafter\def\expandafter\@minipagerestore\expandafter{%
+      \@minipagerestore
+      \let\thempfn\FNH@thempfn
+      \let\@mpfn\FNH@mpfn
+    }%
+  \fi
+}%
+\def\FNH@spewnotes {%
+  \endgroup
+  \ifFNH@savingnotes\else
+   \ifvoid\FNH@notes\else
+    \begingroup
+     \let\@makefntext\@empty
+     \let\@finalstrut\@gobble
+     \let\rule\@gobbletwo
+     \FNH@H@@footnotetext{\unvbox\FNH@notes}%
+    \endgroup
+   \fi
+  \fi
+}%
+\def\FNH@footnote@envname    {footnote}%
+\def\FNH@footnotetext@envname{footnotetext}%
+\def\FNH@footnote{%
+% this line added for Sphinx:
+    \spx@opt@BeforeFootnote
+    \ifx\@currenvir\FNH@footnote@envname
+        \expandafter\FNH@footnoteenv
+    \else
+        \expandafter\FNH@latex@footnote
+    \fi
+}%
+\def\FNH@footnoteenv{%
+% this line added for Sphinx (footnotes in parsed literal blocks):
+    \catcode13=5 \sphinxunactivateextrasandspace
+    \@ifnextchar[%
+      \FNH@footnoteenv@i %]
+      {\stepcounter\@mpfn
+       \protected@xdef\@thefnmark{\thempfn}%
+       \@footnotemark
+       \def\FNH@endfntext@fntext{\@footnotetext}%
+       \FNH@startfntext}%
+}%
+\def\FNH@footnoteenv@i[#1]{%
+    \begingroup
+     \csname c@\@mpfn\endcsname #1\relax
+     \unrestored@protected@xdef\@thefnmark{\thempfn}%
+    \endgroup
+    \@footnotemark
+    \def\FNH@endfntext@fntext{\@footnotetext}%
+    \FNH@startfntext
+}%
+\def\FNH@footnotetext{%
+    \ifx\@currenvir\FNH@footnotetext@envname
+        \expandafter\FNH@footnotetextenv
+    \else
+        \expandafter\FNH@latex@footnotetext
+    \fi
+}%
+\def\FNH@footnotetextenv{%
+    \@ifnextchar[%
+      \FNH@footnotetextenv@i %]
+      {\protected@xdef\@thefnmark{\thempfn}%
+       \def\FNH@endfntext@fntext{\@footnotetext}%
+       \FNH@startfntext}%
+}%
+\def\FNH@footnotetextenv@i[#1]{%
+    \begingroup
+     \csname c@\@mpfn\endcsname #1\relax
+     \unrestored@protected@xdef\@thefnmark{\thempfn}%
+    \endgroup
+    \ifFNH@savingnotes
+      \def\FNH@endfntext@fntext{\FNH@nohyp@fntext}%
+    \else
+      \def\FNH@endfntext@fntext{\FNH@H@@footnotetext}%
+    \fi
+    \FNH@startfntext
+}%
+\def\FNH@startfntext{%
+  \setbox\z@\vbox\bgroup
+    \FNH@startnote
+    \FNH@prefntext
+    \rule\z@\footnotesep\ignorespaces
+}%
+\def\FNH@endfntext {%
+    \@finalstrut\strutbox
+    \FNH@postfntext
+    \FNH@endnote
+    \egroup
+  \begingroup
+    \let\@makefntext\@empty\let\@finalstrut\@gobble\let\rule\@gobbletwo
+    \FNH@endfntext@fntext {\unvbox\z@}%
+  \endgroup
+}%
+\AtBeginDocument{%
+   \let\FNH@@makefntext\@makefntext
+   \ifx\@makefntextFB\@undefined
+   \expandafter\@gobble\else\expandafter\@firstofone\fi
+   {\ifFBFrenchFootnotes \let\FNH@@makefntext\@makefntextFB \else
+                         \let\FNH@@makefntext\@makefntextORI\fi}%
+   \expandafter\FNH@check@a\FNH@@makefntext{1.2!3?4,}%
+               \FNH@@@1.2!3?4,\FNH@@@\relax
+}%
+\long\def\FNH@check@a #11.2!3?4,#2\FNH@@@#3{%
+    \ifx\relax#3\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi
+    \FNH@bad@makefntext@alert
+    {\def\FNH@prefntext{#1}\def\FNH@postfntext{#2}\FNH@check@b}%
+}%
+\def\FNH@check@b #1\relax{%
+    \expandafter\expandafter\expandafter\FNH@check@c
+    \expandafter\meaning\expandafter\FNH@prefntext
+    \meaning\FNH@postfntext1.2!3?4,\FNH@check@c\relax
+}%
+\def\FNH@check@c #11.2!3?4,#2#3\relax{%
+    \ifx\FNH@check@c#2\expandafter\@gobble\fi\FNH@bad@makefntext@alert
+}%
+% slight reformulation for Sphinx
+\def\FNH@bad@makefntext@alert{%
+  \PackageWarningNoLine{footnotehyper-sphinx}%
+    {Footnotes will be sub-optimal, sorry. This is due to the document class or^^J
+  some package modifying macro \string\@makefntext.^^J
+  You can try to report this incompatibility at^^J
+  https://github.com/sphinx-doc/sphinx with this info:}%
+    \typeout{\meaning\@makefntext}%
+    \let\FNH@prefntext\@empty\let\FNH@postfntext\@empty
+}%
+% this macro from original footnote.sty is not used anymore by Sphinx
+% but for simplicity sake let's just keep it as is
+\def\makesavenoteenv{\@ifnextchar[\FNH@msne@ii\FNH@msne@i}%]
+\def\FNH@msne@i #1{%
+  \expandafter\let\csname FNH$#1\expandafter\endcsname %$
+                  \csname #1\endcsname
+  \expandafter\let\csname endFNH$#1\expandafter\endcsname %$
+                  \csname end#1\endcsname
+  \FNH@msne@ii[#1]{FNH$#1}%$
+}%
+\def\FNH@msne@ii[#1]#2{%
+  \expandafter\edef\csname#1\endcsname{%
+    \noexpand\savenotes
+    \expandafter\noexpand\csname#2\endcsname
+  }%
+  \expandafter\edef\csname end#1\endcsname{%
+    \expandafter\noexpand\csname end#2\endcsname
+    \noexpand\expandafter
+    \noexpand\spewnotes
+    \noexpand\if@endpe\noexpand\@endpetrue\noexpand\fi
+  }%
+}%
+% end of footnotehyper 2017/02/16 v0.99
+% some extras for Sphinx :
+% \sphinxfootnotemark: usable in section titles and silently removed from TOCs.
+\def\sphinxfootnotemark [#1]%
+   {\ifx\thepage\relax\else\protect\spx@opt@BeforeFootnote
+                             \protect\footnotemark[#1]\fi}%
+\AtBeginDocument{%
+   % let hyperref less complain
+   \pdfstringdefDisableCommands{\def\sphinxfootnotemark [#1]{}}%
+   % to obtain hyperlinked footnotes in longtable environment we must replace
+   % hyperref's patch of longtable's patch of \@footnotetext by our own
+   \let\LT@p@ftntext\FNH@hyper@fntext
+   % this *requires* longtable to be used always wrapped in savenotes environment
+}%
+\endinput
+%%
+%% End of file `footnotehyper-sphinx.sty'.
diff --git a/doc/build/latex/latexmkjarc b/doc/build/latex/latexmkjarc
new file mode 100644
index 0000000..39ea47f
--- /dev/null
+++ b/doc/build/latex/latexmkjarc
@@ -0,0 +1,7 @@
+$latex = 'platex ' . $ENV{'LATEXOPTS'} . ' -kanji=utf8 %O %S';
+$dvipdf = 'dvipdfmx %O -o %D %S';
+$makeindex = 'rm -f %D; mendex -U -f -d %B.dic -s python.ist %S || echo "mendex exited with error code $? (ignoring)" && : >> %D';
+add_cus_dep( "glo", "gls", 0, "makeglo" );
+sub makeglo {
+ return system( "mendex -J -f -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
+}
diff --git a/doc/build/latex/latexmkrc b/doc/build/latex/latexmkrc
new file mode 100644
index 0000000..bba17fa
--- /dev/null
+++ b/doc/build/latex/latexmkrc
@@ -0,0 +1,9 @@
+$latex = 'latex ' . $ENV{'LATEXOPTS'} . ' %O %S';
+$pdflatex = 'pdflatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
+$lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
+$xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
+$makeindex = 'makeindex -s python.ist %O -o %D %S';
+add_cus_dep( "glo", "gls", 0, "makeglo" );
+sub makeglo {
+ return system( "makeindex -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
+}
\ No newline at end of file
diff --git a/doc/build/latex/python.ist b/doc/build/latex/python.ist
new file mode 100644
index 0000000..687d26c
--- /dev/null
+++ b/doc/build/latex/python.ist
@@ -0,0 +1,13 @@
+line_max 100
+headings_flag 1
+heading_prefix "  \\bigletter "
+
+preamble "\\begin{sphinxtheindex}
+\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}}
+
+"
+
+postamble "\n\n\\end{sphinxtheindex}\n"
+
+symhead_positive "{Symbols}"
+numhead_positive "{Numbers}"
diff --git a/doc/build/latex/salomeTools.aux b/doc/build/latex/salomeTools.aux
new file mode 100644
index 0000000..c26caf0
--- /dev/null
+++ b/doc/build/latex/salomeTools.aux
@@ -0,0 +1,1296 @@
+\relax 
+\providecommand\hyper@newdestlabel[2]{}
+\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
+\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
+\global\let\oldcontentsline\contentsline
+\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
+\global\let\oldnewlabel\newlabel
+\gdef\newlabel#1#2{\newlabelxx{#1}#2}
+\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
+\AtEndDocument{\ifx\hyper@anchor\@undefined
+\let\contentsline\oldcontentsline
+\let\newlabel\oldnewlabel
+\fi}
+\fi}
+\global\let\hyper@last\relax 
+\gdef\HyperFirstAtBeginDocument#1{#1}
+\providecommand\HyField@AuxAddToFields[1]{}
+\providecommand\HyField@AuxAddToCoFields[2]{}
+\babel@aux{english}{}
+\newlabel{index::doc}{{}{1}{}{section*.2}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:quick-start}{{1}{3}{Quick start}{chapter.1}{}}
+\newlabel{index:salome-tools}{{1}{3}{Quick start}{chapter.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}}
+\newlabel{installation_of_sat:installation}{{1.1}{3}{Installation}{section.1.1}{}}
+\newlabel{installation_of_sat::doc}{{1.1}{3}{Installation}{section.1.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}}
+\newlabel{configuration:configuration}{{1.2}{3}{Configuration}{section.1.2}{}}
+\newlabel{configuration::doc}{{1.2}{3}{Configuration}{section.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}}
+\newlabel{configuration:syntax}{{1.2.1}{3}{Syntax}{subsection.1.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}}
+\newlabel{configuration:description}{{1.2.2}{3}{Description}{subsection.1.2.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}}
+\newlabel{configuration:vars-section}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}}
+\newlabel{configuration:id1}{{1.2.2}{3}{VARS section}{subsubsection*.3}{}}
+\@writefile{toc}{\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}}
+\newlabel{configuration:products-section}{{1.2.2}{4}{PRODUCTS section}{subsubsection*.4}{}}
+\@writefile{toc}{\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}}
+\newlabel{configuration:application-section}{{1.2.2}{4}{APPLICATION section}{subsubsection*.5}{}}
+\@writefile{toc}{\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}}
+\newlabel{configuration:user-section}{{1.2.2}{4}{USER section}{subsubsection*.6}{}}
+\newlabel{configuration:id2}{{1.2.2}{4}{USER section}{subsubsection*.6}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{5}{section.1.3}}
+\newlabel{usage_of_sat:svn}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}}
+\newlabel{usage_of_sat:usage-of-salometools}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}}
+\newlabel{usage_of_sat::doc}{{1.3}{5}{Usage of SAlomeTools}{section.1.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Usage}{5}{subsection.1.3.1}}
+\newlabel{usage_of_sat:usage}{{1.3.1}{5}{Usage}{subsection.1.3.1}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Options of sat}{5}{subsubsection*.7}}
+\newlabel{usage_of_sat:options-of-sat}{{1.3.1}{5}{Options of sat}{subsubsection*.7}{}}
+\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}help or -h}}{5}{paragraph*.8}}
+\newlabel{usage_of_sat:help-or-h}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}help or -h}}{paragraph*.8}{}}
+\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}debug or -g}}{5}{paragraph*.9}}
+\newlabel{usage_of_sat:debug-or-g}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}debug or -g}}{paragraph*.9}{}}
+\@writefile{toc}{\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{5}{paragraph*.10}}
+\newlabel{usage_of_sat:verbose-or-v}{{1.3.1}{5}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{paragraph*.10}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}}
+\newlabel{usage_of_sat:build-a-salome-product}{{1.3.2}{5}{Build a SALOME product}{subsection.1.3.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}}
+\newlabel{usage_of_sat:get-the-list-of-available-products}{{1.3.2}{5}{Get the list of available products}{subsubsection*.11}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}}
+\newlabel{usage_of_sat:prepare-sources-of-a-product}{{1.3.2}{5}{Prepare sources of a product}{subsubsection*.12}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Compile SALOME}{6}{subsubsection*.13}}
+\newlabel{usage_of_sat:compile-salome}{{1.3.2}{6}{Compile SALOME}{subsubsection*.13}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:list-of-commands}{{2}{7}{List of Commands}{chapter.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.1}Command config}{8}{section.2.1}}
+\newlabel{commands/config:svn}{{2.1}{8}{Command config}{section.2.1}{}}
+\newlabel{commands/config:command-config}{{2.1}{8}{Command config}{section.2.1}{}}
+\newlabel{commands/config::doc}{{2.1}{8}{Command config}{section.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1}}
+\newlabel{commands/config:description}{{2.1.1}{8}{Description}{subsection.2.1.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Usage}{8}{subsection.2.1.2}}
+\newlabel{commands/config:usage}{{2.1.2}{8}{Usage}{subsection.2.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{9}{subsection.2.1.3}}
+\newlabel{commands/config:some-useful-configuration-pathes}{{2.1.3}{9}{Some useful configuration pathes}{subsection.2.1.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.2}Command prepare}{10}{section.2.2}}
+\newlabel{commands/prepare:svn}{{2.2}{10}{Command prepare}{section.2.2}{}}
+\newlabel{commands/prepare:command-prepare}{{2.2}{10}{Command prepare}{section.2.2}{}}
+\newlabel{commands/prepare::doc}{{2.2}{10}{Command prepare}{section.2.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description}{10}{subsection.2.2.1}}
+\newlabel{commands/prepare:description}{{2.2.1}{10}{Description}{subsection.2.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.2}Remarks}{10}{subsection.2.2.2}}
+\newlabel{commands/prepare:remarks}{{2.2.2}{10}{Remarks}{subsection.2.2.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{10}{subsubsection*.14}}
+\newlabel{commands/prepare:vcs-bases-git-svn-cvs}{{2.2.2}{10}{VCS bases (git, svn, cvs)}{subsubsection*.14}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Dev mode}{10}{subsubsection*.15}}
+\newlabel{commands/prepare:dev-mode}{{2.2.2}{10}{Dev mode}{subsubsection*.15}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.3}Usage}{10}{subsection.2.2.3}}
+\newlabel{commands/prepare:usage}{{2.2.3}{10}{Usage}{subsection.2.2.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{11}{subsection.2.2.4}}
+\newlabel{commands/prepare:some-useful-configuration-pathes}{{2.2.4}{11}{Some useful configuration pathes}{subsection.2.2.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.3}Command compile}{12}{section.2.3}}
+\newlabel{commands/compile:svn}{{2.3}{12}{Command compile}{section.2.3}{}}
+\newlabel{commands/compile:command-compile}{{2.3}{12}{Command compile}{section.2.3}{}}
+\newlabel{commands/compile::doc}{{2.3}{12}{Command compile}{section.2.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description}{12}{subsection.2.3.1}}
+\newlabel{commands/compile:description}{{2.3.1}{12}{Description}{subsection.2.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Usage}{12}{subsection.2.3.2}}
+\newlabel{commands/compile:usage}{{2.3.2}{12}{Usage}{subsection.2.3.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{13}{subsection.2.3.3}}
+\newlabel{commands/compile:some-useful-configuration-pathes}{{2.3.3}{13}{Some useful configuration pathes}{subsection.2.3.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.4}Command launcher}{14}{section.2.4}}
+\newlabel{commands/launcher:svn}{{2.4}{14}{Command launcher}{section.2.4}{}}
+\newlabel{commands/launcher:command-launcher}{{2.4}{14}{Command launcher}{section.2.4}{}}
+\newlabel{commands/launcher::doc}{{2.4}{14}{Command launcher}{section.2.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description}{14}{subsection.2.4.1}}
+\newlabel{commands/launcher:description}{{2.4.1}{14}{Description}{subsection.2.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Usage}{14}{subsection.2.4.2}}
+\newlabel{commands/launcher:usage}{{2.4.2}{14}{Usage}{subsection.2.4.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.3}Configuration}{14}{subsection.2.4.3}}
+\newlabel{commands/launcher:configuration}{{2.4.3}{14}{Configuration}{subsection.2.4.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.5}Command application}{15}{section.2.5}}
+\newlabel{commands/application:svn}{{2.5}{15}{Command application}{section.2.5}{}}
+\newlabel{commands/application::doc}{{2.5}{15}{Command application}{section.2.5}{}}
+\newlabel{commands/application:command-application}{{2.5}{15}{Command application}{section.2.5}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Description}{15}{subsection.2.5.1}}
+\newlabel{commands/application:description}{{2.5.1}{15}{Description}{subsection.2.5.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.2}Usage}{15}{subsection.2.5.2}}
+\newlabel{commands/application:usage}{{2.5.2}{15}{Usage}{subsection.2.5.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{15}{subsection.2.5.3}}
+\newlabel{commands/application:some-useful-configuration-pathes}{{2.5.3}{15}{Some useful configuration pathes}{subsection.2.5.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.6}Command log}{16}{section.2.6}}
+\newlabel{commands/log:svn}{{2.6}{16}{Command log}{section.2.6}{}}
+\newlabel{commands/log:command-log}{{2.6}{16}{Command log}{section.2.6}{}}
+\newlabel{commands/log::doc}{{2.6}{16}{Command log}{section.2.6}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.1}Description}{16}{subsection.2.6.1}}
+\newlabel{commands/log:description}{{2.6.1}{16}{Description}{subsection.2.6.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.2}Usage}{16}{subsection.2.6.2}}
+\newlabel{commands/log:usage}{{2.6.2}{16}{Usage}{subsection.2.6.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{16}{subsection.2.6.3}}
+\newlabel{commands/log:some-useful-configuration-pathes}{{2.6.3}{16}{Some useful configuration pathes}{subsection.2.6.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.7}Command environ}{17}{section.2.7}}
+\newlabel{commands/environ:svn}{{2.7}{17}{Command environ}{section.2.7}{}}
+\newlabel{commands/environ:command-environ}{{2.7}{17}{Command environ}{section.2.7}{}}
+\newlabel{commands/environ::doc}{{2.7}{17}{Command environ}{section.2.7}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.1}Description}{17}{subsection.2.7.1}}
+\newlabel{commands/environ:description}{{2.7.1}{17}{Description}{subsection.2.7.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.2}Usage}{17}{subsection.2.7.2}}
+\newlabel{commands/environ:usage}{{2.7.2}{17}{Usage}{subsection.2.7.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.7.3}Configuration}{17}{subsection.2.7.3}}
+\newlabel{commands/environ:configuration}{{2.7.3}{17}{Configuration}{subsection.2.7.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.8}Command clean}{20}{section.2.8}}
+\newlabel{commands/clean:svn}{{2.8}{20}{Command clean}{section.2.8}{}}
+\newlabel{commands/clean:command-clean}{{2.8}{20}{Command clean}{section.2.8}{}}
+\newlabel{commands/clean::doc}{{2.8}{20}{Command clean}{section.2.8}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.1}Description}{20}{subsection.2.8.1}}
+\newlabel{commands/clean:description}{{2.8.1}{20}{Description}{subsection.2.8.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.2}Usage}{20}{subsection.2.8.2}}
+\newlabel{commands/clean:usage}{{2.8.2}{20}{Usage}{subsection.2.8.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.3}Availables options}{20}{subsection.2.8.3}}
+\newlabel{commands/clean:availables-options}{{2.8.3}{20}{Availables options}{subsection.2.8.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{20}{subsection.2.8.4}}
+\newlabel{commands/clean:some-useful-configuration-pathes}{{2.8.4}{20}{Some useful configuration pathes}{subsection.2.8.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.9}Command package}{21}{section.2.9}}
+\newlabel{commands/package:svn}{{2.9}{21}{Command package}{section.2.9}{}}
+\newlabel{commands/package:command-package}{{2.9}{21}{Command package}{section.2.9}{}}
+\newlabel{commands/package::doc}{{2.9}{21}{Command package}{section.2.9}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.1}Description}{21}{subsection.2.9.1}}
+\newlabel{commands/package:description}{{2.9.1}{21}{Description}{subsection.2.9.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.2}Usage}{21}{subsection.2.9.2}}
+\newlabel{commands/package:usage}{{2.9.2}{21}{Usage}{subsection.2.9.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{22}{subsection.2.9.3}}
+\newlabel{commands/package:some-useful-configuration-pathes}{{2.9.3}{22}{Some useful configuration pathes}{subsection.2.9.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.10}Command generate}{23}{section.2.10}}
+\newlabel{commands/generate:svn}{{2.10}{23}{Command generate}{section.2.10}{}}
+\newlabel{commands/generate:command-generate}{{2.10}{23}{Command generate}{section.2.10}{}}
+\newlabel{commands/generate::doc}{{2.10}{23}{Command generate}{section.2.10}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.1}Description}{23}{subsection.2.10.1}}
+\newlabel{commands/generate:description}{{2.10.1}{23}{Description}{subsection.2.10.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.2}Remarks}{23}{subsection.2.10.2}}
+\newlabel{commands/generate:remarks}{{2.10.2}{23}{Remarks}{subsection.2.10.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.10.3}Usage}{23}{subsection.2.10.3}}
+\newlabel{commands/generate:usage}{{2.10.3}{23}{Usage}{subsection.2.10.3}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:developer-documentation}{{3}{25}{Developer documentation}{chapter.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {3.1}Add a user custom command}{26}{section.3.1}}
+\newlabel{write_command:svn}{{3.1}{26}{Add a user custom command}{section.3.1}{}}
+\newlabel{write_command:add-a-user-custom-command}{{3.1}{26}{Add a user custom command}{section.3.1}{}}
+\newlabel{write_command::doc}{{3.1}{26}{Add a user custom command}{section.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}Introduction}{26}{subsection.3.1.1}}
+\newlabel{write_command:introduction}{{3.1.1}{26}{Introduction}{subsection.3.1.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{26}{subsection.3.1.2}}
+\newlabel{write_command:basic-requirements}{{3.1.2}{26}{Basic requirements}{subsection.3.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{27}{subsection.3.1.3}}
+\newlabel{write_command:howto-access-salometools-config-and-other-commands}{{3.1.3}{27}{HowTo access salomeTools config and other commands}{subsection.3.1.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{27}{subsection.3.1.4}}
+\newlabel{write_command:howto-logger}{{3.1.4}{27}{HowTo logger}{subsection.3.1.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.5}HELLO example}{27}{subsection.3.1.5}}
+\newlabel{write_command:hello-example}{{3.1.5}{27}{HELLO example}{subsection.3.1.5}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {4}Code documentation}{29}{chapter.4}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:code-documentation}{{4}{29}{Code documentation}{chapter.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {4.1}src}{29}{section.4.1}}
+\newlabel{apidoc_src/modules:src}{{4.1}{29}{src}{section.4.1}{}}
+\newlabel{apidoc_src/modules::doc}{{4.1}{29}{src}{section.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}src package}{29}{subsection.4.1.1}}
+\newlabel{apidoc_src/src::doc}{{4.1.1}{29}{src package}{subsection.4.1.1}{}}
+\newlabel{apidoc_src/src:src-package}{{4.1.1}{29}{src package}{subsection.4.1.1}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Subpackages}{29}{subsubsection*.16}}
+\newlabel{apidoc_src/src:subpackages}{{4.1.1}{29}{Subpackages}{subsubsection*.16}{}}
+\@writefile{toc}{\contentsline {paragraph}{src.colorama package}{29}{paragraph*.17}}
+\newlabel{apidoc_src/src.colorama:src-colorama-package}{{4.1.1}{29}{src.colorama package}{paragraph*.17}{}}
+\newlabel{apidoc_src/src.colorama::doc}{{4.1.1}{29}{src.colorama package}{paragraph*.17}{}}
+\@writefile{toc}{\contentsline {subparagraph}{Submodules}{29}{subparagraph*.18}}
+\newlabel{apidoc_src/src.colorama:submodules}{{4.1.1}{29}{Submodules}{subparagraph*.18}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.ansi module}{29}{subparagraph*.19}}
+\newlabel{apidoc_src/src.colorama:module-src.colorama.ansi}{{4.1.1}{29}{src.colorama.ansi module}{subparagraph*.19}{}}
+\newlabel{apidoc_src/src.colorama:src-colorama-ansi-module}{{4.1.1}{29}{src.colorama.ansi module}{subparagraph*.19}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack}{{4.1.1}{29}{src.colorama.ansi module}{section*.20}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.BLACK}{{4.1.1}{29}{src.colorama.ansi module}{section*.21}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.BLUE}{{4.1.1}{29}{src.colorama.ansi module}{section*.22}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.CYAN}{{4.1.1}{29}{src.colorama.ansi module}{section*.23}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.GREEN}{{4.1.1}{29}{src.colorama.ansi module}{section*.24}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.25}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.26}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.27}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.28}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.29}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.30}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.31}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}{{4.1.1}{29}{src.colorama.ansi module}{section*.32}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}{{4.1.1}{29}{src.colorama.ansi module}{section*.33}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.RED}{{4.1.1}{29}{src.colorama.ansi module}{section*.34}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.RESET}{{4.1.1}{29}{src.colorama.ansi module}{section*.35}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.WHITE}{{4.1.1}{29}{src.colorama.ansi module}{section*.36}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}{{4.1.1}{29}{src.colorama.ansi module}{section*.37}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}{{4.1.1}{29}{src.colorama.ansi module}{section*.38}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor}{{4.1.1}{30}{src.colorama.ansi module}{section*.39}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.BACK}{{4.1.1}{30}{src.colorama.ansi module}{section*.40}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}{{4.1.1}{30}{src.colorama.ansi module}{section*.41}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}{{4.1.1}{30}{src.colorama.ansi module}{section*.42}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.POS}{{4.1.1}{30}{src.colorama.ansi module}{section*.43}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.UP}{{4.1.1}{30}{src.colorama.ansi module}{section*.44}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore}{{4.1.1}{30}{src.colorama.ansi module}{section*.45}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.BLACK}{{4.1.1}{30}{src.colorama.ansi module}{section*.46}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.BLUE}{{4.1.1}{30}{src.colorama.ansi module}{section*.47}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.CYAN}{{4.1.1}{30}{src.colorama.ansi module}{section*.48}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.GREEN}{{4.1.1}{30}{src.colorama.ansi module}{section*.49}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.50}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.51}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.52}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.53}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.54}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.55}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.56}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}{{4.1.1}{30}{src.colorama.ansi module}{section*.57}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}{{4.1.1}{30}{src.colorama.ansi module}{section*.58}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.RED}{{4.1.1}{30}{src.colorama.ansi module}{section*.59}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.RESET}{{4.1.1}{30}{src.colorama.ansi module}{section*.60}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.WHITE}{{4.1.1}{30}{src.colorama.ansi module}{section*.61}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}{{4.1.1}{30}{src.colorama.ansi module}{section*.62}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle}{{4.1.1}{30}{src.colorama.ansi module}{section*.63}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}{{4.1.1}{30}{src.colorama.ansi module}{section*.64}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.DIM}{{4.1.1}{30}{src.colorama.ansi module}{section*.65}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}{{4.1.1}{30}{src.colorama.ansi module}{section*.66}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}{{4.1.1}{30}{src.colorama.ansi module}{section*.67}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.clear_line}{{4.1.1}{30}{src.colorama.ansi module}{section*.68}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.clear_screen}{{4.1.1}{30}{src.colorama.ansi module}{section*.69}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.code_to_chars}{{4.1.1}{30}{src.colorama.ansi module}{section*.70}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansi.set_title}{{4.1.1}{30}{src.colorama.ansi module}{section*.71}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.ansitowin32 module}{31}{subparagraph*.72}}
+\newlabel{apidoc_src/src.colorama:module-src.colorama.ansitowin32}{{4.1.1}{31}{src.colorama.ansitowin32 module}{subparagraph*.72}{}}
+\newlabel{apidoc_src/src.colorama:src-colorama-ansitowin32-module}{{4.1.1}{31}{src.colorama.ansitowin32 module}{subparagraph*.72}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.73}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.74}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.75}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.76}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.77}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.78}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.79}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.80}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.81}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.82}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.83}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.84}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.85}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.StreamWrapper}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.86}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.87}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.is_a_tty}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.88}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.ansitowin32.is_stream_closed}{{4.1.1}{31}{src.colorama.ansitowin32 module}{section*.89}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.initialise module}{31}{subparagraph*.90}}
+\newlabel{apidoc_src/src.colorama:src-colorama-initialise-module}{{4.1.1}{31}{src.colorama.initialise module}{subparagraph*.90}{}}
+\newlabel{apidoc_src/src.colorama:module-src.colorama.initialise}{{4.1.1}{31}{src.colorama.initialise module}{subparagraph*.90}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.initialise.colorama_text}{{4.1.1}{31}{src.colorama.initialise module}{section*.91}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.initialise.deinit}{{4.1.1}{31}{src.colorama.initialise module}{section*.92}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.initialise.init}{{4.1.1}{31}{src.colorama.initialise module}{section*.93}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.initialise.reinit}{{4.1.1}{31}{src.colorama.initialise module}{section*.94}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.initialise.reset_all}{{4.1.1}{31}{src.colorama.initialise module}{section*.95}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.initialise.wrap_stream}{{4.1.1}{31}{src.colorama.initialise module}{section*.96}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.win32 module}{32}{subparagraph*.97}}
+\newlabel{apidoc_src/src.colorama:src-colorama-win32-module}{{4.1.1}{32}{src.colorama.win32 module}{subparagraph*.97}{}}
+\newlabel{apidoc_src/src.colorama:module-src.colorama.win32}{{4.1.1}{32}{src.colorama.win32 module}{subparagraph*.97}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.win32.SetConsoleTextAttribute}{{4.1.1}{32}{src.colorama.win32 module}{section*.98}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.win32.winapi_test}{{4.1.1}{32}{src.colorama.win32 module}{section*.99}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.colorama.winterm module}{32}{subparagraph*.100}}
+\newlabel{apidoc_src/src.colorama:module-src.colorama.winterm}{{4.1.1}{32}{src.colorama.winterm module}{subparagraph*.100}{}}
+\newlabel{apidoc_src/src.colorama:src-colorama-winterm-module}{{4.1.1}{32}{src.colorama.winterm module}{subparagraph*.100}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor}{{4.1.1}{32}{src.colorama.winterm module}{section*.101}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.BLACK}{{4.1.1}{32}{src.colorama.winterm module}{section*.102}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.BLUE}{{4.1.1}{32}{src.colorama.winterm module}{section*.103}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.CYAN}{{4.1.1}{32}{src.colorama.winterm module}{section*.104}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.GREEN}{{4.1.1}{32}{src.colorama.winterm module}{section*.105}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.GREY}{{4.1.1}{32}{src.colorama.winterm module}{section*.106}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.MAGENTA}{{4.1.1}{32}{src.colorama.winterm module}{section*.107}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.RED}{{4.1.1}{32}{src.colorama.winterm module}{section*.108}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinColor.YELLOW}{{4.1.1}{32}{src.colorama.winterm module}{section*.109}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinStyle}{{4.1.1}{32}{src.colorama.winterm module}{section*.110}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}{{4.1.1}{32}{src.colorama.winterm module}{section*.111}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}{{4.1.1}{32}{src.colorama.winterm module}{section*.112}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinStyle.NORMAL}{{4.1.1}{32}{src.colorama.winterm module}{section*.113}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm}{{4.1.1}{32}{src.colorama.winterm module}{section*.114}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.back}{{4.1.1}{32}{src.colorama.winterm module}{section*.115}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}{{4.1.1}{32}{src.colorama.winterm module}{section*.116}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.erase_line}{{4.1.1}{32}{src.colorama.winterm module}{section*.117}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.erase_screen}{{4.1.1}{32}{src.colorama.winterm module}{section*.118}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.fore}{{4.1.1}{32}{src.colorama.winterm module}{section*.119}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.get_attrs}{{4.1.1}{32}{src.colorama.winterm module}{section*.120}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.get_position}{{4.1.1}{32}{src.colorama.winterm module}{section*.121}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.reset_all}{{4.1.1}{32}{src.colorama.winterm module}{section*.122}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_attrs}{{4.1.1}{32}{src.colorama.winterm module}{section*.123}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_console}{{4.1.1}{32}{src.colorama.winterm module}{section*.124}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}{{4.1.1}{32}{src.colorama.winterm module}{section*.125}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_title}{{4.1.1}{32}{src.colorama.winterm module}{section*.126}{}}
+\newlabel{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.style}{{4.1.1}{32}{src.colorama.winterm module}{section*.127}{}}
+\@writefile{toc}{\contentsline {subparagraph}{Module contents}{33}{subparagraph*.128}}
+\newlabel{apidoc_src/src.colorama:module-src.colorama}{{4.1.1}{33}{Module contents}{subparagraph*.128}{}}
+\newlabel{apidoc_src/src.colorama:module-contents}{{4.1.1}{33}{Module contents}{subparagraph*.128}{}}
+\@writefile{toc}{\contentsline {paragraph}{src.example package}{33}{paragraph*.129}}
+\newlabel{apidoc_src/src.example:src-example-package}{{4.1.1}{33}{src.example package}{paragraph*.129}{}}
+\newlabel{apidoc_src/src.example::doc}{{4.1.1}{33}{src.example package}{paragraph*.129}{}}
+\@writefile{toc}{\contentsline {subparagraph}{Submodules}{33}{subparagraph*.130}}
+\newlabel{apidoc_src/src.example:submodules}{{4.1.1}{33}{Submodules}{subparagraph*.130}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.example.essai\_logging\_1 module}{33}{subparagraph*.131}}
+\newlabel{apidoc_src/src.example:module-src.example.essai_logging_1}{{4.1.1}{33}{src.example.essai\_logging\_1 module}{subparagraph*.131}{}}
+\newlabel{apidoc_src/src.example:src-example-essai-logging-1-module}{{4.1.1}{33}{src.example.essai\_logging\_1 module}{subparagraph*.131}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_1.getMyLogger}{{4.1.1}{33}{src.example.essai\_logging\_1 module}{section*.132}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_1.initMyLogger}{{4.1.1}{33}{src.example.essai\_logging\_1 module}{section*.133}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_1.testLogger1}{{4.1.1}{33}{src.example.essai\_logging\_1 module}{section*.134}{}}
+\@writefile{toc}{\contentsline {subparagraph}{src.example.essai\_logging\_2 module}{33}{subparagraph*.135}}
+\newlabel{apidoc_src/src.example:module-src.example.essai_logging_2}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{subparagraph*.135}{}}
+\newlabel{apidoc_src/src.example:src-example-essai-logging-2-module}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{subparagraph*.135}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_2.MyFormatter}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{section*.136}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_2.MyFormatter.format}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{section*.137}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_2.getMyLogger}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{section*.138}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_2.initMyLogger}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{section*.139}{}}
+\newlabel{apidoc_src/src.example:src.example.essai_logging_2.testLogger1}{{4.1.1}{33}{src.example.essai\_logging\_2 module}{section*.140}{}}
+\@writefile{toc}{\contentsline {subparagraph}{Module contents}{34}{subparagraph*.141}}
+\newlabel{apidoc_src/src.example:module-contents}{{4.1.1}{34}{Module contents}{subparagraph*.141}{}}
+\newlabel{apidoc_src/src.example:module-src.example}{{4.1.1}{34}{Module contents}{subparagraph*.141}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Submodules}{34}{subsubsection*.142}}
+\newlabel{apidoc_src/src:submodules}{{4.1.1}{34}{Submodules}{subsubsection*.142}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.ElementTree module}{34}{subsubsection*.143}}
+\newlabel{apidoc_src/src:src-elementtree-module}{{4.1.1}{34}{src.ElementTree module}{subsubsection*.143}{}}
+\newlabel{apidoc_src/src:module-src.ElementTree}{{4.1.1}{34}{src.ElementTree module}{subsubsection*.143}{}}
+\newlabel{apidoc_src/src:src.ElementTree.Comment}{{4.1.1}{34}{src.ElementTree module}{section*.144}{}}
+\newlabel{apidoc_src/src:src.ElementTree.dump}{{4.1.1}{34}{src.ElementTree module}{section*.145}{}}
+\newlabel{apidoc_src/src:src.ElementTree.Element}{{4.1.1}{34}{src.ElementTree module}{section*.146}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree}{{4.1.1}{34}{src.ElementTree module}{section*.147}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.find}{{4.1.1}{34}{src.ElementTree module}{section*.148}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.findall}{{4.1.1}{34}{src.ElementTree module}{section*.149}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.findtext}{{4.1.1}{34}{src.ElementTree module}{section*.150}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.getiterator}{{4.1.1}{34}{src.ElementTree module}{section*.151}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.getroot}{{4.1.1}{34}{src.ElementTree module}{section*.152}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.parse}{{4.1.1}{34}{src.ElementTree module}{section*.153}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ElementTree.write}{{4.1.1}{34}{src.ElementTree module}{section*.154}{}}
+\newlabel{apidoc_src/src:src.ElementTree.fromstring}{{4.1.1}{34}{src.ElementTree module}{section*.155}{}}
+\newlabel{apidoc_src/src:src.ElementTree.iselement}{{4.1.1}{34}{src.ElementTree module}{section*.156}{}}
+\newlabel{apidoc_src/src:src.ElementTree.iterparse}{{4.1.1}{34}{src.ElementTree module}{section*.157}{}}
+\newlabel{apidoc_src/src:src.ElementTree.iterparse.next}{{4.1.1}{34}{src.ElementTree module}{section*.158}{}}
+\newlabel{apidoc_src/src:src.ElementTree.parse}{{4.1.1}{34}{src.ElementTree module}{section*.159}{}}
+\newlabel{apidoc_src/src:src.ElementTree.PI}{{4.1.1}{34}{src.ElementTree module}{section*.160}{}}
+\newlabel{apidoc_src/src:src.ElementTree.ProcessingInstruction}{{4.1.1}{34}{src.ElementTree module}{section*.161}{}}
+\newlabel{apidoc_src/src:src.ElementTree.QName}{{4.1.1}{34}{src.ElementTree module}{section*.162}{}}
+\newlabel{apidoc_src/src:src.ElementTree.SubElement}{{4.1.1}{34}{src.ElementTree module}{section*.163}{}}
+\newlabel{apidoc_src/src:src.ElementTree.tostring}{{4.1.1}{34}{src.ElementTree module}{section*.164}{}}
+\newlabel{apidoc_src/src:src.ElementTree.TreeBuilder}{{4.1.1}{34}{src.ElementTree module}{section*.165}{}}
+\newlabel{apidoc_src/src:src.ElementTree.TreeBuilder.close}{{4.1.1}{34}{src.ElementTree module}{section*.166}{}}
+\newlabel{apidoc_src/src:src.ElementTree.TreeBuilder.data}{{4.1.1}{34}{src.ElementTree module}{section*.167}{}}
+\newlabel{apidoc_src/src:src.ElementTree.TreeBuilder.end}{{4.1.1}{34}{src.ElementTree module}{section*.168}{}}
+\newlabel{apidoc_src/src:src.ElementTree.TreeBuilder.start}{{4.1.1}{34}{src.ElementTree module}{section*.169}{}}
+\newlabel{apidoc_src/src:src.ElementTree.XML}{{4.1.1}{34}{src.ElementTree module}{section*.170}{}}
+\newlabel{apidoc_src/src:src.ElementTree.XMLTreeBuilder}{{4.1.1}{34}{src.ElementTree module}{section*.171}{}}
+\newlabel{apidoc_src/src:src.ElementTree.XMLTreeBuilder.close}{{4.1.1}{34}{src.ElementTree module}{section*.172}{}}
+\newlabel{apidoc_src/src:src.ElementTree.XMLTreeBuilder.doctype}{{4.1.1}{34}{src.ElementTree module}{section*.173}{}}
+\newlabel{apidoc_src/src:src.ElementTree.XMLTreeBuilder.feed}{{4.1.1}{34}{src.ElementTree module}{section*.174}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.architecture module}{35}{subsubsection*.175}}
+\newlabel{apidoc_src/src:module-src.architecture}{{4.1.1}{35}{src.architecture module}{subsubsection*.175}{}}
+\newlabel{apidoc_src/src:src-architecture-module}{{4.1.1}{35}{src.architecture module}{subsubsection*.175}{}}
+\newlabel{apidoc_src/src:src.architecture.get_distrib_version}{{4.1.1}{35}{src.architecture module}{section*.176}{}}
+\newlabel{apidoc_src/src:src.architecture.get_distribution}{{4.1.1}{35}{src.architecture module}{section*.177}{}}
+\newlabel{apidoc_src/src:src.architecture.get_nb_proc}{{4.1.1}{35}{src.architecture module}{section*.178}{}}
+\newlabel{apidoc_src/src:src.architecture.get_python_version}{{4.1.1}{35}{src.architecture module}{section*.179}{}}
+\newlabel{apidoc_src/src:src.architecture.get_user}{{4.1.1}{35}{src.architecture module}{section*.180}{}}
+\newlabel{apidoc_src/src:src.architecture.is_windows}{{4.1.1}{35}{src.architecture module}{section*.181}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.catchAll module}{35}{subsubsection*.182}}
+\newlabel{apidoc_src/src:module-src.catchAll}{{4.1.1}{35}{src.catchAll module}{subsubsection*.182}{}}
+\newlabel{apidoc_src/src:src-catchall-module}{{4.1.1}{35}{src.catchAll module}{subsubsection*.182}{}}
+\newlabel{apidoc_src/src:src.catchAll.CatchAll}{{4.1.1}{35}{src.catchAll module}{section*.183}{}}
+\newlabel{apidoc_src/src:src.catchAll.CatchAll.jsonDumps}{{4.1.1}{35}{src.catchAll module}{section*.184}{}}
+\newlabel{apidoc_src/src:src.catchAll.dumper}{{4.1.1}{35}{src.catchAll module}{section*.185}{}}
+\newlabel{apidoc_src/src:src.catchAll.dumperType}{{4.1.1}{36}{src.catchAll module}{section*.186}{}}
+\newlabel{apidoc_src/src:src.catchAll.jsonDumps}{{4.1.1}{36}{src.catchAll module}{section*.187}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.coloringSat module}{36}{subsubsection*.188}}
+\newlabel{apidoc_src/src:module-src.coloringSat}{{4.1.1}{36}{src.coloringSat module}{subsubsection*.188}{}}
+\newlabel{apidoc_src/src:src-coloringsat-module}{{4.1.1}{36}{src.coloringSat module}{subsubsection*.188}{}}
+\newlabel{apidoc_src/src:src.coloringSat.ColoringStream}{{4.1.1}{36}{src.coloringSat module}{section*.189}{}}
+\newlabel{apidoc_src/src:src.coloringSat.ColoringStream.flush}{{4.1.1}{36}{src.coloringSat module}{section*.190}{}}
+\newlabel{apidoc_src/src:src.coloringSat.ColoringStream.write}{{4.1.1}{36}{src.coloringSat module}{section*.191}{}}
+\newlabel{apidoc_src/src:src.coloringSat.cleanColors}{{4.1.1}{36}{src.coloringSat module}{section*.192}{}}
+\newlabel{apidoc_src/src:src.coloringSat.indent}{{4.1.1}{36}{src.coloringSat module}{section*.193}{}}
+\newlabel{apidoc_src/src:src.coloringSat.log}{{4.1.1}{36}{src.coloringSat module}{section*.194}{}}
+\newlabel{apidoc_src/src:src.coloringSat.replace}{{4.1.1}{36}{src.coloringSat module}{section*.195}{}}
+\newlabel{apidoc_src/src:src.coloringSat.toColor}{{4.1.1}{36}{src.coloringSat module}{section*.196}{}}
+\newlabel{apidoc_src/src:src.coloringSat.toColor_AnsiToWin32}{{4.1.1}{36}{src.coloringSat module}{section*.197}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.compilation module}{36}{subsubsection*.198}}
+\newlabel{apidoc_src/src:module-src.compilation}{{4.1.1}{36}{src.compilation module}{subsubsection*.198}{}}
+\newlabel{apidoc_src/src:src-compilation-module}{{4.1.1}{36}{src.compilation module}{subsubsection*.198}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder}{{4.1.1}{36}{src.compilation module}{section*.199}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.build_configure}{{4.1.1}{36}{src.compilation module}{section*.200}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.check}{{4.1.1}{36}{src.compilation module}{section*.201}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.cmake}{{4.1.1}{36}{src.compilation module}{section*.202}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.complete_environment}{{4.1.1}{36}{src.compilation module}{section*.203}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.configure}{{4.1.1}{36}{src.compilation module}{section*.204}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.do_batch_script_build}{{4.1.1}{36}{src.compilation module}{section*.205}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.do_default_build}{{4.1.1}{36}{src.compilation module}{section*.206}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.do_python_script_build}{{4.1.1}{37}{src.compilation module}{section*.207}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.do_script_build}{{4.1.1}{37}{src.compilation module}{section*.208}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.hack_libtool}{{4.1.1}{37}{src.compilation module}{section*.209}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.install}{{4.1.1}{37}{src.compilation module}{section*.210}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.log}{{4.1.1}{37}{src.compilation module}{section*.211}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.log_command}{{4.1.1}{37}{src.compilation module}{section*.212}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.make}{{4.1.1}{37}{src.compilation module}{section*.213}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.prepare}{{4.1.1}{37}{src.compilation module}{section*.214}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}{{4.1.1}{37}{src.compilation module}{section*.215}{}}
+\newlabel{apidoc_src/src:src.compilation.Builder.wmake}{{4.1.1}{37}{src.compilation module}{section*.216}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.configManager module}{37}{subsubsection*.217}}
+\newlabel{apidoc_src/src:module-src.configManager}{{4.1.1}{37}{src.configManager module}{subsubsection*.217}{}}
+\newlabel{apidoc_src/src:src-configmanager-module}{{4.1.1}{37}{src.configManager module}{subsubsection*.217}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigManager}{{4.1.1}{37}{src.configManager module}{section*.218}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigManager.create_config_file}{{4.1.1}{37}{src.configManager module}{section*.219}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigManager.get_command_line_overrides}{{4.1.1}{37}{src.configManager module}{section*.220}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigManager.get_config}{{4.1.1}{37}{src.configManager module}{section*.221}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigManager.get_user_config_file}{{4.1.1}{37}{src.configManager module}{section*.222}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigManager.set_user_config_file}{{4.1.1}{38}{src.configManager module}{section*.223}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigOpener}{{4.1.1}{38}{src.configManager module}{section*.224}{}}
+\newlabel{apidoc_src/src:src.configManager.ConfigOpener.get_path}{{4.1.1}{38}{src.configManager module}{section*.225}{}}
+\newlabel{apidoc_src/src:src.configManager.check_path}{{4.1.1}{38}{src.configManager module}{section*.226}{}}
+\newlabel{apidoc_src/src:src.configManager.getConfigColored}{{4.1.1}{38}{src.configManager module}{section*.227}{}}
+\newlabel{apidoc_src/src:src.configManager.get_config_children}{{4.1.1}{38}{src.configManager module}{section*.228}{}}
+\newlabel{apidoc_src/src:src.configManager.get_products_list}{{4.1.1}{38}{src.configManager module}{section*.229}{}}
+\newlabel{apidoc_src/src:src.configManager.print_debug}{{4.1.1}{38}{src.configManager module}{section*.230}{}}
+\newlabel{apidoc_src/src:src.configManager.print_value}{{4.1.1}{38}{src.configManager module}{section*.231}{}}
+\newlabel{apidoc_src/src:src.configManager.show_patchs}{{4.1.1}{39}{src.configManager module}{section*.232}{}}
+\newlabel{apidoc_src/src:src.configManager.show_product_info}{{4.1.1}{39}{src.configManager module}{section*.233}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.debug module}{39}{subsubsection*.234}}
+\newlabel{apidoc_src/src:module-src.debug}{{4.1.1}{39}{src.debug module}{subsubsection*.234}{}}
+\newlabel{apidoc_src/src:src-debug-module}{{4.1.1}{39}{src.debug module}{subsubsection*.234}{}}
+\newlabel{apidoc_src/src:src.debug.InStream}{{4.1.1}{39}{src.debug module}{section*.235}{}}
+\newlabel{apidoc_src/src:src.debug.OutStream}{{4.1.1}{39}{src.debug module}{section*.236}{}}
+\newlabel{apidoc_src/src:src.debug.OutStream.close}{{4.1.1}{39}{src.debug module}{section*.237}{}}
+\newlabel{apidoc_src/src:src.debug.format_color_exception}{{4.1.1}{39}{src.debug module}{section*.238}{}}
+\newlabel{apidoc_src/src:src.debug.getLocalEnv}{{4.1.1}{39}{src.debug module}{section*.239}{}}
+\newlabel{apidoc_src/src:src.debug.getStrConfigDbg}{{4.1.1}{39}{src.debug module}{section*.240}{}}
+\newlabel{apidoc_src/src:src.debug.getStrConfigStd}{{4.1.1}{39}{src.debug module}{section*.241}{}}
+\newlabel{apidoc_src/src:src.debug.indent}{{4.1.1}{39}{src.debug module}{section*.242}{}}
+\newlabel{apidoc_src/src:src.debug.isTypeConfig}{{4.1.1}{39}{src.debug module}{section*.243}{}}
+\newlabel{apidoc_src/src:src.debug.pop_debug}{{4.1.1}{39}{src.debug module}{section*.244}{}}
+\newlabel{apidoc_src/src:src.debug.push_debug}{{4.1.1}{40}{src.debug module}{section*.245}{}}
+\newlabel{apidoc_src/src:src.debug.saveConfigDbg}{{4.1.1}{40}{src.debug module}{section*.246}{}}
+\newlabel{apidoc_src/src:src.debug.saveConfigStd}{{4.1.1}{40}{src.debug module}{section*.247}{}}
+\newlabel{apidoc_src/src:src.debug.tofix}{{4.1.1}{40}{src.debug module}{section*.248}{}}
+\newlabel{apidoc_src/src:src.debug.write}{{4.1.1}{40}{src.debug module}{section*.249}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.environment module}{40}{subsubsection*.250}}
+\newlabel{apidoc_src/src:src-environment-module}{{4.1.1}{40}{src.environment module}{subsubsection*.250}{}}
+\newlabel{apidoc_src/src:module-src.environment}{{4.1.1}{40}{src.environment module}{subsubsection*.250}{}}
+\newlabel{apidoc_src/src:src.environment.Environ}{{4.1.1}{40}{src.environment module}{section*.251}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.append}{{4.1.1}{40}{src.environment module}{section*.252}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.append_value}{{4.1.1}{40}{src.environment module}{section*.253}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.command_value}{{4.1.1}{40}{src.environment module}{section*.254}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.get}{{4.1.1}{40}{src.environment module}{section*.255}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.is_defined}{{4.1.1}{40}{src.environment module}{section*.256}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.prepend}{{4.1.1}{40}{src.environment module}{section*.257}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.prepend_value}{{4.1.1}{41}{src.environment module}{section*.258}{}}
+\newlabel{apidoc_src/src:src.environment.Environ.set}{{4.1.1}{41}{src.environment module}{section*.259}{}}
+\newlabel{apidoc_src/src:src.environment.FileEnvWriter}{{4.1.1}{41}{src.environment module}{section*.260}{}}
+\newlabel{apidoc_src/src:src.environment.FileEnvWriter.write_cfgForPy_file}{{4.1.1}{41}{src.environment module}{section*.261}{}}
+\newlabel{apidoc_src/src:src.environment.FileEnvWriter.write_env_file}{{4.1.1}{41}{src.environment module}{section*.262}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron}{{4.1.1}{41}{src.environment module}{section*.263}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.add_comment}{{4.1.1}{41}{src.environment module}{section*.264}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.add_line}{{4.1.1}{41}{src.environment module}{section*.265}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.add_warning}{{4.1.1}{41}{src.environment module}{section*.266}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.append}{{4.1.1}{41}{src.environment module}{section*.267}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.dump}{{4.1.1}{42}{src.environment module}{section*.268}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.finish}{{4.1.1}{42}{src.environment module}{section*.269}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.get}{{4.1.1}{42}{src.environment module}{section*.270}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.get_names}{{4.1.1}{42}{src.environment module}{section*.271}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.is_defined}{{4.1.1}{42}{src.environment module}{section*.272}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.load_cfg_environment}{{4.1.1}{42}{src.environment module}{section*.273}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.prepend}{{4.1.1}{42}{src.environment module}{section*.274}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.run_env_script}{{4.1.1}{42}{src.environment module}{section*.275}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.run_simple_env_script}{{4.1.1}{42}{src.environment module}{section*.276}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set}{{4.1.1}{42}{src.environment module}{section*.277}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_a_product}{{4.1.1}{43}{src.environment module}{section*.278}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_application_env}{{4.1.1}{43}{src.environment module}{section*.279}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_cpp_env}{{4.1.1}{43}{src.environment module}{section*.280}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_full_environ}{{4.1.1}{43}{src.environment module}{section*.281}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_products}{{4.1.1}{43}{src.environment module}{section*.282}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_python_libdirs}{{4.1.1}{43}{src.environment module}{section*.283}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_salome_generic_product_env}{{4.1.1}{43}{src.environment module}{section*.284}{}}
+\newlabel{apidoc_src/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}{{4.1.1}{43}{src.environment module}{section*.285}{}}
+\newlabel{apidoc_src/src:src.environment.Shell}{{4.1.1}{43}{src.environment module}{section*.286}{}}
+\newlabel{apidoc_src/src:src.environment.load_environment}{{4.1.1}{43}{src.environment module}{section*.287}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.environs module}{44}{subsubsection*.288}}
+\newlabel{apidoc_src/src:module-src.environs}{{4.1.1}{44}{src.environs module}{subsubsection*.288}{}}
+\newlabel{apidoc_src/src:src-environs-module}{{4.1.1}{44}{src.environs module}{subsubsection*.288}{}}
+\newlabel{apidoc_src/src:src.environs.print_grep_environs}{{4.1.1}{44}{src.environs module}{section*.289}{}}
+\newlabel{apidoc_src/src:src.environs.print_split_environs}{{4.1.1}{44}{src.environs module}{section*.290}{}}
+\newlabel{apidoc_src/src:src.environs.print_split_pattern_environs}{{4.1.1}{44}{src.environs module}{section*.291}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.exceptionSat module}{44}{subsubsection*.292}}
+\newlabel{apidoc_src/src:module-src.exceptionSat}{{4.1.1}{44}{src.exceptionSat module}{subsubsection*.292}{}}
+\newlabel{apidoc_src/src:src-exceptionsat-module}{{4.1.1}{44}{src.exceptionSat module}{subsubsection*.292}{}}
+\newlabel{apidoc_src/src:src.exceptionSat.ExceptionSat}{{4.1.1}{44}{src.exceptionSat module}{section*.293}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.fileEnviron module}{44}{subsubsection*.294}}
+\newlabel{apidoc_src/src:src-fileenviron-module}{{4.1.1}{44}{src.fileEnviron module}{subsubsection*.294}{}}
+\newlabel{apidoc_src/src:module-src.fileEnviron}{{4.1.1}{44}{src.fileEnviron module}{subsubsection*.294}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BashFileEnviron}{{4.1.1}{44}{src.fileEnviron module}{section*.295}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BashFileEnviron.command_value}{{4.1.1}{44}{src.fileEnviron module}{section*.296}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BashFileEnviron.finish}{{4.1.1}{44}{src.fileEnviron module}{section*.297}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BashFileEnviron.set}{{4.1.1}{44}{src.fileEnviron module}{section*.298}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BatFileEnviron}{{4.1.1}{44}{src.fileEnviron module}{section*.299}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BatFileEnviron.add_comment}{{4.1.1}{45}{src.fileEnviron module}{section*.300}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BatFileEnviron.command_value}{{4.1.1}{45}{src.fileEnviron module}{section*.301}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BatFileEnviron.finish}{{4.1.1}{45}{src.fileEnviron module}{section*.302}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BatFileEnviron.get}{{4.1.1}{45}{src.fileEnviron module}{section*.303}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.BatFileEnviron.set}{{4.1.1}{45}{src.fileEnviron module}{section*.304}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron}{{4.1.1}{45}{src.fileEnviron module}{section*.305}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.add_echo}{{4.1.1}{45}{src.fileEnviron module}{section*.306}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.add_warning}{{4.1.1}{45}{src.fileEnviron module}{section*.307}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.append_value}{{4.1.1}{45}{src.fileEnviron module}{section*.308}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.command_value}{{4.1.1}{45}{src.fileEnviron module}{section*.309}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.finish}{{4.1.1}{46}{src.fileEnviron module}{section*.310}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.get}{{4.1.1}{46}{src.fileEnviron module}{section*.311}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.prepend_value}{{4.1.1}{46}{src.fileEnviron module}{section*.312}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ContextFileEnviron.set}{{4.1.1}{46}{src.fileEnviron module}{section*.313}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron}{{4.1.1}{46}{src.fileEnviron module}{section*.314}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.add_comment}{{4.1.1}{46}{src.fileEnviron module}{section*.315}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.add_echo}{{4.1.1}{46}{src.fileEnviron module}{section*.316}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.add_line}{{4.1.1}{46}{src.fileEnviron module}{section*.317}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.add_warning}{{4.1.1}{46}{src.fileEnviron module}{section*.318}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.append}{{4.1.1}{46}{src.fileEnviron module}{section*.319}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.append_value}{{4.1.1}{46}{src.fileEnviron module}{section*.320}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.command_value}{{4.1.1}{47}{src.fileEnviron module}{section*.321}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.finish}{{4.1.1}{47}{src.fileEnviron module}{section*.322}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.get}{{4.1.1}{47}{src.fileEnviron module}{section*.323}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.is_defined}{{4.1.1}{47}{src.fileEnviron module}{section*.324}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.prepend}{{4.1.1}{47}{src.fileEnviron module}{section*.325}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.prepend_value}{{4.1.1}{47}{src.fileEnviron module}{section*.326}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.FileEnviron.set}{{4.1.1}{47}{src.fileEnviron module}{section*.327}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron}{{4.1.1}{47}{src.fileEnviron module}{section*.328}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add}{{4.1.1}{47}{src.fileEnviron module}{section*.329}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_comment}{{4.1.1}{47}{src.fileEnviron module}{section*.330}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_echo}{{4.1.1}{47}{src.fileEnviron module}{section*.331}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_line}{{4.1.1}{48}{src.fileEnviron module}{section*.332}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_warning}{{4.1.1}{48}{src.fileEnviron module}{section*.333}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.append}{{4.1.1}{48}{src.fileEnviron module}{section*.334}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.append_value}{{4.1.1}{48}{src.fileEnviron module}{section*.335}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}{{4.1.1}{48}{src.fileEnviron module}{section*.336}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.command_value}{{4.1.1}{48}{src.fileEnviron module}{section*.337}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.finish}{{4.1.1}{48}{src.fileEnviron module}{section*.338}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.get}{{4.1.1}{48}{src.fileEnviron module}{section*.339}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.is_defined}{{4.1.1}{48}{src.fileEnviron module}{section*.340}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.prepend}{{4.1.1}{48}{src.fileEnviron module}{section*.341}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.prepend_value}{{4.1.1}{48}{src.fileEnviron module}{section*.342}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.set}{{4.1.1}{49}{src.fileEnviron module}{section*.343}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron}{{4.1.1}{49}{src.fileEnviron module}{section*.344}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_comment}{{4.1.1}{49}{src.fileEnviron module}{section*.345}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_echo}{{4.1.1}{49}{src.fileEnviron module}{section*.346}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_line}{{4.1.1}{49}{src.fileEnviron module}{section*.347}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_warning}{{4.1.1}{49}{src.fileEnviron module}{section*.348}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.append}{{4.1.1}{49}{src.fileEnviron module}{section*.349}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.command_value}{{4.1.1}{49}{src.fileEnviron module}{section*.350}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.get}{{4.1.1}{49}{src.fileEnviron module}{section*.351}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.is_defined}{{4.1.1}{49}{src.fileEnviron module}{section*.352}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.prepend}{{4.1.1}{49}{src.fileEnviron module}{section*.353}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.run_env_script}{{4.1.1}{49}{src.fileEnviron module}{section*.354}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.set}{{4.1.1}{49}{src.fileEnviron module}{section*.355}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.ScreenEnviron.write}{{4.1.1}{49}{src.fileEnviron module}{section*.356}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.get_file_environ}{{4.1.1}{49}{src.fileEnviron module}{section*.357}{}}
+\newlabel{apidoc_src/src:src.fileEnviron.special_path_separator}{{4.1.1}{49}{src.fileEnviron module}{section*.358}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.fork module}{49}{subsubsection*.359}}
+\newlabel{apidoc_src/src:module-src.fork}{{4.1.1}{49}{src.fork module}{subsubsection*.359}{}}
+\newlabel{apidoc_src/src:src-fork-module}{{4.1.1}{49}{src.fork module}{subsubsection*.359}{}}
+\newlabel{apidoc_src/src:src.fork.batch}{{4.1.1}{49}{src.fork module}{section*.360}{}}
+\newlabel{apidoc_src/src:src.fork.batch_salome}{{4.1.1}{49}{src.fork module}{section*.361}{}}
+\newlabel{apidoc_src/src:src.fork.launch_command}{{4.1.1}{49}{src.fork module}{section*.362}{}}
+\newlabel{apidoc_src/src:src.fork.show_progress}{{4.1.1}{50}{src.fork module}{section*.363}{}}
+\newlabel{apidoc_src/src:src.fork.write_back}{{4.1.1}{50}{src.fork module}{section*.364}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.loggingSat module}{50}{subsubsection*.365}}
+\newlabel{apidoc_src/src:module-src.loggingSat}{{4.1.1}{50}{src.loggingSat module}{subsubsection*.365}{}}
+\newlabel{apidoc_src/src:src-loggingsat-module}{{4.1.1}{50}{src.loggingSat module}{subsubsection*.365}{}}
+\newlabel{apidoc_src/src:src.loggingSat.DefaultFormatter}{{4.1.1}{50}{src.loggingSat module}{section*.366}{}}
+\newlabel{apidoc_src/src:src.loggingSat.DefaultFormatter.format}{{4.1.1}{50}{src.loggingSat module}{section*.367}{}}
+\newlabel{apidoc_src/src:src.loggingSat.DefaultFormatter.setColorLevelname}{{4.1.1}{50}{src.loggingSat module}{section*.368}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestFormatter}{{4.1.1}{50}{src.loggingSat module}{section*.369}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestFormatter.format}{{4.1.1}{50}{src.loggingSat module}{section*.370}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestStream}{{4.1.1}{50}{src.loggingSat module}{section*.371}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestStream.flush}{{4.1.1}{50}{src.loggingSat module}{section*.372}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestStream.getLogs}{{4.1.1}{50}{src.loggingSat module}{section*.373}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestStream.getLogsAndClear}{{4.1.1}{51}{src.loggingSat module}{section*.374}{}}
+\newlabel{apidoc_src/src:src.loggingSat.UnittestStream.write}{{4.1.1}{51}{src.loggingSat module}{section*.375}{}}
+\newlabel{apidoc_src/src:src.loggingSat.dirLogger}{{4.1.1}{51}{src.loggingSat module}{section*.376}{}}
+\newlabel{apidoc_src/src:src.loggingSat.getDefaultLogger}{{4.1.1}{51}{src.loggingSat module}{section*.377}{}}
+\newlabel{apidoc_src/src:src.loggingSat.getUnittestLogger}{{4.1.1}{51}{src.loggingSat module}{section*.378}{}}
+\newlabel{apidoc_src/src:src.loggingSat.indent}{{4.1.1}{51}{src.loggingSat module}{section*.379}{}}
+\newlabel{apidoc_src/src:src.loggingSat.indentUnittest}{{4.1.1}{51}{src.loggingSat module}{section*.380}{}}
+\newlabel{apidoc_src/src:src.loggingSat.initLoggerAsDefault}{{4.1.1}{51}{src.loggingSat module}{section*.381}{}}
+\newlabel{apidoc_src/src:src.loggingSat.initLoggerAsUnittest}{{4.1.1}{51}{src.loggingSat module}{section*.382}{}}
+\newlabel{apidoc_src/src:src.loggingSat.log}{{4.1.1}{51}{src.loggingSat module}{section*.383}{}}
+\newlabel{apidoc_src/src:src.loggingSat.testLogger_1}{{4.1.1}{51}{src.loggingSat module}{section*.384}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.options module}{51}{subsubsection*.385}}
+\newlabel{apidoc_src/src:module-src.options}{{4.1.1}{51}{src.options module}{subsubsection*.385}{}}
+\newlabel{apidoc_src/src:src-options-module}{{4.1.1}{51}{src.options module}{subsubsection*.385}{}}
+\newlabel{apidoc_src/src:src.options.OptResult}{{4.1.1}{51}{src.options module}{section*.386}{}}
+\newlabel{apidoc_src/src:src.options.Options}{{4.1.1}{51}{src.options module}{section*.387}{}}
+\newlabel{apidoc_src/src:src.options.Options.add_option}{{4.1.1}{51}{src.options module}{section*.388}{}}
+\newlabel{apidoc_src/src:src.options.Options.debug_write}{{4.1.1}{51}{src.options module}{section*.389}{}}
+\newlabel{apidoc_src/src:src.options.Options.getDetailOption}{{4.1.1}{51}{src.options module}{section*.390}{}}
+\newlabel{apidoc_src/src:src.options.Options.get_help}{{4.1.1}{52}{src.options module}{section*.391}{}}
+\newlabel{apidoc_src/src:src.options.Options.indent}{{4.1.1}{52}{src.options module}{section*.392}{}}
+\newlabel{apidoc_src/src:src.options.Options.parse_args}{{4.1.1}{52}{src.options module}{section*.393}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.product module}{52}{subsubsection*.394}}
+\newlabel{apidoc_src/src:module-src.product}{{4.1.1}{52}{src.product module}{subsubsection*.394}{}}
+\newlabel{apidoc_src/src:src-product-module}{{4.1.1}{52}{src.product module}{subsubsection*.394}{}}
+\newlabel{apidoc_src/src:src.product.check_config_exists}{{4.1.1}{52}{src.product module}{section*.395}{}}
+\newlabel{apidoc_src/src:src.product.check_installation}{{4.1.1}{52}{src.product module}{section*.396}{}}
+\newlabel{apidoc_src/src:src.product.get_base_install_dir}{{4.1.1}{52}{src.product module}{section*.397}{}}
+\newlabel{apidoc_src/src:src.product.get_install_dir}{{4.1.1}{52}{src.product module}{section*.398}{}}
+\newlabel{apidoc_src/src:src.product.get_product_components}{{4.1.1}{53}{src.product module}{section*.399}{}}
+\newlabel{apidoc_src/src:src.product.get_product_config}{{4.1.1}{53}{src.product module}{section*.400}{}}
+\newlabel{apidoc_src/src:src.product.get_product_dependencies}{{4.1.1}{53}{src.product module}{section*.401}{}}
+\newlabel{apidoc_src/src:src.product.get_product_section}{{4.1.1}{53}{src.product module}{section*.402}{}}
+\newlabel{apidoc_src/src:src.product.get_products_infos}{{4.1.1}{53}{src.product module}{section*.403}{}}
+\newlabel{apidoc_src/src:src.product.product_compiles}{{4.1.1}{53}{src.product module}{section*.404}{}}
+\newlabel{apidoc_src/src:src.product.product_has_env_script}{{4.1.1}{54}{src.product module}{section*.405}{}}
+\newlabel{apidoc_src/src:src.product.product_has_logo}{{4.1.1}{54}{src.product module}{section*.406}{}}
+\newlabel{apidoc_src/src:src.product.product_has_patches}{{4.1.1}{54}{src.product module}{section*.407}{}}
+\newlabel{apidoc_src/src:src.product.product_has_salome_gui}{{4.1.1}{54}{src.product module}{section*.408}{}}
+\newlabel{apidoc_src/src:src.product.product_has_script}{{4.1.1}{54}{src.product module}{section*.409}{}}
+\newlabel{apidoc_src/src:src.product.product_is_SALOME}{{4.1.1}{54}{src.product module}{section*.410}{}}
+\newlabel{apidoc_src/src:src.product.product_is_autotools}{{4.1.1}{54}{src.product module}{section*.411}{}}
+\newlabel{apidoc_src/src:src.product.product_is_cmake}{{4.1.1}{54}{src.product module}{section*.412}{}}
+\newlabel{apidoc_src/src:src.product.product_is_cpp}{{4.1.1}{54}{src.product module}{section*.413}{}}
+\newlabel{apidoc_src/src:src.product.product_is_debug}{{4.1.1}{54}{src.product module}{section*.414}{}}
+\newlabel{apidoc_src/src:src.product.product_is_dev}{{4.1.1}{54}{src.product module}{section*.415}{}}
+\newlabel{apidoc_src/src:src.product.product_is_fixed}{{4.1.1}{55}{src.product module}{section*.416}{}}
+\newlabel{apidoc_src/src:src.product.product_is_generated}{{4.1.1}{55}{src.product module}{section*.417}{}}
+\newlabel{apidoc_src/src:src.product.product_is_mpi}{{4.1.1}{55}{src.product module}{section*.418}{}}
+\newlabel{apidoc_src/src:src.product.product_is_native}{{4.1.1}{55}{src.product module}{section*.419}{}}
+\newlabel{apidoc_src/src:src.product.product_is_salome}{{4.1.1}{55}{src.product module}{section*.420}{}}
+\newlabel{apidoc_src/src:src.product.product_is_sample}{{4.1.1}{55}{src.product module}{section*.421}{}}
+\newlabel{apidoc_src/src:src.product.product_is_smesh_plugin}{{4.1.1}{55}{src.product module}{section*.422}{}}
+\newlabel{apidoc_src/src:src.product.product_is_vcs}{{4.1.1}{55}{src.product module}{section*.423}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.pyconf module}{55}{subsubsection*.424}}
+\newlabel{apidoc_src/src:src-pyconf-module}{{4.1.1}{55}{src.pyconf module}{subsubsection*.424}{}}
+\newlabel{apidoc_src/src:module-src.pyconf}{{4.1.1}{55}{src.pyconf module}{subsubsection*.424}{}}
+\newlabel{apidoc_src/src:src.pyconf.Config}{{4.1.1}{56}{src.pyconf module}{section*.425}{}}
+\newlabel{apidoc_src/src:src.pyconf.Config.Namespace}{{4.1.1}{56}{src.pyconf module}{section*.426}{}}
+\newlabel{apidoc_src/src:src.pyconf.Config.addNamespace}{{4.1.1}{57}{src.pyconf module}{section*.427}{}}
+\newlabel{apidoc_src/src:src.pyconf.Config.getByPath}{{4.1.1}{57}{src.pyconf module}{section*.428}{}}
+\newlabel{apidoc_src/src:src.pyconf.Config.load}{{4.1.1}{57}{src.pyconf module}{section*.429}{}}
+\newlabel{apidoc_src/src:src.pyconf.Config.removeNamespace}{{4.1.1}{57}{src.pyconf module}{section*.430}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigError}{{4.1.1}{57}{src.pyconf module}{section*.431}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigFormatError}{{4.1.1}{57}{src.pyconf module}{section*.432}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigInputStream}{{4.1.1}{57}{src.pyconf module}{section*.433}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigInputStream.close}{{4.1.1}{57}{src.pyconf module}{section*.434}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigInputStream.read}{{4.1.1}{57}{src.pyconf module}{section*.435}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigInputStream.readline}{{4.1.1}{57}{src.pyconf module}{section*.436}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigList}{{4.1.1}{57}{src.pyconf module}{section*.437}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigList.getByPath}{{4.1.1}{57}{src.pyconf module}{section*.438}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigMerger}{{4.1.1}{57}{src.pyconf module}{section*.439}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigMerger.handleMismatch}{{4.1.1}{57}{src.pyconf module}{section*.440}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigMerger.merge}{{4.1.1}{58}{src.pyconf module}{section*.441}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigMerger.mergeMapping}{{4.1.1}{58}{src.pyconf module}{section*.442}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigMerger.mergeSequence}{{4.1.1}{58}{src.pyconf module}{section*.443}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigMerger.overwriteKeys}{{4.1.1}{58}{src.pyconf module}{section*.444}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigOutputStream}{{4.1.1}{58}{src.pyconf module}{section*.445}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigOutputStream.close}{{4.1.1}{58}{src.pyconf module}{section*.446}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigOutputStream.flush}{{4.1.1}{58}{src.pyconf module}{section*.447}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigOutputStream.write}{{4.1.1}{58}{src.pyconf module}{section*.448}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader}{{4.1.1}{58}{src.pyconf module}{section*.449}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.getChar}{{4.1.1}{58}{src.pyconf module}{section*.450}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.getToken}{{4.1.1}{58}{src.pyconf module}{section*.451}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.load}{{4.1.1}{58}{src.pyconf module}{section*.452}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.location}{{4.1.1}{59}{src.pyconf module}{section*.453}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.match}{{4.1.1}{59}{src.pyconf module}{section*.454}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseFactor}{{4.1.1}{59}{src.pyconf module}{section*.455}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseKeyValuePair}{{4.1.1}{59}{src.pyconf module}{section*.456}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseMapping}{{4.1.1}{59}{src.pyconf module}{section*.457}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseMappingBody}{{4.1.1}{59}{src.pyconf module}{section*.458}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseReference}{{4.1.1}{59}{src.pyconf module}{section*.459}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseScalar}{{4.1.1}{59}{src.pyconf module}{section*.460}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseSequence}{{4.1.1}{59}{src.pyconf module}{section*.461}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseSuffix}{{4.1.1}{59}{src.pyconf module}{section*.462}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseTerm}{{4.1.1}{59}{src.pyconf module}{section*.463}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.parseValue}{{4.1.1}{59}{src.pyconf module}{section*.464}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigReader.setStream}{{4.1.1}{60}{src.pyconf module}{section*.465}{}}
+\newlabel{apidoc_src/src:src.pyconf.ConfigResolutionError}{{4.1.1}{60}{src.pyconf module}{section*.466}{}}
+\newlabel{apidoc_src/src:src.pyconf.Container}{{4.1.1}{60}{src.pyconf module}{section*.467}{}}
+\newlabel{apidoc_src/src:src.pyconf.Container.evaluate}{{4.1.1}{60}{src.pyconf module}{section*.468}{}}
+\newlabel{apidoc_src/src:src.pyconf.Container.setPath}{{4.1.1}{60}{src.pyconf module}{section*.469}{}}
+\newlabel{apidoc_src/src:src.pyconf.Container.writeToStream}{{4.1.1}{60}{src.pyconf module}{section*.470}{}}
+\newlabel{apidoc_src/src:src.pyconf.Container.writeValue}{{4.1.1}{60}{src.pyconf module}{section*.471}{}}
+\newlabel{apidoc_src/src:src.pyconf.Expression}{{4.1.1}{60}{src.pyconf module}{section*.472}{}}
+\newlabel{apidoc_src/src:src.pyconf.Expression.evaluate}{{4.1.1}{60}{src.pyconf module}{section*.473}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping}{{4.1.1}{60}{src.pyconf module}{section*.474}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping.addMapping}{{4.1.1}{61}{src.pyconf module}{section*.475}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping.get}{{4.1.1}{61}{src.pyconf module}{section*.476}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping.iteritems}{{4.1.1}{61}{src.pyconf module}{section*.477}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping.iterkeys}{{4.1.1}{61}{src.pyconf module}{section*.478}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping.keys}{{4.1.1}{61}{src.pyconf module}{section*.479}{}}
+\newlabel{apidoc_src/src:src.pyconf.Mapping.writeToStream}{{4.1.1}{61}{src.pyconf module}{section*.480}{}}
+\newlabel{apidoc_src/src:src.pyconf.Reference}{{4.1.1}{61}{src.pyconf module}{section*.481}{}}
+\newlabel{apidoc_src/src:src.pyconf.Reference.addElement}{{4.1.1}{61}{src.pyconf module}{section*.482}{}}
+\newlabel{apidoc_src/src:src.pyconf.Reference.findConfig}{{4.1.1}{61}{src.pyconf module}{section*.483}{}}
+\newlabel{apidoc_src/src:src.pyconf.Reference.resolve}{{4.1.1}{61}{src.pyconf module}{section*.484}{}}
+\newlabel{apidoc_src/src:src.pyconf.Sequence}{{4.1.1}{61}{src.pyconf module}{section*.485}{}}
+\newlabel{apidoc_src/src:src.pyconf.Sequence.SeqIter}{{4.1.1}{61}{src.pyconf module}{section*.486}{}}
+\newlabel{apidoc_src/src:src.pyconf.Sequence.SeqIter.next}{{4.1.1}{61}{src.pyconf module}{section*.487}{}}
+\newlabel{apidoc_src/src:src.pyconf.Sequence.append}{{4.1.1}{61}{src.pyconf module}{section*.488}{}}
+\newlabel{apidoc_src/src:src.pyconf.Sequence.writeToStream}{{4.1.1}{62}{src.pyconf module}{section*.489}{}}
+\newlabel{apidoc_src/src:src.pyconf.deepCopyMapping}{{4.1.1}{62}{src.pyconf module}{section*.490}{}}
+\newlabel{apidoc_src/src:src.pyconf.defaultMergeResolve}{{4.1.1}{62}{src.pyconf module}{section*.491}{}}
+\newlabel{apidoc_src/src:src.pyconf.defaultStreamOpener}{{4.1.1}{62}{src.pyconf module}{section*.492}{}}
+\newlabel{apidoc_src/src:src.pyconf.isWord}{{4.1.1}{62}{src.pyconf module}{section*.493}{}}
+\newlabel{apidoc_src/src:src.pyconf.makePath}{{4.1.1}{62}{src.pyconf module}{section*.494}{}}
+\newlabel{apidoc_src/src:src.pyconf.overwriteMergeResolve}{{4.1.1}{62}{src.pyconf module}{section*.495}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.returnCode module}{63}{subsubsection*.496}}
+\newlabel{apidoc_src/src:module-src.returnCode}{{4.1.1}{63}{src.returnCode module}{subsubsection*.496}{}}
+\newlabel{apidoc_src/src:src-returncode-module}{{4.1.1}{63}{src.returnCode module}{subsubsection*.496}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode}{{4.1.1}{63}{src.returnCode module}{section*.497}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.KFSYS}{{4.1.1}{63}{src.returnCode module}{section*.498}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.KNOWNFAILURE_STATUS}{{4.1.1}{63}{src.returnCode module}{section*.499}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.KOSYS}{{4.1.1}{63}{src.returnCode module}{section*.500}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.KO_STATUS}{{4.1.1}{63}{src.returnCode module}{section*.501}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.NASYS}{{4.1.1}{63}{src.returnCode module}{section*.502}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.NA_STATUS}{{4.1.1}{63}{src.returnCode module}{section*.503}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.NDSYS}{{4.1.1}{63}{src.returnCode module}{section*.504}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.OKSYS}{{4.1.1}{63}{src.returnCode module}{section*.505}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.OK_STATUS}{{4.1.1}{63}{src.returnCode module}{section*.506}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.TIMEOUT_STATUS}{{4.1.1}{63}{src.returnCode module}{section*.507}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.TOSYS}{{4.1.1}{63}{src.returnCode module}{section*.508}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.UNKNOWN_STATUS}{{4.1.1}{63}{src.returnCode module}{section*.509}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.getValue}{{4.1.1}{63}{src.returnCode module}{section*.510}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.getWhy}{{4.1.1}{63}{src.returnCode module}{section*.511}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.indent}{{4.1.1}{63}{src.returnCode module}{section*.512}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.isOk}{{4.1.1}{63}{src.returnCode module}{section*.513}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.raiseIfKo}{{4.1.1}{63}{src.returnCode module}{section*.514}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.setStatus}{{4.1.1}{63}{src.returnCode module}{section*.515}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.setValue}{{4.1.1}{63}{src.returnCode module}{section*.516}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.setWhy}{{4.1.1}{63}{src.returnCode module}{section*.517}{}}
+\newlabel{apidoc_src/src:src.returnCode.ReturnCode.toSys}{{4.1.1}{63}{src.returnCode module}{section*.518}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.salomeTools module}{64}{subsubsection*.519}}
+\newlabel{apidoc_src/src:src-salometools-module}{{4.1.1}{64}{src.salomeTools module}{subsubsection*.519}{}}
+\newlabel{apidoc_src/src:module-src.salomeTools}{{4.1.1}{64}{src.salomeTools module}{subsubsection*.519}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat}{{4.1.1}{64}{src.salomeTools module}{section*.520}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.assumeAsList}{{4.1.1}{64}{src.salomeTools module}{section*.521}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.execute_cli}{{4.1.1}{64}{src.salomeTools module}{section*.522}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getColoredVersion}{{4.1.1}{64}{src.salomeTools module}{section*.523}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getCommandAndAppli}{{4.1.1}{64}{src.salomeTools module}{section*.524}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getCommandInstance}{{4.1.1}{64}{src.salomeTools module}{section*.525}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getConfig}{{4.1.1}{64}{src.salomeTools module}{section*.526}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getConfigManager}{{4.1.1}{64}{src.salomeTools module}{section*.527}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getLogger}{{4.1.1}{64}{src.salomeTools module}{section*.528}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.getModule}{{4.1.1}{64}{src.salomeTools module}{section*.529}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.get_help}{{4.1.1}{64}{src.salomeTools module}{section*.530}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.parseArguments}{{4.1.1}{64}{src.salomeTools module}{section*.531}{}}
+\newlabel{apidoc_src/src:src.salomeTools.Sat.print_help}{{4.1.1}{64}{src.salomeTools module}{section*.532}{}}
+\newlabel{apidoc_src/src:src.salomeTools.assumeAsList}{{4.1.1}{64}{src.salomeTools module}{section*.533}{}}
+\newlabel{apidoc_src/src:src.salomeTools.find_command_list}{{4.1.1}{64}{src.salomeTools module}{section*.534}{}}
+\newlabel{apidoc_src/src:src.salomeTools.getCommandsList}{{4.1.1}{64}{src.salomeTools module}{section*.535}{}}
+\newlabel{apidoc_src/src:src.salomeTools.getVersion}{{4.1.1}{64}{src.salomeTools module}{section*.536}{}}
+\newlabel{apidoc_src/src:src.salomeTools.launchSat}{{4.1.1}{64}{src.salomeTools module}{section*.537}{}}
+\newlabel{apidoc_src/src:src.salomeTools.setLocale}{{4.1.1}{64}{src.salomeTools module}{section*.538}{}}
+\newlabel{apidoc_src/src:src.salomeTools.setNotLocale}{{4.1.1}{64}{src.salomeTools module}{section*.539}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.system module}{65}{subsubsection*.540}}
+\newlabel{apidoc_src/src:src-system-module}{{4.1.1}{65}{src.system module}{subsubsection*.540}{}}
+\newlabel{apidoc_src/src:module-src.system}{{4.1.1}{65}{src.system module}{subsubsection*.540}{}}
+\newlabel{apidoc_src/src:src.system.archive_extract}{{4.1.1}{65}{src.system module}{section*.541}{}}
+\newlabel{apidoc_src/src:src.system.cvs_extract}{{4.1.1}{65}{src.system module}{section*.542}{}}
+\newlabel{apidoc_src/src:src.system.git_extract}{{4.1.1}{65}{src.system module}{section*.543}{}}
+\newlabel{apidoc_src/src:src.system.show_in_editor}{{4.1.1}{65}{src.system module}{section*.544}{}}
+\newlabel{apidoc_src/src:src.system.svn_extract}{{4.1.1}{65}{src.system module}{section*.545}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.template module}{66}{subsubsection*.546}}
+\newlabel{apidoc_src/src:module-src.template}{{4.1.1}{66}{src.template module}{subsubsection*.546}{}}
+\newlabel{apidoc_src/src:src-template-module}{{4.1.1}{66}{src.template module}{subsubsection*.546}{}}
+\newlabel{apidoc_src/src:src.template.MyTemplate}{{4.1.1}{66}{src.template module}{section*.547}{}}
+\newlabel{apidoc_src/src:src.template.MyTemplate.delimiter}{{4.1.1}{66}{src.template module}{section*.548}{}}
+\newlabel{apidoc_src/src:src.template.MyTemplate.pattern}{{4.1.1}{66}{src.template module}{section*.549}{}}
+\newlabel{apidoc_src/src:src.template.substitute}{{4.1.1}{66}{src.template module}{section*.550}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.test\_module module}{66}{subsubsection*.551}}
+\newlabel{apidoc_src/src:module-src.test_module}{{4.1.1}{66}{src.test\_module module}{subsubsection*.551}{}}
+\newlabel{apidoc_src/src:src-test-module-module}{{4.1.1}{66}{src.test\_module module}{subsubsection*.551}{}}
+\newlabel{apidoc_src/src:src.test_module.Test}{{4.1.1}{66}{src.test\_module module}{section*.552}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.generate_launching_commands}{{4.1.1}{66}{src.test\_module module}{section*.553}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.generate_script}{{4.1.1}{66}{src.test\_module module}{section*.554}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.get_test_timeout}{{4.1.1}{66}{src.test\_module module}{section*.555}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.get_tmp_dir}{{4.1.1}{66}{src.test\_module module}{section*.556}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.prepare_testbase}{{4.1.1}{66}{src.test\_module module}{section*.557}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.prepare_testbase_from_dir}{{4.1.1}{66}{src.test\_module module}{section*.558}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.prepare_testbase_from_git}{{4.1.1}{66}{src.test\_module module}{section*.559}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.prepare_testbase_from_svn}{{4.1.1}{66}{src.test\_module module}{section*.560}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.read_results}{{4.1.1}{66}{src.test\_module module}{section*.561}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.run_all_tests}{{4.1.1}{66}{src.test\_module module}{section*.562}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.run_grid_tests}{{4.1.1}{66}{src.test\_module module}{section*.563}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.run_script}{{4.1.1}{66}{src.test\_module module}{section*.564}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.run_session_tests}{{4.1.1}{66}{src.test\_module module}{section*.565}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.run_testbase_tests}{{4.1.1}{66}{src.test\_module module}{section*.566}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.run_tests}{{4.1.1}{66}{src.test\_module module}{section*.567}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.search_known_errors}{{4.1.1}{66}{src.test\_module module}{section*.568}{}}
+\newlabel{apidoc_src/src:src.test_module.Test.write_test_margin}{{4.1.1}{66}{src.test\_module module}{section*.569}{}}
+\newlabel{apidoc_src/src:src.test_module.getTmpDirDEFAULT}{{4.1.1}{67}{src.test\_module module}{section*.570}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.utilsSat module}{67}{subsubsection*.571}}
+\newlabel{apidoc_src/src:src-utilssat-module}{{4.1.1}{67}{src.utilsSat module}{subsubsection*.571}{}}
+\newlabel{apidoc_src/src:module-src.utilsSat}{{4.1.1}{67}{src.utilsSat module}{subsubsection*.571}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path}{{4.1.1}{67}{src.utilsSat module}{section*.572}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.base}{{4.1.1}{67}{src.utilsSat module}{section*.573}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.chmod}{{4.1.1}{67}{src.utilsSat module}{section*.574}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.copy}{{4.1.1}{67}{src.utilsSat module}{section*.575}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.copydir}{{4.1.1}{67}{src.utilsSat module}{section*.576}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.copyfile}{{4.1.1}{67}{src.utilsSat module}{section*.577}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.copylink}{{4.1.1}{67}{src.utilsSat module}{section*.578}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.dir}{{4.1.1}{67}{src.utilsSat module}{section*.579}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.exists}{{4.1.1}{67}{src.utilsSat module}{section*.580}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.isdir}{{4.1.1}{67}{src.utilsSat module}{section*.581}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.isfile}{{4.1.1}{67}{src.utilsSat module}{section*.582}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.islink}{{4.1.1}{67}{src.utilsSat module}{section*.583}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.list}{{4.1.1}{67}{src.utilsSat module}{section*.584}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.make}{{4.1.1}{67}{src.utilsSat module}{section*.585}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.readlink}{{4.1.1}{67}{src.utilsSat module}{section*.586}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.rm}{{4.1.1}{67}{src.utilsSat module}{section*.587}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.smartcopy}{{4.1.1}{67}{src.utilsSat module}{section*.588}{}}
+\newlabel{apidoc_src/src:src.utilsSat.Path.symlink}{{4.1.1}{67}{src.utilsSat module}{section*.589}{}}
+\newlabel{apidoc_src/src:src.utilsSat.black}{{4.1.1}{67}{src.utilsSat module}{section*.590}{}}
+\newlabel{apidoc_src/src:src.utilsSat.blue}{{4.1.1}{67}{src.utilsSat module}{section*.591}{}}
+\newlabel{apidoc_src/src:src.utilsSat.check_config_has_application}{{4.1.1}{67}{src.utilsSat module}{section*.592}{}}
+\newlabel{apidoc_src/src:src.utilsSat.check_config_has_profile}{{4.1.1}{67}{src.utilsSat module}{section*.593}{}}
+\newlabel{apidoc_src/src:src.utilsSat.check_has_key}{{4.1.1}{67}{src.utilsSat module}{section*.594}{}}
+\newlabel{apidoc_src/src:src.utilsSat.config_has_application}{{4.1.1}{67}{src.utilsSat module}{section*.595}{}}
+\newlabel{apidoc_src/src:src.utilsSat.critical}{{4.1.1}{68}{src.utilsSat module}{section*.596}{}}
+\newlabel{apidoc_src/src:src.utilsSat.cyan}{{4.1.1}{68}{src.utilsSat module}{section*.597}{}}
+\newlabel{apidoc_src/src:src.utilsSat.date_to_datetime}{{4.1.1}{68}{src.utilsSat module}{section*.598}{}}
+\newlabel{apidoc_src/src:src.utilsSat.deepcopy_list}{{4.1.1}{68}{src.utilsSat module}{section*.599}{}}
+\newlabel{apidoc_src/src:src.utilsSat.ensure_path_exists}{{4.1.1}{68}{src.utilsSat module}{section*.600}{}}
+\newlabel{apidoc_src/src:src.utilsSat.error}{{4.1.1}{68}{src.utilsSat module}{section*.601}{}}
+\newlabel{apidoc_src/src:src.utilsSat.find_file_in_lpath}{{4.1.1}{68}{src.utilsSat module}{section*.602}{}}
+\newlabel{apidoc_src/src:src.utilsSat.formatTuples}{{4.1.1}{68}{src.utilsSat module}{section*.603}{}}
+\newlabel{apidoc_src/src:src.utilsSat.formatValue}{{4.1.1}{68}{src.utilsSat module}{section*.604}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_base_path}{{4.1.1}{68}{src.utilsSat module}{section*.605}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_cfg_param}{{4.1.1}{68}{src.utilsSat module}{section*.606}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_launcher_name}{{4.1.1}{69}{src.utilsSat module}{section*.607}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_log_path}{{4.1.1}{69}{src.utilsSat module}{section*.608}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_property_in_product_cfg}{{4.1.1}{69}{src.utilsSat module}{section*.609}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_salome_version}{{4.1.1}{69}{src.utilsSat module}{section*.610}{}}
+\newlabel{apidoc_src/src:src.utilsSat.get_tmp_filename}{{4.1.1}{69}{src.utilsSat module}{section*.611}{}}
+\newlabel{apidoc_src/src:src.utilsSat.green}{{4.1.1}{69}{src.utilsSat module}{section*.612}{}}
+\newlabel{apidoc_src/src:src.utilsSat.handleRemoveReadonly}{{4.1.1}{69}{src.utilsSat module}{section*.613}{}}
+\newlabel{apidoc_src/src:src.utilsSat.header}{{4.1.1}{69}{src.utilsSat module}{section*.614}{}}
+\newlabel{apidoc_src/src:src.utilsSat.info}{{4.1.1}{69}{src.utilsSat module}{section*.615}{}}
+\newlabel{apidoc_src/src:src.utilsSat.label}{{4.1.1}{69}{src.utilsSat module}{section*.616}{}}
+\newlabel{apidoc_src/src:src.utilsSat.list_log_file}{{4.1.1}{69}{src.utilsSat module}{section*.617}{}}
+\newlabel{apidoc_src/src:src.utilsSat.log_res_step}{{4.1.1}{69}{src.utilsSat module}{section*.618}{}}
+\newlabel{apidoc_src/src:src.utilsSat.log_step}{{4.1.1}{69}{src.utilsSat module}{section*.619}{}}
+\newlabel{apidoc_src/src:src.utilsSat.logger_info_tuples}{{4.1.1}{69}{src.utilsSat module}{section*.620}{}}
+\newlabel{apidoc_src/src:src.utilsSat.magenta}{{4.1.1}{69}{src.utilsSat module}{section*.621}{}}
+\newlabel{apidoc_src/src:src.utilsSat.merge_dicts}{{4.1.1}{69}{src.utilsSat module}{section*.622}{}}
+\newlabel{apidoc_src/src:src.utilsSat.normal}{{4.1.1}{69}{src.utilsSat module}{section*.623}{}}
+\newlabel{apidoc_src/src:src.utilsSat.only_numbers}{{4.1.1}{69}{src.utilsSat module}{section*.624}{}}
+\newlabel{apidoc_src/src:src.utilsSat.parse_date}{{4.1.1}{69}{src.utilsSat module}{section*.625}{}}
+\newlabel{apidoc_src/src:src.utilsSat.read_config_from_a_file}{{4.1.1}{69}{src.utilsSat module}{section*.626}{}}
+\newlabel{apidoc_src/src:src.utilsSat.red}{{4.1.1}{69}{src.utilsSat module}{section*.627}{}}
+\newlabel{apidoc_src/src:src.utilsSat.remove_item_from_list}{{4.1.1}{69}{src.utilsSat module}{section*.628}{}}
+\newlabel{apidoc_src/src:src.utilsSat.replace_in_file}{{4.1.1}{70}{src.utilsSat module}{section*.629}{}}
+\newlabel{apidoc_src/src:src.utilsSat.reset}{{4.1.1}{70}{src.utilsSat module}{section*.630}{}}
+\newlabel{apidoc_src/src:src.utilsSat.show_command_log}{{4.1.1}{70}{src.utilsSat module}{section*.631}{}}
+\newlabel{apidoc_src/src:src.utilsSat.success}{{4.1.1}{70}{src.utilsSat module}{section*.632}{}}
+\newlabel{apidoc_src/src:src.utilsSat.timedelta_total_seconds}{{4.1.1}{70}{src.utilsSat module}{section*.633}{}}
+\newlabel{apidoc_src/src:src.utilsSat.update_hat_xml}{{4.1.1}{70}{src.utilsSat module}{section*.634}{}}
+\newlabel{apidoc_src/src:src.utilsSat.warning}{{4.1.1}{70}{src.utilsSat module}{section*.635}{}}
+\newlabel{apidoc_src/src:src.utilsSat.white}{{4.1.1}{70}{src.utilsSat module}{section*.636}{}}
+\newlabel{apidoc_src/src:src.utilsSat.yellow}{{4.1.1}{70}{src.utilsSat module}{section*.637}{}}
+\@writefile{toc}{\contentsline {subsubsection}{src.xmlManager module}{70}{subsubsection*.638}}
+\newlabel{apidoc_src/src:src-xmlmanager-module}{{4.1.1}{70}{src.xmlManager module}{subsubsection*.638}{}}
+\newlabel{apidoc_src/src:module-src.xmlManager}{{4.1.1}{70}{src.xmlManager module}{subsubsection*.638}{}}
+\newlabel{apidoc_src/src:src.xmlManager.ReadXmlFile}{{4.1.1}{70}{src.xmlManager module}{section*.639}{}}
+\newlabel{apidoc_src/src:src.xmlManager.ReadXmlFile.getRootAttrib}{{4.1.1}{70}{src.xmlManager module}{section*.640}{}}
+\newlabel{apidoc_src/src:src.xmlManager.ReadXmlFile.get_attrib}{{4.1.1}{71}{src.xmlManager module}{section*.641}{}}
+\newlabel{apidoc_src/src:src.xmlManager.ReadXmlFile.get_node_text}{{4.1.1}{71}{src.xmlManager module}{section*.642}{}}
+\newlabel{apidoc_src/src:src.xmlManager.XmlLogFile}{{4.1.1}{71}{src.xmlManager module}{section*.643}{}}
+\newlabel{apidoc_src/src:src.xmlManager.XmlLogFile.add_simple_node}{{4.1.1}{71}{src.xmlManager module}{section*.644}{}}
+\newlabel{apidoc_src/src:src.xmlManager.XmlLogFile.append_node_attrib}{{4.1.1}{71}{src.xmlManager module}{section*.645}{}}
+\newlabel{apidoc_src/src:src.xmlManager.XmlLogFile.append_node_text}{{4.1.1}{71}{src.xmlManager module}{section*.646}{}}
+\newlabel{apidoc_src/src:src.xmlManager.XmlLogFile.write_tree}{{4.1.1}{71}{src.xmlManager module}{section*.647}{}}
+\newlabel{apidoc_src/src:src.xmlManager.add_simple_node}{{4.1.1}{71}{src.xmlManager module}{section*.648}{}}
+\newlabel{apidoc_src/src:src.xmlManager.append_node_attrib}{{4.1.1}{71}{src.xmlManager module}{section*.649}{}}
+\newlabel{apidoc_src/src:src.xmlManager.find_node_by_attrib}{{4.1.1}{72}{src.xmlManager module}{section*.650}{}}
+\newlabel{apidoc_src/src:src.xmlManager.write_report}{{4.1.1}{72}{src.xmlManager module}{section*.651}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Module contents}{72}{subsubsection*.652}}
+\newlabel{apidoc_src/src:module-src}{{4.1.1}{72}{Module contents}{subsubsection*.652}{}}
+\newlabel{apidoc_src/src:module-contents}{{4.1.1}{72}{Module contents}{subsubsection*.652}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {4.2}commands}{72}{section.4.2}}
+\newlabel{apidoc_commands/modules:commands}{{4.2}{72}{commands}{section.4.2}{}}
+\newlabel{apidoc_commands/modules::doc}{{4.2}{72}{commands}{section.4.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.1}commands package}{72}{subsection.4.2.1}}
+\newlabel{apidoc_commands/commands::doc}{{4.2.1}{72}{commands package}{subsection.4.2.1}{}}
+\newlabel{apidoc_commands/commands:commands-package}{{4.2.1}{72}{commands package}{subsection.4.2.1}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Submodules}{72}{subsubsection*.653}}
+\newlabel{apidoc_commands/commands:submodules}{{4.2.1}{72}{Submodules}{subsubsection*.653}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.application module}{72}{subsubsection*.654}}
+\newlabel{apidoc_commands/commands:module-commands.application}{{4.2.1}{72}{commands.application module}{subsubsection*.654}{}}
+\newlabel{apidoc_commands/commands:commands-application-module}{{4.2.1}{72}{commands.application module}{subsubsection*.654}{}}
+\newlabel{apidoc_commands/commands:commands.application.Command}{{4.2.1}{72}{commands.application module}{section*.655}{}}
+\newlabel{apidoc_commands/commands:commands.application.Command.getParser}{{4.2.1}{72}{commands.application module}{section*.656}{}}
+\newlabel{apidoc_commands/commands:commands.application.Command.name}{{4.2.1}{72}{commands.application module}{section*.657}{}}
+\newlabel{apidoc_commands/commands:commands.application.Command.run}{{4.2.1}{72}{commands.application module}{section*.658}{}}
+\newlabel{apidoc_commands/commands:commands.application.add_module_to_appli}{{4.2.1}{73}{commands.application module}{section*.659}{}}
+\newlabel{apidoc_commands/commands:commands.application.create_application}{{4.2.1}{73}{commands.application module}{section*.660}{}}
+\newlabel{apidoc_commands/commands:commands.application.create_config_file}{{4.2.1}{73}{commands.application module}{section*.661}{}}
+\newlabel{apidoc_commands/commands:commands.application.customize_app}{{4.2.1}{73}{commands.application module}{section*.662}{}}
+\newlabel{apidoc_commands/commands:commands.application.generate_application}{{4.2.1}{73}{commands.application module}{section*.663}{}}
+\newlabel{apidoc_commands/commands:commands.application.generate_catalog}{{4.2.1}{73}{commands.application module}{section*.664}{}}
+\newlabel{apidoc_commands/commands:commands.application.generate_launch_file}{{4.2.1}{73}{commands.application module}{section*.665}{}}
+\newlabel{apidoc_commands/commands:commands.application.get_SALOME_modules}{{4.2.1}{73}{commands.application module}{section*.666}{}}
+\newlabel{apidoc_commands/commands:commands.application.get_step}{{4.2.1}{73}{commands.application module}{section*.667}{}}
+\newlabel{apidoc_commands/commands:commands.application.make_alias}{{4.2.1}{73}{commands.application module}{section*.668}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.check module}{73}{subsubsection*.669}}
+\newlabel{apidoc_commands/commands:module-commands.check}{{4.2.1}{73}{commands.check module}{subsubsection*.669}{}}
+\newlabel{apidoc_commands/commands:commands-check-module}{{4.2.1}{73}{commands.check module}{subsubsection*.669}{}}
+\newlabel{apidoc_commands/commands:commands.check.Command}{{4.2.1}{73}{commands.check module}{section*.670}{}}
+\newlabel{apidoc_commands/commands:commands.check.Command.getParser}{{4.2.1}{73}{commands.check module}{section*.671}{}}
+\newlabel{apidoc_commands/commands:commands.check.Command.name}{{4.2.1}{73}{commands.check module}{section*.672}{}}
+\newlabel{apidoc_commands/commands:commands.check.Command.run}{{4.2.1}{73}{commands.check module}{section*.673}{}}
+\newlabel{apidoc_commands/commands:commands.check.check_all_products}{{4.2.1}{73}{commands.check module}{section*.674}{}}
+\newlabel{apidoc_commands/commands:commands.check.check_product}{{4.2.1}{73}{commands.check module}{section*.675}{}}
+\newlabel{apidoc_commands/commands:commands.check.get_products_list}{{4.2.1}{74}{commands.check module}{section*.676}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.clean module}{74}{subsubsection*.677}}
+\newlabel{apidoc_commands/commands:commands-clean-module}{{4.2.1}{74}{commands.clean module}{subsubsection*.677}{}}
+\newlabel{apidoc_commands/commands:module-commands.clean}{{4.2.1}{74}{commands.clean module}{subsubsection*.677}{}}
+\newlabel{apidoc_commands/commands:commands.clean.Command}{{4.2.1}{74}{commands.clean module}{section*.678}{}}
+\newlabel{apidoc_commands/commands:commands.clean.Command.getParser}{{4.2.1}{74}{commands.clean module}{section*.679}{}}
+\newlabel{apidoc_commands/commands:commands.clean.Command.name}{{4.2.1}{74}{commands.clean module}{section*.680}{}}
+\newlabel{apidoc_commands/commands:commands.clean.Command.run}{{4.2.1}{74}{commands.clean module}{section*.681}{}}
+\newlabel{apidoc_commands/commands:commands.clean.get_build_directories}{{4.2.1}{74}{commands.clean module}{section*.682}{}}
+\newlabel{apidoc_commands/commands:commands.clean.get_install_directories}{{4.2.1}{74}{commands.clean module}{section*.683}{}}
+\newlabel{apidoc_commands/commands:commands.clean.get_source_directories}{{4.2.1}{74}{commands.clean module}{section*.684}{}}
+\newlabel{apidoc_commands/commands:commands.clean.product_has_dir}{{4.2.1}{75}{commands.clean module}{section*.685}{}}
+\newlabel{apidoc_commands/commands:commands.clean.suppress_directories}{{4.2.1}{75}{commands.clean module}{section*.686}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.compile module}{75}{subsubsection*.687}}
+\newlabel{apidoc_commands/commands:commands-compile-module}{{4.2.1}{75}{commands.compile module}{subsubsection*.687}{}}
+\newlabel{apidoc_commands/commands:module-commands.compile}{{4.2.1}{75}{commands.compile module}{subsubsection*.687}{}}
+\newlabel{apidoc_commands/commands:commands.compile.Command}{{4.2.1}{75}{commands.compile module}{section*.688}{}}
+\newlabel{apidoc_commands/commands:commands.compile.Command.getParser}{{4.2.1}{75}{commands.compile module}{section*.689}{}}
+\newlabel{apidoc_commands/commands:commands.compile.Command.name}{{4.2.1}{75}{commands.compile module}{section*.690}{}}
+\newlabel{apidoc_commands/commands:commands.compile.Command.run}{{4.2.1}{75}{commands.compile module}{section*.691}{}}
+\newlabel{apidoc_commands/commands:commands.compile.add_compile_config_file}{{4.2.1}{75}{commands.compile module}{section*.692}{}}
+\newlabel{apidoc_commands/commands:commands.compile.check_dependencies}{{4.2.1}{75}{commands.compile module}{section*.693}{}}
+\newlabel{apidoc_commands/commands:commands.compile.compile_all_products}{{4.2.1}{75}{commands.compile module}{section*.694}{}}
+\newlabel{apidoc_commands/commands:commands.compile.compile_product}{{4.2.1}{75}{commands.compile module}{section*.695}{}}
+\newlabel{apidoc_commands/commands:commands.compile.compile_product_cmake_autotools}{{4.2.1}{76}{commands.compile module}{section*.696}{}}
+\newlabel{apidoc_commands/commands:commands.compile.compile_product_script}{{4.2.1}{76}{commands.compile module}{section*.697}{}}
+\newlabel{apidoc_commands/commands:commands.compile.extend_with_children}{{4.2.1}{76}{commands.compile module}{section*.698}{}}
+\newlabel{apidoc_commands/commands:commands.compile.extend_with_fathers}{{4.2.1}{76}{commands.compile module}{section*.699}{}}
+\newlabel{apidoc_commands/commands:commands.compile.get_children}{{4.2.1}{76}{commands.compile module}{section*.700}{}}
+\newlabel{apidoc_commands/commands:commands.compile.get_products_list}{{4.2.1}{76}{commands.compile module}{section*.701}{}}
+\newlabel{apidoc_commands/commands:commands.compile.get_recursive_children}{{4.2.1}{76}{commands.compile module}{section*.702}{}}
+\newlabel{apidoc_commands/commands:commands.compile.get_recursive_fathers}{{4.2.1}{77}{commands.compile module}{section*.703}{}}
+\newlabel{apidoc_commands/commands:commands.compile.sort_products}{{4.2.1}{77}{commands.compile module}{section*.704}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.config module}{77}{subsubsection*.705}}
+\newlabel{apidoc_commands/commands:commands-config-module}{{4.2.1}{77}{commands.config module}{subsubsection*.705}{}}
+\newlabel{apidoc_commands/commands:module-commands.config}{{4.2.1}{77}{commands.config module}{subsubsection*.705}{}}
+\newlabel{apidoc_commands/commands:commands.config.Command}{{4.2.1}{77}{commands.config module}{section*.706}{}}
+\newlabel{apidoc_commands/commands:commands.config.Command.getParser}{{4.2.1}{77}{commands.config module}{section*.707}{}}
+\newlabel{apidoc_commands/commands:commands.config.Command.name}{{4.2.1}{77}{commands.config module}{section*.708}{}}
+\newlabel{apidoc_commands/commands:commands.config.Command.run}{{4.2.1}{77}{commands.config module}{section*.709}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.configure module}{77}{subsubsection*.710}}
+\newlabel{apidoc_commands/commands:module-commands.configure}{{4.2.1}{77}{commands.configure module}{subsubsection*.710}{}}
+\newlabel{apidoc_commands/commands:commands-configure-module}{{4.2.1}{77}{commands.configure module}{subsubsection*.710}{}}
+\newlabel{apidoc_commands/commands:commands.configure.Command}{{4.2.1}{77}{commands.configure module}{section*.711}{}}
+\newlabel{apidoc_commands/commands:commands.configure.Command.getParser}{{4.2.1}{78}{commands.configure module}{section*.712}{}}
+\newlabel{apidoc_commands/commands:commands.configure.Command.name}{{4.2.1}{78}{commands.configure module}{section*.713}{}}
+\newlabel{apidoc_commands/commands:commands.configure.Command.run}{{4.2.1}{78}{commands.configure module}{section*.714}{}}
+\newlabel{apidoc_commands/commands:commands.configure.configure_all_products}{{4.2.1}{78}{commands.configure module}{section*.715}{}}
+\newlabel{apidoc_commands/commands:commands.configure.configure_product}{{4.2.1}{78}{commands.configure module}{section*.716}{}}
+\newlabel{apidoc_commands/commands:commands.configure.get_products_list}{{4.2.1}{78}{commands.configure module}{section*.717}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.environ module}{78}{subsubsection*.718}}
+\newlabel{apidoc_commands/commands:commands-environ-module}{{4.2.1}{78}{commands.environ module}{subsubsection*.718}{}}
+\newlabel{apidoc_commands/commands:module-commands.environ}{{4.2.1}{78}{commands.environ module}{subsubsection*.718}{}}
+\newlabel{apidoc_commands/commands:commands.environ.Command}{{4.2.1}{78}{commands.environ module}{section*.719}{}}
+\newlabel{apidoc_commands/commands:commands.environ.Command.getParser}{{4.2.1}{79}{commands.environ module}{section*.720}{}}
+\newlabel{apidoc_commands/commands:commands.environ.Command.name}{{4.2.1}{79}{commands.environ module}{section*.721}{}}
+\newlabel{apidoc_commands/commands:commands.environ.Command.run}{{4.2.1}{79}{commands.environ module}{section*.722}{}}
+\newlabel{apidoc_commands/commands:commands.environ.write_all_source_files}{{4.2.1}{79}{commands.environ module}{section*.723}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.find\_duplicates module}{79}{subsubsection*.724}}
+\newlabel{apidoc_commands/commands:module-commands.find_duplicates}{{4.2.1}{79}{commands.find\_duplicates module}{subsubsection*.724}{}}
+\newlabel{apidoc_commands/commands:commands-find-duplicates-module}{{4.2.1}{79}{commands.find\_duplicates module}{subsubsection*.724}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.Command}{{4.2.1}{79}{commands.find\_duplicates module}{section*.725}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.Command.getParser}{{4.2.1}{79}{commands.find\_duplicates module}{section*.726}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.Command.name}{{4.2.1}{79}{commands.find\_duplicates module}{section*.727}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.Command.run}{{4.2.1}{79}{commands.find\_duplicates module}{section*.728}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.Progress_bar}{{4.2.1}{79}{commands.find\_duplicates module}{section*.729}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.Progress_bar.display_value_progression}{{4.2.1}{79}{commands.find\_duplicates module}{section*.730}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.format_list_of_str}{{4.2.1}{79}{commands.find\_duplicates module}{section*.731}{}}
+\newlabel{apidoc_commands/commands:commands.find_duplicates.list_directory}{{4.2.1}{80}{commands.find\_duplicates module}{section*.732}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.generate module}{80}{subsubsection*.733}}
+\newlabel{apidoc_commands/commands:module-commands.generate}{{4.2.1}{80}{commands.generate module}{subsubsection*.733}{}}
+\newlabel{apidoc_commands/commands:commands-generate-module}{{4.2.1}{80}{commands.generate module}{subsubsection*.733}{}}
+\newlabel{apidoc_commands/commands:commands.generate.Command}{{4.2.1}{80}{commands.generate module}{section*.734}{}}
+\newlabel{apidoc_commands/commands:commands.generate.Command.getParser}{{4.2.1}{80}{commands.generate module}{section*.735}{}}
+\newlabel{apidoc_commands/commands:commands.generate.Command.name}{{4.2.1}{80}{commands.generate module}{section*.736}{}}
+\newlabel{apidoc_commands/commands:commands.generate.Command.run}{{4.2.1}{80}{commands.generate module}{section*.737}{}}
+\newlabel{apidoc_commands/commands:commands.generate.build_context}{{4.2.1}{80}{commands.generate module}{section*.738}{}}
+\newlabel{apidoc_commands/commands:commands.generate.check_module_generator}{{4.2.1}{80}{commands.generate module}{section*.739}{}}
+\newlabel{apidoc_commands/commands:commands.generate.check_yacsgen}{{4.2.1}{80}{commands.generate module}{section*.740}{}}
+\newlabel{apidoc_commands/commands:commands.generate.generate_component}{{4.2.1}{80}{commands.generate module}{section*.741}{}}
+\newlabel{apidoc_commands/commands:commands.generate.generate_component_list}{{4.2.1}{81}{commands.generate module}{section*.742}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.init module}{81}{subsubsection*.743}}
+\newlabel{apidoc_commands/commands:module-commands.init}{{4.2.1}{81}{commands.init module}{subsubsection*.743}{}}
+\newlabel{apidoc_commands/commands:commands-init-module}{{4.2.1}{81}{commands.init module}{subsubsection*.743}{}}
+\newlabel{apidoc_commands/commands:commands.init.Command}{{4.2.1}{81}{commands.init module}{section*.744}{}}
+\newlabel{apidoc_commands/commands:commands.init.Command.getParser}{{4.2.1}{81}{commands.init module}{section*.745}{}}
+\newlabel{apidoc_commands/commands:commands.init.Command.name}{{4.2.1}{81}{commands.init module}{section*.746}{}}
+\newlabel{apidoc_commands/commands:commands.init.Command.run}{{4.2.1}{81}{commands.init module}{section*.747}{}}
+\newlabel{apidoc_commands/commands:commands.init.check_path}{{4.2.1}{81}{commands.init module}{section*.748}{}}
+\newlabel{apidoc_commands/commands:commands.init.display_local_values}{{4.2.1}{81}{commands.init module}{section*.749}{}}
+\newlabel{apidoc_commands/commands:commands.init.set_local_value}{{4.2.1}{81}{commands.init module}{section*.750}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.job module}{81}{subsubsection*.751}}
+\newlabel{apidoc_commands/commands:commands-job-module}{{4.2.1}{81}{commands.job module}{subsubsection*.751}{}}
+\newlabel{apidoc_commands/commands:module-commands.job}{{4.2.1}{81}{commands.job module}{subsubsection*.751}{}}
+\newlabel{apidoc_commands/commands:commands.job.Command}{{4.2.1}{81}{commands.job module}{section*.752}{}}
+\newlabel{apidoc_commands/commands:commands.job.Command.getParser}{{4.2.1}{81}{commands.job module}{section*.753}{}}
+\newlabel{apidoc_commands/commands:commands.job.Command.name}{{4.2.1}{81}{commands.job module}{section*.754}{}}
+\newlabel{apidoc_commands/commands:commands.job.Command.run}{{4.2.1}{81}{commands.job module}{section*.755}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.jobs module}{82}{subsubsection*.756}}
+\newlabel{apidoc_commands/commands:commands-jobs-module}{{4.2.1}{82}{commands.jobs module}{subsubsection*.756}{}}
+\newlabel{apidoc_commands/commands:module-commands.jobs}{{4.2.1}{82}{commands.jobs module}{subsubsection*.756}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Command}{{4.2.1}{82}{commands.jobs module}{section*.757}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Command.getParser}{{4.2.1}{82}{commands.jobs module}{section*.758}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Command.name}{{4.2.1}{82}{commands.jobs module}{section*.759}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Command.run}{{4.2.1}{82}{commands.jobs module}{section*.760}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui}{{4.2.1}{82}{commands.jobs module}{section*.761}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.add_xml_board}{{4.2.1}{82}{commands.jobs module}{section*.762}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.find_history}{{4.2.1}{82}{commands.jobs module}{section*.763}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.find_test_log}{{4.2.1}{82}{commands.jobs module}{section*.764}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.initialize_boards}{{4.2.1}{82}{commands.jobs module}{section*.765}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.last_update}{{4.2.1}{82}{commands.jobs module}{section*.766}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.parse_csv_boards}{{4.2.1}{82}{commands.jobs module}{section*.767}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.put_jobs_not_today}{{4.2.1}{83}{commands.jobs module}{section*.768}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.update_xml_file}{{4.2.1}{83}{commands.jobs module}{section*.769}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.update_xml_files}{{4.2.1}{83}{commands.jobs module}{section*.770}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.write_xml_file}{{4.2.1}{83}{commands.jobs module}{section*.771}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Gui.write_xml_files}{{4.2.1}{83}{commands.jobs module}{section*.772}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job}{{4.2.1}{83}{commands.jobs module}{section*.773}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.cancel}{{4.2.1}{83}{commands.jobs module}{section*.774}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.check_time}{{4.2.1}{83}{commands.jobs module}{section*.775}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.get_log_files}{{4.2.1}{83}{commands.jobs module}{section*.776}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.get_pids}{{4.2.1}{83}{commands.jobs module}{section*.777}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.get_status}{{4.2.1}{83}{commands.jobs module}{section*.778}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.has_begun}{{4.2.1}{83}{commands.jobs module}{section*.779}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.has_failed}{{4.2.1}{83}{commands.jobs module}{section*.780}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.has_finished}{{4.2.1}{84}{commands.jobs module}{section*.781}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.is_running}{{4.2.1}{84}{commands.jobs module}{section*.782}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.is_timeout}{{4.2.1}{84}{commands.jobs module}{section*.783}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.kill_remote_process}{{4.2.1}{84}{commands.jobs module}{section*.784}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.run}{{4.2.1}{84}{commands.jobs module}{section*.785}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.time_elapsed}{{4.2.1}{84}{commands.jobs module}{section*.786}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.total_duration}{{4.2.1}{84}{commands.jobs module}{section*.787}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Job.write_results}{{4.2.1}{84}{commands.jobs module}{section*.788}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs}{{4.2.1}{84}{commands.jobs module}{section*.789}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.cancel_dependencies_of_failing_jobs}{{4.2.1}{84}{commands.jobs module}{section*.790}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.define_job}{{4.2.1}{84}{commands.jobs module}{section*.791}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.determine_jobs_and_machines}{{4.2.1}{84}{commands.jobs module}{section*.792}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.display_status}{{4.2.1}{84}{commands.jobs module}{section*.793}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.find_job_that_has_name}{{4.2.1}{85}{commands.jobs module}{section*.794}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.is_occupied}{{4.2.1}{85}{commands.jobs module}{section*.795}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.run_jobs}{{4.2.1}{85}{commands.jobs module}{section*.796}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.ssh_connection_all_machines}{{4.2.1}{85}{commands.jobs module}{section*.797}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.str_of_length}{{4.2.1}{85}{commands.jobs module}{section*.798}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.update_jobs_states_list}{{4.2.1}{85}{commands.jobs module}{section*.799}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Jobs.write_all_results}{{4.2.1}{85}{commands.jobs module}{section*.800}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine}{{4.2.1}{85}{commands.jobs module}{section*.801}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.close}{{4.2.1}{85}{commands.jobs module}{section*.802}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.connect}{{4.2.1}{85}{commands.jobs module}{section*.803}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.copy_sat}{{4.2.1}{85}{commands.jobs module}{section*.804}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.exec_command}{{4.2.1}{85}{commands.jobs module}{section*.805}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.mkdir}{{4.2.1}{86}{commands.jobs module}{section*.806}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.put_dir}{{4.2.1}{86}{commands.jobs module}{section*.807}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.successfully_connected}{{4.2.1}{86}{commands.jobs module}{section*.808}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.Machine.write_info}{{4.2.1}{86}{commands.jobs module}{section*.809}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.develop_factorized_jobs}{{4.2.1}{86}{commands.jobs module}{section*.810}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.getParamiko}{{4.2.1}{86}{commands.jobs module}{section*.811}{}}
+\newlabel{apidoc_commands/commands:commands.jobs.get_config_file_path}{{4.2.1}{86}{commands.jobs module}{section*.812}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.launcher module}{86}{subsubsection*.813}}
+\newlabel{apidoc_commands/commands:commands-launcher-module}{{4.2.1}{86}{commands.launcher module}{subsubsection*.813}{}}
+\newlabel{apidoc_commands/commands:module-commands.launcher}{{4.2.1}{86}{commands.launcher module}{subsubsection*.813}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.Command}{{4.2.1}{86}{commands.launcher module}{section*.814}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.Command.getParser}{{4.2.1}{86}{commands.launcher module}{section*.815}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.Command.name}{{4.2.1}{86}{commands.launcher module}{section*.816}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.Command.run}{{4.2.1}{86}{commands.launcher module}{section*.817}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.copy_catalog}{{4.2.1}{86}{commands.launcher module}{section*.818}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.generate_catalog}{{4.2.1}{87}{commands.launcher module}{section*.819}{}}
+\newlabel{apidoc_commands/commands:commands.launcher.generate_launch_file}{{4.2.1}{87}{commands.launcher module}{section*.820}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.log module}{87}{subsubsection*.821}}
+\newlabel{apidoc_commands/commands:commands-log-module}{{4.2.1}{87}{commands.log module}{subsubsection*.821}{}}
+\newlabel{apidoc_commands/commands:module-commands.log}{{4.2.1}{87}{commands.log module}{subsubsection*.821}{}}
+\newlabel{apidoc_commands/commands:commands.log.Command}{{4.2.1}{87}{commands.log module}{section*.822}{}}
+\newlabel{apidoc_commands/commands:commands.log.Command.getParser}{{4.2.1}{87}{commands.log module}{section*.823}{}}
+\newlabel{apidoc_commands/commands:commands.log.Command.name}{{4.2.1}{87}{commands.log module}{section*.824}{}}
+\newlabel{apidoc_commands/commands:commands.log.Command.run}{{4.2.1}{87}{commands.log module}{section*.825}{}}
+\newlabel{apidoc_commands/commands:commands.log.ask_value}{{4.2.1}{87}{commands.log module}{section*.826}{}}
+\newlabel{apidoc_commands/commands:commands.log.getMaxFormat}{{4.2.1}{87}{commands.log module}{section*.827}{}}
+\newlabel{apidoc_commands/commands:commands.log.get_last_log_file}{{4.2.1}{87}{commands.log module}{section*.828}{}}
+\newlabel{apidoc_commands/commands:commands.log.print_log_command_in_terminal}{{4.2.1}{88}{commands.log module}{section*.829}{}}
+\newlabel{apidoc_commands/commands:commands.log.remove_log_file}{{4.2.1}{88}{commands.log module}{section*.830}{}}
+\newlabel{apidoc_commands/commands:commands.log.show_last_logs}{{4.2.1}{88}{commands.log module}{section*.831}{}}
+\newlabel{apidoc_commands/commands:commands.log.show_product_last_logs}{{4.2.1}{88}{commands.log module}{section*.832}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.make module}{88}{subsubsection*.833}}
+\newlabel{apidoc_commands/commands:module-commands.make}{{4.2.1}{88}{commands.make module}{subsubsection*.833}{}}
+\newlabel{apidoc_commands/commands:commands-make-module}{{4.2.1}{88}{commands.make module}{subsubsection*.833}{}}
+\newlabel{apidoc_commands/commands:commands.make.Command}{{4.2.1}{88}{commands.make module}{section*.834}{}}
+\newlabel{apidoc_commands/commands:commands.make.Command.getParser}{{4.2.1}{88}{commands.make module}{section*.835}{}}
+\newlabel{apidoc_commands/commands:commands.make.Command.name}{{4.2.1}{88}{commands.make module}{section*.836}{}}
+\newlabel{apidoc_commands/commands:commands.make.Command.run}{{4.2.1}{88}{commands.make module}{section*.837}{}}
+\newlabel{apidoc_commands/commands:commands.make.get_nb_proc}{{4.2.1}{88}{commands.make module}{section*.838}{}}
+\newlabel{apidoc_commands/commands:commands.make.get_products_list}{{4.2.1}{88}{commands.make module}{section*.839}{}}
+\newlabel{apidoc_commands/commands:commands.make.make_all_products}{{4.2.1}{88}{commands.make module}{section*.840}{}}
+\newlabel{apidoc_commands/commands:commands.make.make_product}{{4.2.1}{89}{commands.make module}{section*.841}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.makeinstall module}{89}{subsubsection*.842}}
+\newlabel{apidoc_commands/commands:commands-makeinstall-module}{{4.2.1}{89}{commands.makeinstall module}{subsubsection*.842}{}}
+\newlabel{apidoc_commands/commands:module-commands.makeinstall}{{4.2.1}{89}{commands.makeinstall module}{subsubsection*.842}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.Command}{{4.2.1}{89}{commands.makeinstall module}{section*.843}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.Command.getParser}{{4.2.1}{89}{commands.makeinstall module}{section*.844}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.Command.name}{{4.2.1}{89}{commands.makeinstall module}{section*.845}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.Command.run}{{4.2.1}{89}{commands.makeinstall module}{section*.846}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.get_products_list}{{4.2.1}{89}{commands.makeinstall module}{section*.847}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.makeinstall_all_products}{{4.2.1}{89}{commands.makeinstall module}{section*.848}{}}
+\newlabel{apidoc_commands/commands:commands.makeinstall.makeinstall_product}{{4.2.1}{90}{commands.makeinstall module}{section*.849}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.package module}{90}{subsubsection*.850}}
+\newlabel{apidoc_commands/commands:commands-package-module}{{4.2.1}{90}{commands.package module}{subsubsection*.850}{}}
+\newlabel{apidoc_commands/commands:module-commands.package}{{4.2.1}{90}{commands.package module}{subsubsection*.850}{}}
+\newlabel{apidoc_commands/commands:commands.package.Command}{{4.2.1}{90}{commands.package module}{section*.851}{}}
+\newlabel{apidoc_commands/commands:commands.package.Command.getParser}{{4.2.1}{90}{commands.package module}{section*.852}{}}
+\newlabel{apidoc_commands/commands:commands.package.Command.name}{{4.2.1}{90}{commands.package module}{section*.853}{}}
+\newlabel{apidoc_commands/commands:commands.package.Command.run}{{4.2.1}{90}{commands.package module}{section*.854}{}}
+\newlabel{apidoc_commands/commands:commands.package.add_files}{{4.2.1}{90}{commands.package module}{section*.855}{}}
+\newlabel{apidoc_commands/commands:commands.package.add_readme}{{4.2.1}{90}{commands.package module}{section*.856}{}}
+\newlabel{apidoc_commands/commands:commands.package.add_salomeTools}{{4.2.1}{90}{commands.package module}{section*.857}{}}
+\newlabel{apidoc_commands/commands:commands.package.binary_package}{{4.2.1}{91}{commands.package module}{section*.858}{}}
+\newlabel{apidoc_commands/commands:commands.package.create_project_for_src_package}{{4.2.1}{91}{commands.package module}{section*.859}{}}
+\newlabel{apidoc_commands/commands:commands.package.exclude_VCS_and_extensions}{{4.2.1}{91}{commands.package module}{section*.860}{}}
+\newlabel{apidoc_commands/commands:commands.package.find_application_pyconf}{{4.2.1}{91}{commands.package module}{section*.861}{}}
+\newlabel{apidoc_commands/commands:commands.package.find_product_scripts_and_pyconf}{{4.2.1}{91}{commands.package module}{section*.862}{}}
+\newlabel{apidoc_commands/commands:commands.package.get_archives}{{4.2.1}{92}{commands.package module}{section*.863}{}}
+\newlabel{apidoc_commands/commands:commands.package.get_archives_vcs}{{4.2.1}{92}{commands.package module}{section*.864}{}}
+\newlabel{apidoc_commands/commands:commands.package.hack_for_distene_licence}{{4.2.1}{92}{commands.package module}{section*.865}{}}
+\newlabel{apidoc_commands/commands:commands.package.make_archive}{{4.2.1}{92}{commands.package module}{section*.866}{}}
+\newlabel{apidoc_commands/commands:commands.package.produce_install_bin_file}{{4.2.1}{93}{commands.package module}{section*.867}{}}
+\newlabel{apidoc_commands/commands:commands.package.produce_relative_env_files}{{4.2.1}{93}{commands.package module}{section*.868}{}}
+\newlabel{apidoc_commands/commands:commands.package.produce_relative_launcher}{{4.2.1}{93}{commands.package module}{section*.869}{}}
+\newlabel{apidoc_commands/commands:commands.package.product_appli_creation_script}{{4.2.1}{93}{commands.package module}{section*.870}{}}
+\newlabel{apidoc_commands/commands:commands.package.project_package}{{4.2.1}{93}{commands.package module}{section*.871}{}}
+\newlabel{apidoc_commands/commands:commands.package.source_package}{{4.2.1}{94}{commands.package module}{section*.872}{}}
+\newlabel{apidoc_commands/commands:commands.package.update_config}{{4.2.1}{94}{commands.package module}{section*.873}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.patch module}{94}{subsubsection*.874}}
+\newlabel{apidoc_commands/commands:module-commands.patch}{{4.2.1}{94}{commands.patch module}{subsubsection*.874}{}}
+\newlabel{apidoc_commands/commands:commands-patch-module}{{4.2.1}{94}{commands.patch module}{subsubsection*.874}{}}
+\newlabel{apidoc_commands/commands:commands.patch.Command}{{4.2.1}{94}{commands.patch module}{section*.875}{}}
+\newlabel{apidoc_commands/commands:commands.patch.Command.getParser}{{4.2.1}{94}{commands.patch module}{section*.876}{}}
+\newlabel{apidoc_commands/commands:commands.patch.Command.name}{{4.2.1}{94}{commands.patch module}{section*.877}{}}
+\newlabel{apidoc_commands/commands:commands.patch.Command.run}{{4.2.1}{94}{commands.patch module}{section*.878}{}}
+\newlabel{apidoc_commands/commands:commands.patch.apply_patch}{{4.2.1}{94}{commands.patch module}{section*.879}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.prepare module}{95}{subsubsection*.880}}
+\newlabel{apidoc_commands/commands:commands-prepare-module}{{4.2.1}{95}{commands.prepare module}{subsubsection*.880}{}}
+\newlabel{apidoc_commands/commands:module-commands.prepare}{{4.2.1}{95}{commands.prepare module}{subsubsection*.880}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.Command}{{4.2.1}{95}{commands.prepare module}{section*.881}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.Command.getParser}{{4.2.1}{95}{commands.prepare module}{section*.882}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.Command.name}{{4.2.1}{95}{commands.prepare module}{section*.883}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.Command.run}{{4.2.1}{95}{commands.prepare module}{section*.884}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.find_products_already_getted}{{4.2.1}{95}{commands.prepare module}{section*.885}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.find_products_with_patchs}{{4.2.1}{95}{commands.prepare module}{section*.886}{}}
+\newlabel{apidoc_commands/commands:commands.prepare.remove_products}{{4.2.1}{95}{commands.prepare module}{section*.887}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.profile module}{95}{subsubsection*.888}}
+\newlabel{apidoc_commands/commands:commands-profile-module}{{4.2.1}{95}{commands.profile module}{subsubsection*.888}{}}
+\newlabel{apidoc_commands/commands:module-commands.profile}{{4.2.1}{95}{commands.profile module}{subsubsection*.888}{}}
+\newlabel{apidoc_commands/commands:commands.profile.Command}{{4.2.1}{95}{commands.profile module}{section*.889}{}}
+\newlabel{apidoc_commands/commands:commands.profile.Command.getParser}{{4.2.1}{95}{commands.profile module}{section*.890}{}}
+\newlabel{apidoc_commands/commands:commands.profile.Command.name}{{4.2.1}{96}{commands.profile module}{section*.891}{}}
+\newlabel{apidoc_commands/commands:commands.profile.Command.run}{{4.2.1}{96}{commands.profile module}{section*.892}{}}
+\newlabel{apidoc_commands/commands:commands.profile.generate_profile_sources}{{4.2.1}{96}{commands.profile module}{section*.893}{}}
+\newlabel{apidoc_commands/commands:commands.profile.get_profile_name}{{4.2.1}{96}{commands.profile module}{section*.894}{}}
+\newlabel{apidoc_commands/commands:commands.profile.profileConfigReader}{{4.2.1}{96}{commands.profile module}{section*.895}{}}
+\newlabel{apidoc_commands/commands:commands.profile.profileConfigReader.parseMapping}{{4.2.1}{96}{commands.profile module}{section*.896}{}}
+\newlabel{apidoc_commands/commands:commands.profile.profileReference}{{4.2.1}{96}{commands.profile module}{section*.897}{}}
+\newlabel{apidoc_commands/commands:commands.profile.update_pyconf}{{4.2.1}{96}{commands.profile module}{section*.898}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.run module}{96}{subsubsection*.899}}
+\newlabel{apidoc_commands/commands:commands-run-module}{{4.2.1}{96}{commands.run module}{subsubsection*.899}{}}
+\newlabel{apidoc_commands/commands:module-commands.run}{{4.2.1}{96}{commands.run module}{subsubsection*.899}{}}
+\newlabel{apidoc_commands/commands:commands.run.Command}{{4.2.1}{96}{commands.run module}{section*.900}{}}
+\newlabel{apidoc_commands/commands:commands.run.Command.getParser}{{4.2.1}{96}{commands.run module}{section*.901}{}}
+\newlabel{apidoc_commands/commands:commands.run.Command.name}{{4.2.1}{96}{commands.run module}{section*.902}{}}
+\newlabel{apidoc_commands/commands:commands.run.Command.run}{{4.2.1}{96}{commands.run module}{section*.903}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.script module}{96}{subsubsection*.904}}
+\newlabel{apidoc_commands/commands:module-commands.script}{{4.2.1}{96}{commands.script module}{subsubsection*.904}{}}
+\newlabel{apidoc_commands/commands:commands-script-module}{{4.2.1}{96}{commands.script module}{subsubsection*.904}{}}
+\newlabel{apidoc_commands/commands:commands.script.Command}{{4.2.1}{96}{commands.script module}{section*.905}{}}
+\newlabel{apidoc_commands/commands:commands.script.Command.getParser}{{4.2.1}{96}{commands.script module}{section*.906}{}}
+\newlabel{apidoc_commands/commands:commands.script.Command.name}{{4.2.1}{97}{commands.script module}{section*.907}{}}
+\newlabel{apidoc_commands/commands:commands.script.Command.run}{{4.2.1}{97}{commands.script module}{section*.908}{}}
+\newlabel{apidoc_commands/commands:commands.script.get_products_list}{{4.2.1}{97}{commands.script module}{section*.909}{}}
+\newlabel{apidoc_commands/commands:commands.script.run_script_all_products}{{4.2.1}{97}{commands.script module}{section*.910}{}}
+\newlabel{apidoc_commands/commands:commands.script.run_script_of_product}{{4.2.1}{97}{commands.script module}{section*.911}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.shell module}{97}{subsubsection*.912}}
+\newlabel{apidoc_commands/commands:module-commands.shell}{{4.2.1}{97}{commands.shell module}{subsubsection*.912}{}}
+\newlabel{apidoc_commands/commands:commands-shell-module}{{4.2.1}{97}{commands.shell module}{subsubsection*.912}{}}
+\newlabel{apidoc_commands/commands:commands.shell.Command}{{4.2.1}{97}{commands.shell module}{section*.913}{}}
+\newlabel{apidoc_commands/commands:commands.shell.Command.getParser}{{4.2.1}{97}{commands.shell module}{section*.914}{}}
+\newlabel{apidoc_commands/commands:commands.shell.Command.name}{{4.2.1}{97}{commands.shell module}{section*.915}{}}
+\newlabel{apidoc_commands/commands:commands.shell.Command.run}{{4.2.1}{97}{commands.shell module}{section*.916}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.source module}{98}{subsubsection*.917}}
+\newlabel{apidoc_commands/commands:module-commands.source}{{4.2.1}{98}{commands.source module}{subsubsection*.917}{}}
+\newlabel{apidoc_commands/commands:commands-source-module}{{4.2.1}{98}{commands.source module}{subsubsection*.917}{}}
+\newlabel{apidoc_commands/commands:commands.source.Command}{{4.2.1}{98}{commands.source module}{section*.918}{}}
+\newlabel{apidoc_commands/commands:commands.source.Command.getParser}{{4.2.1}{98}{commands.source module}{section*.919}{}}
+\newlabel{apidoc_commands/commands:commands.source.Command.name}{{4.2.1}{98}{commands.source module}{section*.920}{}}
+\newlabel{apidoc_commands/commands:commands.source.Command.run}{{4.2.1}{98}{commands.source module}{section*.921}{}}
+\newlabel{apidoc_commands/commands:commands.source.check_sources}{{4.2.1}{98}{commands.source module}{section*.922}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_all_product_sources}{{4.2.1}{98}{commands.source module}{section*.923}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_product_sources}{{4.2.1}{98}{commands.source module}{section*.924}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_source_for_dev}{{4.2.1}{98}{commands.source module}{section*.925}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_source_from_archive}{{4.2.1}{99}{commands.source module}{section*.926}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_source_from_cvs}{{4.2.1}{99}{commands.source module}{section*.927}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_source_from_dir}{{4.2.1}{99}{commands.source module}{section*.928}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_source_from_git}{{4.2.1}{99}{commands.source module}{section*.929}{}}
+\newlabel{apidoc_commands/commands:commands.source.get_source_from_svn}{{4.2.1}{99}{commands.source module}{section*.930}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.template module}{100}{subsubsection*.931}}
+\newlabel{apidoc_commands/commands:module-commands.template}{{4.2.1}{100}{commands.template module}{subsubsection*.931}{}}
+\newlabel{apidoc_commands/commands:commands-template-module}{{4.2.1}{100}{commands.template module}{subsubsection*.931}{}}
+\newlabel{apidoc_commands/commands:commands.template.Command}{{4.2.1}{100}{commands.template module}{section*.932}{}}
+\newlabel{apidoc_commands/commands:commands.template.Command.getParser}{{4.2.1}{100}{commands.template module}{section*.933}{}}
+\newlabel{apidoc_commands/commands:commands.template.Command.name}{{4.2.1}{100}{commands.template module}{section*.934}{}}
+\newlabel{apidoc_commands/commands:commands.template.Command.run}{{4.2.1}{100}{commands.template module}{section*.935}{}}
+\newlabel{apidoc_commands/commands:commands.template.TParam}{{4.2.1}{100}{commands.template module}{section*.936}{}}
+\newlabel{apidoc_commands/commands:commands.template.TParam.check_value}{{4.2.1}{100}{commands.template module}{section*.937}{}}
+\newlabel{apidoc_commands/commands:commands.template.TemplateSettings}{{4.2.1}{100}{commands.template module}{section*.938}{}}
+\newlabel{apidoc_commands/commands:commands.template.TemplateSettings.check_file_for_substitution}{{4.2.1}{100}{commands.template module}{section*.939}{}}
+\newlabel{apidoc_commands/commands:commands.template.TemplateSettings.check_user_values}{{4.2.1}{100}{commands.template module}{section*.940}{}}
+\newlabel{apidoc_commands/commands:commands.template.TemplateSettings.get_parameters}{{4.2.1}{100}{commands.template module}{section*.941}{}}
+\newlabel{apidoc_commands/commands:commands.template.TemplateSettings.get_pyconf_parameters}{{4.2.1}{100}{commands.template module}{section*.942}{}}
+\newlabel{apidoc_commands/commands:commands.template.TemplateSettings.has_pyconf}{{4.2.1}{100}{commands.template module}{section*.943}{}}
+\newlabel{apidoc_commands/commands:commands.template.get_dico_param}{{4.2.1}{100}{commands.template module}{section*.944}{}}
+\newlabel{apidoc_commands/commands:commands.template.get_template_info}{{4.2.1}{100}{commands.template module}{section*.945}{}}
+\newlabel{apidoc_commands/commands:commands.template.prepare_from_template}{{4.2.1}{100}{commands.template module}{section*.946}{}}
+\newlabel{apidoc_commands/commands:commands.template.search_template}{{4.2.1}{100}{commands.template module}{section*.947}{}}
+\@writefile{toc}{\contentsline {subsubsection}{commands.test module}{101}{subsubsection*.948}}
+\newlabel{apidoc_commands/commands:commands-test-module}{{4.2.1}{101}{commands.test module}{subsubsection*.948}{}}
+\newlabel{apidoc_commands/commands:module-commands.test}{{4.2.1}{101}{commands.test module}{subsubsection*.948}{}}
+\newlabel{apidoc_commands/commands:commands.test.Command}{{4.2.1}{101}{commands.test module}{section*.949}{}}
+\newlabel{apidoc_commands/commands:commands.test.Command.check_option}{{4.2.1}{101}{commands.test module}{section*.950}{}}
+\newlabel{apidoc_commands/commands:commands.test.Command.getParser}{{4.2.1}{101}{commands.test module}{section*.951}{}}
+\newlabel{apidoc_commands/commands:commands.test.Command.name}{{4.2.1}{101}{commands.test module}{section*.952}{}}
+\newlabel{apidoc_commands/commands:commands.test.Command.run}{{4.2.1}{101}{commands.test module}{section*.953}{}}
+\newlabel{apidoc_commands/commands:commands.test.ask_a_path}{{4.2.1}{101}{commands.test module}{section*.954}{}}
+\newlabel{apidoc_commands/commands:commands.test.check_remote_machine}{{4.2.1}{101}{commands.test module}{section*.955}{}}
+\newlabel{apidoc_commands/commands:commands.test.create_test_report}{{4.2.1}{101}{commands.test module}{section*.956}{}}
+\newlabel{apidoc_commands/commands:commands.test.generate_history_xml_path}{{4.2.1}{101}{commands.test module}{section*.957}{}}
+\newlabel{apidoc_commands/commands:commands.test.move_test_results}{{4.2.1}{101}{commands.test module}{section*.958}{}}
+\newlabel{apidoc_commands/commands:commands.test.save_file}{{4.2.1}{101}{commands.test module}{section*.959}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Module contents}{101}{subsubsection*.960}}
+\newlabel{apidoc_commands/commands:module-commands}{{4.2.1}{101}{Module contents}{subsubsection*.960}{}}
+\newlabel{apidoc_commands/commands:module-contents}{{4.2.1}{101}{Module contents}{subsubsection*.960}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {5}Release Notes}{103}{chapter.5}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:release-notes}{{5}{103}{Release Notes}{chapter.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {5.1}Release notes}{103}{section.5.1}}
+\newlabel{release_notes/release_notes_5.0.0:release-notes}{{5.1}{103}{Release notes}{section.5.1}{}}
+\newlabel{release_notes/release_notes_5.0.0::doc}{{5.1}{103}{Release notes}{section.5.1}{}}
+\@writefile{toc}{\contentsline {chapter}{Python Module Index}{105}{section*.961}}
+\@writefile{toc}{\contentsline {chapter}{Index}{107}{section*.962}}
diff --git a/doc/build/latex/salomeTools.fdb_latexmk b/doc/build/latex/salomeTools.fdb_latexmk
new file mode 100644
index 0000000..da05d9c
--- /dev/null
+++ b/doc/build/latex/salomeTools.fdb_latexmk
@@ -0,0 +1,189 @@
+# Fdb version 3
+["makeindex salomeTools.idx"] 1525272290 "salomeTools.idx" "salomeTools.ind" "salomeTools" 1525272292
+  "salomeTools.idx" 1525272292 67526 981d26000ca6410ca47d784ab47abb11 ""
+  (generated)
+  "salomeTools.ind"
+  "salomeTools.ilg"
+["pdflatex"] 1525272291 "salomeTools.tex" "salomeTools.pdf" "salomeTools" 1525272292
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.enc" 1480098666 4850 80dc9bab7f31fb78a000ccfed0e27cab ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/map/fontname/texfonts.map" 1511824771 3332 103109f5612ad95229751940c61aada0 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8c.tfm" 1480098688 1268 8067e4f35cbae42c0f58b48da75bf496 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm" 1480098688 1292 3059476c50a24578715759f22652f3d0 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm" 1480098688 1384 87406e4336af44af883a035f17f319d9 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm" 1480098688 1268 8bd405dc5751cfed76cb6fb2db78cb50 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm" 1480098688 1292 bd42be2f344128bff6d35d98474adfe3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm" 1480098688 1384 4632f5e54900a7dadbb83f555bc61e56 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8c.tfm" 1480098688 1344 dab2eee300fafcab19064bcc62d66daa ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm" 1480098688 1544 4fb84cf2931ec523c2c6a08d939088ba ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm" 1480098688 1596 04a657f277f0401ba37d66e716627ac4 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm" 1480098688 4484 b828043cbd581d289d955903c1339981 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm" 1480098688 6628 34c39492c0adc454c1c199922bba8363 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm" 1480098688 4736 423eba67d4e9420ec9df4a8def143b08 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm" 1480098688 6880 fe6c7967f27585f6fa9876f3af14edd2 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8r.tfm" 1480098688 4712 9ef4d7d106579d4b136e1529e1a4533c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm" 1480098688 7040 b2bd27e2bfe6f6948cbc3239cae7444f ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8r.tfm" 1480098689 4524 6bce29db5bc272ba5f332261583fee9c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8t.tfm" 1480098689 6880 f19b8995b61c334d78fc734065f6b4d4 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8c.tfm" 1480098689 1352 fa28a7e6d323c65ce7d13d5342ff6be2 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm" 1480098689 4408 25b74d011a4c66b7f212c0cc3c90061b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm" 1480098689 6672 e3ab9e37e925f3045c9005e6d1473d56 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm" 1480098689 4640 532ca3305aad10cc01d769f3f91f1029 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8t.tfm" 1480098689 6944 94c55ad86e6ea2826f78ba2240d50df9 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm" 1480098696 3584 adb004a0c8e7c46ee66cad73671f37b4 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm" 1480098698 1004 54797486969f23fa377b128694d548df ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex8.tfm" 1480098698 988 bdf658c3bfc2d96d3c8b02cfc1c94c20 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm" 1480098698 916 f87d7c45f9c908e672703b83b72241a3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm" 1480098698 924 9904cf1d39e9767e7a3622f2a125a565 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm" 1480098698 928 2dc8d444221b7a635bb58038579b861a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm" 1480098698 908 2921f8a10601f252058503cc6570e581 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm" 1480098698 940 75ac932a52f80982a9f8ea75d03a34cf ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm" 1480098698 940 228d6584342e91276bf566bcf9716b83 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm" 1480098701 992 662f679a0b3d2d53c1b94050fdaa3f50 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm" 1480098701 1524 4414a8315f39513458b80dfc63bff03a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi6.tfm" 1480098701 1512 f21f83efb36853c0b70002322c1ab3ad ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi8.tfm" 1480098701 1520 eccf95517727cb11801f4f1aee3a21b4 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr12.tfm" 1480098701 1288 655e228510b4c2a1abe905c368440826 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr17.tfm" 1480098701 1292 296a67155bdbfc32aa9c636f21e91433 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr6.tfm" 1480098701 1300 b62933e007d01cfd073f79b963c01526 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr8.tfm" 1480098701 1292 21c1c5bfeaebccffdb478fd231a0997d ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm" 1480098701 1124 6c73e740cf17375f03eec0ee63599741 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy6.tfm" 1480098701 1116 933a60c408fc0a863a92debe84b2d294 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy8.tfm" 1480098701 1120 8b7d695260f3cff42e636090a8002094 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmmi5.pfb" 1480098733 37912 77d683123f92148345f3fc36a38d9ab1 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy5.pfb" 1480098733 32915 7bf7720c61a5b3a7ff25b0964421c9b6 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb" 1480098746 50493 4ed1f7e9eba8f1f3e1ec25195460190d ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrr8a.pfb" 1480098746 45758 19968a0990191524e34e1994d4a31cb6 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrro8a.pfb" 1480098746 44404 ea3d9c0311883914133975dd62a9185c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvb8a.pfb" 1480098746 35941 f27169cc74234d5bd5e4cca5abafaabb ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb" 1480098746 39013 b244066151b1e3e718f9b8e88a5ff23b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb" 1480098746 44648 23115b2a545ebfe2c526c3ca99db8b95 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb" 1480098746 44729 811d6c62865936705a31c797a1d5dada ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb" 1480098746 46026 6dab18b61c907687b520c72847215a68 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8a.pfb" 1480098746 45458 a3faba884469519614ca56ba5f6b1de1 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8c.vf" 1480098757 3560 cb6af2c6d0b5f763f3aae03f60590c57 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf" 1480098757 2184 5d20c8b00cd914e50251116c274e2d0b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf" 1480098757 3552 6a7911d0b338a7c32cbfc3a9e985ccca ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf" 1480098757 2184 8475af1b9cfa983db5f46f5ed4b8f9f7 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8c.vf" 1480098757 3560 a297982f0907d62e9886d9e2666bf30b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf" 1480098757 2280 d7cd083c724c9449e1d12731253966f7 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf" 1480098757 2340 0efed6a948c3c37d870e4e7ddb85c7c3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf" 1480098757 2344 88834f8322177295b0266ecc4b0754c3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvr8t.vf" 1480098757 2344 44ff28c9ef2fc97180cd884f900fee71 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmb8t.vf" 1480098758 2340 df9c920cc5688ebbf16a93f45ce7bdd3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf" 1480098758 3556 8a9a6dcbcd146ef985683f677f4758a6 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf" 1480098758 2348 91706c542228501c410c266421fbe30c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf" 1480098758 2328 6cd7df782b09b29cfc4d93e55b6b9a59 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii" 1480098806 71627 94eb9990bed73c364d7f53f960cc8c5b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf" 1496785618 7008 9ff5fdcc865b01beca2b0fe4a46231d4 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.def" 1518644053 67244 2dce3d67c354c8d92f638d0f8682fb73 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty" 1518644053 15861 065fe343082d0cd2428cf984d6b2ef66 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.def" 1518644053 12523 d80bc74bf5e02fe4304443a6de8d01be ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel.def" 1518644053 7434 1b3955075683beb1c883a0fcf92ed2d5 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty" 1480098815 1458 43ab4710dc82f3edeabecd0d099626b2 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty" 1480098815 7612 729a8cc22a1ee0029997c7f74717ae05 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty" 1480098815 8237 3b62ef1f7e2c23a328c814b3893bc11f ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty" 1517006633 185082 6c11d4e30ed78e2a12957b7e77030856 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty" 1480098815 70864 bcd5b216757bd619ae692a151d90085d ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty" 1480098815 7324 2310d1247db0114eb4726807c8837a0e ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty" 1490564930 1251 d170e11a3246c3392bc7f59595af42cb ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty" 1480098815 6797 90b7f83b0ad46826bc16058b1e3d48df ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty" 1480098815 8253 473e0e41f9adadb1977e8631b8f72ea6 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty" 1480098815 14040 ac8866aac45982ac84021584b0abb252 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty" 1480098815 18425 5b3c0c59d76fac78978b5558e83c1f36 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty" 1480098820 5949 3f3fd50a8cc94c3d4cbf4fc66cd3df1c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty" 1480098820 13829 94730e64147574077f8ecfea9bb69af4 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd" 1480098820 961 6518c6525a34feb5e8250ffa91731cff ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd" 1480098820 961 d02606146ba5601b5645f987c92e6193 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty" 1480098820 2210 5c54ab129b848a5071554186d0168766 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty" 1480098820 4160 c115536cf8d4ff25aa8c1c9bc4ecb79a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty" 1504905757 84352 897a476d96a0681047a5b0f91178a3d2 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty" 1480098820 4115 318a66090112f3aa3f415aeb6fe8540f ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty" 1480098820 2431 fe3078ec12fc30287f568596f8e0b948 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty" 1480098821 3140 977eaf314c97ac67b8675753fb15f67f ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty" 1492297155 4571 13977df0eda144b93597fc709035ad1f ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty" 1480098821 4732 d63eda807ac82cca2ca8488efd31a966 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty" 1480098821 1940 c559b92ca91f1b2a0e60d836d4973f41 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu" 1487721667 2004 ac51aeac484f08c01026120d62677eca ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu" 1487721667 3181 1cb3e9ad01f4a01127b2ffd821bfeec7 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls" 1480098821 22880 e7be6f7dd8c05d5108bf3a7d8cabe59a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo" 1480098821 8292 e897c12e1e886ce77fe26afc5d470886 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def" 1492297155 10006 a90ba4035cf778f32f424e297d92e235 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu" 1487721667 11255 9d97362866549d3d3c994b5f28d1b9b5 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty" 1492297155 16154 f2c73e20ca771d534a8516c62c6b0eae ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd" 1480098821 2217 d274654bda1292013bdf48d5f720a495 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def" 1480098821 7767 aa88823823f5e767d79ea1166ab1ae74 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu" 1487721667 4919 76510afd60e8282294f944c2f9f5103b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def" 1487721667 7784 325a2a09984cb5c4ff230f9867145ad3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty" 1480098823 1311 063f8536a047a2d9cb1803321f793f37 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty" 1480098823 1096 6a75275ca00e32428c6f059d2f618ea7 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty" 1480098825 2883 427a7f7cb58418a0394dbd85c80668f6 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap" 1480098825 1207 4e0d96772f0d338847cbfb4eca683c81 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap" 1480098825 1938 beaa4a8467aa0074076e0e19f2992e29 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty" 1498861448 10663 d7fcc0dc4f35e8998b8cfeef8407d37d ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty" 1480098827 45360 a0833d32f1b541964596b02870342d5a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty" 1480098828 6749 16d2656a1984957e674b149555f1ea1d ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty" 1480098828 19488 fdd52eb173b3197d748e1ec25acb042f ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty" 1480098829 22449 7ec15c16d0d66790f28e90343c5434a3 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty" 1480098829 40502 e003406220954b0716679d7928aedd8a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg" 1480098830 1213 620bba36b25224fa9b7e1ccb4ecb76fd ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg" 1480098830 1224 978390e9c2234eab29404bc21b268d1e ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def" 1515537368 17334 520b9b85ad8a2a48eda3f643e27a5179 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty" 1498427532 15275 7d676729b1bedd3e7f3c6717affb366c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty" 1498427532 9066 649f2ccf62888e3d8c3e57256b70b8e1 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty" 1480098830 2594 d18d5e19aa8239cf867fa670c556d2e9 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty" 1480098830 3980 0a268fbfda01e381fa95821ab13b6aee ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def" 1518041854 51699 9069fc983fff0db91d59a15af144ad62 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty" 1518041854 234088 2c849389d62d41c593d9f5176c4116ab ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty" 1480098831 12949 81e4e808884a8f0e276b69410e234656 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def" 1518041854 14098 4e70bf396c7c265bd8b0e5cab3fd3d4d ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def" 1518041854 122411 10b605a58a28bbe5d61db37da4a85beb ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg" 1480098833 678 4792914a8f45be57bb98413425e4c7af ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg" 1480098833 235 6031e5765137be07eed51a510b2b8fb7 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap" 1480098835 1866 c1c12138091b4a8edd4a24a940e6f792 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap" 1480098835 2370 3b1f71b14b974f07cef532db09ae9ee0 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap" 1480098835 3001 252c8ca42b06a22cb1a11c0e47790c6e ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty" 1480098835 852 0e34dbb72efc69fa07602405ad95585e ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty" 1480098836 3834 4363110eb0ef1eb2b71c8fcbcdb6c357 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty" 1480098836 12095 5337833c991d80788a43d3ce26bd1c46 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty" 1480098836 7075 2fe3d848bba95f139de11ded085e74aa ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty" 1480098836 3720 63669daeb0b67d5fbec899824e2f1491 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty" 1480098836 22417 1d9df1eb66848aa31b18a593099cf45c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty" 1480098836 9581 023642318cef9f4677efe364de1e2a27 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty" 1480098836 2763 02a40cc5a32805c41d919cfbdba7e99a ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd" 1480098837 798 d5895e9edc628f2be019beb2c0ec66df ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd" 1480098837 1488 9a55ac1cde6b4798a7f56844bb75a553 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd" 1480098837 774 61d7da1e9f9e74989b196d147e623736 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty" 1480098837 857 6c716f26c5eadfb81029fcd6ce2d45e6 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd" 1480098837 643 92c451bb86386a4e36a174603ddb5a13 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd" 1480098837 619 96f56dc5d1ef1fe1121f1cfeec70ee0c ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty" 1480098840 13791 8c83287d79183c3bf58fd70871e8a70b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty" 1480098841 37387 afa86533e532701faf233f3f592c61e0 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty" 1485129666 12396 d41f82b039f900e95f351e54ae740f31 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty" 1480098841 12083 80916157594a8e4354985aaefae4f367 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty" 1480098842 1048 517e01cde97c1c0baf72e69d43aa5a2e ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty" 1480098842 12796 8edb7d69a20b857904dd0ea757c14ec9 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty" 1480098842 10894 d359a13923460b2a73d4312d613554c8 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty" 1480098843 26220 3701aebf80ccdef248c0c20dd062fea9 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty" 1480098843 55589 34128738f682d033422ca125f82e5d62 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/web2c/texmf.cnf" 1518824182 33095 db9a077a3f94a5d0b580d566a7906714 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdftex.map" 1523607852 2700841 1bc9624fdc91e264bac08ef05942a34b ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf-var/web2c/pdftex/pdflatex.fmt" 1523607929 4139413 5fd665779d626eb6c28594ed7061af12 ""
+  "/data/tmplgls/wambeke/share/texlive/2017/texmf.cnf" 1523607755 455 5b996dcaa0eb4ef14a83b026bc0a008c ""
+  "footnotehyper-sphinx.sty" 1524638079 8886 0562fcad2b7e25f93331edc6fc422c87 ""
+  "salomeTools.aux" 1525272292 141654 9d5282900e038ab98dbacbd961889937 ""
+  "salomeTools.ind" 1525272291 65531 74fdfe89bcc9bb28b4a5e2acf7d3b7d6 "makeindex salomeTools.idx"
+  "salomeTools.out" 1525272292 3056 4c35215e7f972531b516bb25065a7d97 ""
+  "salomeTools.tex" 1525272287 550138 31cf1ada84a993cbf1d300e29f491cd9 ""
+  "salomeTools.toc" 1525272292 11505 a4da4ca58d96857863b52eed2aead3fb ""
+  "sat_about.png" 1524487606 282130 625d3edc0de2910af30fe6407ab411b3 ""
+  "sphinx.sty" 1524638079 67712 9b578972569f0169bf44cfae88da82f2 ""
+  "sphinxhighlight.sty" 1525272286 8137 b8d4ef963833564f6e4eadc09cd757c4 ""
+  "sphinxmanual.cls" 1524638079 3589 0b0aac49c6f36925cf5f9d524a75a978 ""
+  "sphinxmulticell.sty" 1524638079 14618 0defbdc8536ad2e67f1eac6a1431bc55 ""
+  (generated)
+  "salomeTools.out"
+  "salomeTools.aux"
+  "salomeTools.idx"
+  "salomeTools.log"
+  "salomeTools.toc"
+  "salomeTools.pdf"
diff --git a/doc/build/latex/salomeTools.fls b/doc/build/latex/salomeTools.fls
new file mode 100644
index 0000000..80919d4
--- /dev/null
+++ b/doc/build/latex/salomeTools.fls
@@ -0,0 +1,346 @@
+PWD /volatile/wambeke/SAT5/SAT5_S840_MATIX24/sat5.1/doc/build/latex
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf.cnf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/web2c/texmf.cnf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-var/web2c/pdftex/pdflatex.fmt
+INPUT salomeTools.tex
+OUTPUT salomeTools.log
+INPUT sphinxmanual.cls
+INPUT sphinxmanual.cls
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/report.cls
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/size10.clo
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/inputenc.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/utf8.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ot1enc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/omsenc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/cmap.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/fontenc.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/t1enc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/map/fontname/texfonts.map
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap
+OUTPUT salomeTools.pdf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/t1.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsmath.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amstext.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsgen.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsbsy.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsmath/amsopn.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amssymb.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/amsfonts.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/switch.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel-english/english.ldf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/babel.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/babel/txtbabel.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/times.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fncychap/fncychap.sty
+INPUT sphinx.sty
+INPUT sphinx.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ltxcmds.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphicx.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/keyval.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/graphics.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics/trig.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/graphics.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-def/pdftex.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/textcomp.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1enc.dfu
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/titlesec/titlesec.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tabulary/tabulary.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/array.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/tools/longtable.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/varwidth/varwidth.sty
+INPUT sphinxmulticell.sty
+INPUT sphinxmulticell.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/makeidx.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/framed/framed.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/xcolor/xcolor.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/graphics-cfg/color.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty
+INPUT footnotehyper-sphinx.sty
+INPUT footnotehyper-sphinx.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/float/float.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/wrapfig/wrapfig.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/parskip/parskip.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/alltt.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/upquote/upquote.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/capt-of/capt-of.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/needspace/needspace.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/carlisle/remreset.sty
+INPUT sphinxhighlight.sty
+INPUT sphinxhighlight.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/kvoptions.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/infwarerr.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/etexcmds.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifluatex.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/geometry/geometry.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifpdf.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/ifvtex.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/ifxetex/ifxetex.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hyperref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/auxhook.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/pd1enc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/hyperref.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/puenc.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/url/url.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/hpdftex.def
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/hypcap.sty
+OUTPUT salomeTools.idx
+INPUT salomeTools.aux
+INPUT salomeTools.aux
+OUTPUT salomeTools.aux
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/base/ts1cmr.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1ptm.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/context/base/mkii/supp-pdf.mkii
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/oberdiek/grfext.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/hyperref/nameref.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/generic/oberdiek/gettitlestring.sty
+INPUT salomeTools.out
+INPUT salomeTools.out
+INPUT salomeTools.out
+INPUT salomeTools.out
+INPUT ./salomeTools.out
+INPUT ./salomeTools.out
+OUTPUT salomeTools.out
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1phv.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr17.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/cmap/ot1.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr12.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oml.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi12.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/oms.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/mmap/omx.cmap
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmex10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsa.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/amsfonts/umsb.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-var/fonts/map/pdftex/updmap/pdftex.map
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8t.tfm
+INPUT salomeTools.toc
+INPUT salomeTools.toc
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm
+OUTPUT salomeTools.toc
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvb8r.tfm
+INPUT sat_about.png
+INPUT ./sat_about.png
+INPUT ./sat_about.png
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/t1pcr.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
+INPUT sat_about.png
+INPUT ./sat_about.png
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr8.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmr6.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi8.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmmi6.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy8.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/cm/cmsy6.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex8.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm10.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1ptm.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmr8c.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmri8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/times/ptmri8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/times/ptmr8c.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/tex/latex/psnfss/ts1pcr.fd
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8c.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvbo8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvbo8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8c.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrr8c.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrr8c.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8t.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrro8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrro8r.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/courier/pcrb8c.tfm
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/courier/pcrb8c.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/vf/adobe/helvetic/phvr8t.vf
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/tfm/adobe/helvetic/phvr8r.tfm
+INPUT salomeTools.ind
+INPUT salomeTools.ind
+INPUT salomeTools.aux
+INPUT ./salomeTools.out
+INPUT ./salomeTools.out
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/enc/dvips/base/8r.enc
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmmi5.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/public/amsfonts/cm/cmsy5.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrr8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/courier/ucrro8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvb8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/helvetic/uhvr8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmb8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmr8a.pfb
+INPUT /data/tmplgls/wambeke/share/texlive/2017/texmf-dist/fonts/type1/urw/times/utmri8a.pfb
diff --git a/doc/build/latex/salomeTools.idx b/doc/build/latex/salomeTools.idx
new file mode 100644
index 0000000..8fa217a
--- /dev/null
+++ b/doc/build/latex/salomeTools.idx
@@ -0,0 +1,938 @@
+\indexentry{src.colorama.ansi (module)|hyperpage}{29}
+\indexentry{AnsiBack (class in src.colorama.ansi)|hyperpage}{29}
+\indexentry{BLACK (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{BLUE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{CYAN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{GREEN (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{MAGENTA (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{RED (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{RESET (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{WHITE (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{YELLOW (src.colorama.ansi.AnsiBack attribute)|hyperpage}{29}
+\indexentry{AnsiCodes (class in src.colorama.ansi)|hyperpage}{29}
+\indexentry{AnsiCursor (class in src.colorama.ansi)|hyperpage}{30}
+\indexentry{BACK() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{DOWN() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{FORWARD() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{POS() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{UP() (src.colorama.ansi.AnsiCursor method)|hyperpage}{30}
+\indexentry{AnsiFore (class in src.colorama.ansi)|hyperpage}{30}
+\indexentry{BLACK (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{BLUE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{CYAN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{GREEN (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{MAGENTA (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{RED (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{RESET (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{WHITE (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{YELLOW (src.colorama.ansi.AnsiFore attribute)|hyperpage}{30}
+\indexentry{AnsiStyle (class in src.colorama.ansi)|hyperpage}{30}
+\indexentry{BRIGHT (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{DIM (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{NORMAL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)|hyperpage}{30}
+\indexentry{clear\_line() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{clear\_screen() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{code\_to\_chars() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{set\_title() (in module src.colorama.ansi)|hyperpage}{30}
+\indexentry{src.colorama.ansitowin32 (module)|hyperpage}{31}
+\indexentry{AnsiToWin32 (class in src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{31}
+\indexentry{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)|hyperpage}{31}
+\indexentry{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{write() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)|hyperpage}{31}
+\indexentry{StreamWrapper (class in src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{write() (src.colorama.ansitowin32.StreamWrapper method)|hyperpage}{31}
+\indexentry{is\_a\_tty() (in module src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{is\_stream\_closed() (in module src.colorama.ansitowin32)|hyperpage}{31}
+\indexentry{src.colorama.initialise (module)|hyperpage}{31}
+\indexentry{colorama\_text() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{deinit() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{init() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{reinit() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{reset\_all() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{wrap\_stream() (in module src.colorama.initialise)|hyperpage}{31}
+\indexentry{src.colorama.win32 (module)|hyperpage}{32}
+\indexentry{SetConsoleTextAttribute() (in module src.colorama.win32)|hyperpage}{32}
+\indexentry{winapi\_test() (in module src.colorama.win32)|hyperpage}{32}
+\indexentry{src.colorama.winterm (module)|hyperpage}{32}
+\indexentry{WinColor (class in src.colorama.winterm)|hyperpage}{32}
+\indexentry{BLACK (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{BLUE (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{CYAN (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{GREEN (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{GREY (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{MAGENTA (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{RED (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{YELLOW (src.colorama.winterm.WinColor attribute)|hyperpage}{32}
+\indexentry{WinStyle (class in src.colorama.winterm)|hyperpage}{32}
+\indexentry{BRIGHT (src.colorama.winterm.WinStyle attribute)|hyperpage}{32}
+\indexentry{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)|hyperpage}{32}
+\indexentry{NORMAL (src.colorama.winterm.WinStyle attribute)|hyperpage}{32}
+\indexentry{WinTerm (class in src.colorama.winterm)|hyperpage}{32}
+\indexentry{back() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{cursor\_adjust() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{erase\_line() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{erase\_screen() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{fore() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{get\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{get\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{reset\_all() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_attrs() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_console() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_cursor\_position() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{set\_title() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{style() (src.colorama.winterm.WinTerm method)|hyperpage}{32}
+\indexentry{src.colorama (module)|hyperpage}{33}
+\indexentry{src.example.essai\_logging\_1 (module)|hyperpage}{33}
+\indexentry{getMyLogger() (in module src.example.essai\_logging\_1)|hyperpage}{33}
+\indexentry{initMyLogger() (in module src.example.essai\_logging\_1)|hyperpage}{33}
+\indexentry{testLogger1() (in module src.example.essai\_logging\_1)|hyperpage}{33}
+\indexentry{src.example.essai\_logging\_2 (module)|hyperpage}{33}
+\indexentry{MyFormatter (class in src.example.essai\_logging\_2)|hyperpage}{33}
+\indexentry{format() (src.example.essai\_logging\_2.MyFormatter method)|hyperpage}{33}
+\indexentry{getMyLogger() (in module src.example.essai\_logging\_2)|hyperpage}{33}
+\indexentry{initMyLogger() (in module src.example.essai\_logging\_2)|hyperpage}{33}
+\indexentry{testLogger1() (in module src.example.essai\_logging\_2)|hyperpage}{33}
+\indexentry{src.example (module)|hyperpage}{34}
+\indexentry{src.ElementTree (module)|hyperpage}{34}
+\indexentry{Comment() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{dump() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{Element() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{ElementTree (class in src.ElementTree)|hyperpage}{34}
+\indexentry{find() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{findall() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{findtext() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{getiterator() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{getroot() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{parse() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{write() (src.ElementTree.ElementTree method)|hyperpage}{34}
+\indexentry{fromstring() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{iselement() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{iterparse (class in src.ElementTree)|hyperpage}{34}
+\indexentry{next() (src.ElementTree.iterparse method)|hyperpage}{34}
+\indexentry{parse() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{PI() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{ProcessingInstruction() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{QName (class in src.ElementTree)|hyperpage}{34}
+\indexentry{SubElement() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{tostring() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{TreeBuilder (class in src.ElementTree)|hyperpage}{34}
+\indexentry{close() (src.ElementTree.TreeBuilder method)|hyperpage}{34}
+\indexentry{data() (src.ElementTree.TreeBuilder method)|hyperpage}{34}
+\indexentry{end() (src.ElementTree.TreeBuilder method)|hyperpage}{34}
+\indexentry{start() (src.ElementTree.TreeBuilder method)|hyperpage}{34}
+\indexentry{XML() (in module src.ElementTree)|hyperpage}{34}
+\indexentry{XMLTreeBuilder (class in src.ElementTree)|hyperpage}{34}
+\indexentry{close() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{34}
+\indexentry{doctype() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{34}
+\indexentry{feed() (src.ElementTree.XMLTreeBuilder method)|hyperpage}{34}
+\indexentry{src.architecture (module)|hyperpage}{35}
+\indexentry{get\_distrib\_version() (in module src.architecture)|hyperpage}{35}
+\indexentry{get\_distribution() (in module src.architecture)|hyperpage}{35}
+\indexentry{get\_nb\_proc() (in module src.architecture)|hyperpage}{35}
+\indexentry{get\_python\_version() (in module src.architecture)|hyperpage}{35}
+\indexentry{get\_user() (in module src.architecture)|hyperpage}{35}
+\indexentry{is\_windows() (in module src.architecture)|hyperpage}{35}
+\indexentry{src.catchAll (module)|hyperpage}{35}
+\indexentry{CatchAll (class in src.catchAll)|hyperpage}{35}
+\indexentry{jsonDumps() (src.catchAll.CatchAll method)|hyperpage}{35}
+\indexentry{dumper() (in module src.catchAll)|hyperpage}{35}
+\indexentry{dumperType() (in module src.catchAll)|hyperpage}{36}
+\indexentry{jsonDumps() (in module src.catchAll)|hyperpage}{36}
+\indexentry{src.coloringSat (module)|hyperpage}{36}
+\indexentry{ColoringStream (class in src.coloringSat)|hyperpage}{36}
+\indexentry{flush() (src.coloringSat.ColoringStream method)|hyperpage}{36}
+\indexentry{write() (src.coloringSat.ColoringStream method)|hyperpage}{36}
+\indexentry{cleanColors() (in module src.coloringSat)|hyperpage}{36}
+\indexentry{indent() (in module src.coloringSat)|hyperpage}{36}
+\indexentry{log() (in module src.coloringSat)|hyperpage}{36}
+\indexentry{replace() (in module src.coloringSat)|hyperpage}{36}
+\indexentry{toColor() (in module src.coloringSat)|hyperpage}{36}
+\indexentry{toColor\_AnsiToWin32() (in module src.coloringSat)|hyperpage}{36}
+\indexentry{src.compilation (module)|hyperpage}{36}
+\indexentry{Builder (class in src.compilation)|hyperpage}{36}
+\indexentry{build\_configure() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{check() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{cmake() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{complete\_environment() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{configure() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{do\_batch\_script\_build() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{do\_default\_build() (src.compilation.Builder method)|hyperpage}{36}
+\indexentry{do\_python\_script\_build() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{do\_script\_build() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{hack\_libtool() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{install() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{log() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{log\_command() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{make() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{prepare() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{wmake() (src.compilation.Builder method)|hyperpage}{37}
+\indexentry{src.configManager (module)|hyperpage}{37}
+\indexentry{ConfigManager (class in src.configManager)|hyperpage}{37}
+\indexentry{create\_config\_file() (src.configManager.ConfigManager method)|hyperpage}{37}
+\indexentry{get\_command\_line\_overrides() (src.configManager.ConfigManager method)|hyperpage}{37}
+\indexentry{get\_config() (src.configManager.ConfigManager method)|hyperpage}{37}
+\indexentry{get\_user\_config\_file() (src.configManager.ConfigManager method)|hyperpage}{37}
+\indexentry{set\_user\_config\_file() (src.configManager.ConfigManager method)|hyperpage}{38}
+\indexentry{ConfigOpener (class in src.configManager)|hyperpage}{38}
+\indexentry{get\_path() (src.configManager.ConfigOpener method)|hyperpage}{38}
+\indexentry{check\_path() (in module src.configManager)|hyperpage}{38}
+\indexentry{getConfigColored() (in module src.configManager)|hyperpage}{38}
+\indexentry{get\_config\_children() (in module src.configManager)|hyperpage}{38}
+\indexentry{get\_products\_list() (in module src.configManager)|hyperpage}{38}
+\indexentry{print\_debug() (in module src.configManager)|hyperpage}{38}
+\indexentry{print\_value() (in module src.configManager)|hyperpage}{38}
+\indexentry{show\_patchs() (in module src.configManager)|hyperpage}{39}
+\indexentry{show\_product\_info() (in module src.configManager)|hyperpage}{39}
+\indexentry{src.debug (module)|hyperpage}{39}
+\indexentry{InStream (class in src.debug)|hyperpage}{39}
+\indexentry{OutStream (class in src.debug)|hyperpage}{39}
+\indexentry{close() (src.debug.OutStream method)|hyperpage}{39}
+\indexentry{format\_color\_exception() (in module src.debug)|hyperpage}{39}
+\indexentry{getLocalEnv() (in module src.debug)|hyperpage}{39}
+\indexentry{getStrConfigDbg() (in module src.debug)|hyperpage}{39}
+\indexentry{getStrConfigStd() (in module src.debug)|hyperpage}{39}
+\indexentry{indent() (in module src.debug)|hyperpage}{39}
+\indexentry{isTypeConfig() (in module src.debug)|hyperpage}{39}
+\indexentry{pop\_debug() (in module src.debug)|hyperpage}{39}
+\indexentry{push\_debug() (in module src.debug)|hyperpage}{40}
+\indexentry{saveConfigDbg() (in module src.debug)|hyperpage}{40}
+\indexentry{saveConfigStd() (in module src.debug)|hyperpage}{40}
+\indexentry{tofix() (in module src.debug)|hyperpage}{40}
+\indexentry{write() (in module src.debug)|hyperpage}{40}
+\indexentry{src.environment (module)|hyperpage}{40}
+\indexentry{Environ (class in src.environment)|hyperpage}{40}
+\indexentry{append() (src.environment.Environ method)|hyperpage}{40}
+\indexentry{append\_value() (src.environment.Environ method)|hyperpage}{40}
+\indexentry{command\_value() (src.environment.Environ method)|hyperpage}{40}
+\indexentry{get() (src.environment.Environ method)|hyperpage}{40}
+\indexentry{is\_defined() (src.environment.Environ method)|hyperpage}{40}
+\indexentry{prepend() (src.environment.Environ method)|hyperpage}{40}
+\indexentry{prepend\_value() (src.environment.Environ method)|hyperpage}{41}
+\indexentry{set() (src.environment.Environ method)|hyperpage}{41}
+\indexentry{FileEnvWriter (class in src.environment)|hyperpage}{41}
+\indexentry{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)|hyperpage}{41}
+\indexentry{write\_env\_file() (src.environment.FileEnvWriter method)|hyperpage}{41}
+\indexentry{SalomeEnviron (class in src.environment)|hyperpage}{41}
+\indexentry{add\_comment() (src.environment.SalomeEnviron method)|hyperpage}{41}
+\indexentry{add\_line() (src.environment.SalomeEnviron method)|hyperpage}{41}
+\indexentry{add\_warning() (src.environment.SalomeEnviron method)|hyperpage}{41}
+\indexentry{append() (src.environment.SalomeEnviron method)|hyperpage}{41}
+\indexentry{dump() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{finish() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{get() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{get\_names() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{is\_defined() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{load\_cfg\_environment() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{prepend() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{run\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{run\_simple\_env\_script() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{set() (src.environment.SalomeEnviron method)|hyperpage}{42}
+\indexentry{set\_a\_product() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_application\_env() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_cpp\_env() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_full\_environ() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_products() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_python\_libdirs() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)|hyperpage}{43}
+\indexentry{Shell (class in src.environment)|hyperpage}{43}
+\indexentry{load\_environment() (in module src.environment)|hyperpage}{43}
+\indexentry{src.environs (module)|hyperpage}{44}
+\indexentry{print\_grep\_environs() (in module src.environs)|hyperpage}{44}
+\indexentry{print\_split\_environs() (in module src.environs)|hyperpage}{44}
+\indexentry{print\_split\_pattern\_environs() (in module src.environs)|hyperpage}{44}
+\indexentry{src.exceptionSat (module)|hyperpage}{44}
+\indexentry{ExceptionSat|hyperpage}{44}
+\indexentry{src.fileEnviron (module)|hyperpage}{44}
+\indexentry{BashFileEnviron (class in src.fileEnviron)|hyperpage}{44}
+\indexentry{command\_value() (src.fileEnviron.BashFileEnviron method)|hyperpage}{44}
+\indexentry{finish() (src.fileEnviron.BashFileEnviron method)|hyperpage}{44}
+\indexentry{set() (src.fileEnviron.BashFileEnviron method)|hyperpage}{44}
+\indexentry{BatFileEnviron (class in src.fileEnviron)|hyperpage}{44}
+\indexentry{add\_comment() (src.fileEnviron.BatFileEnviron method)|hyperpage}{45}
+\indexentry{command\_value() (src.fileEnviron.BatFileEnviron method)|hyperpage}{45}
+\indexentry{finish() (src.fileEnviron.BatFileEnviron method)|hyperpage}{45}
+\indexentry{get() (src.fileEnviron.BatFileEnviron method)|hyperpage}{45}
+\indexentry{set() (src.fileEnviron.BatFileEnviron method)|hyperpage}{45}
+\indexentry{ContextFileEnviron (class in src.fileEnviron)|hyperpage}{45}
+\indexentry{add\_echo() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{45}
+\indexentry{add\_warning() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{45}
+\indexentry{append\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{45}
+\indexentry{command\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{45}
+\indexentry{finish() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{46}
+\indexentry{get() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{46}
+\indexentry{prepend\_value() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{46}
+\indexentry{set() (src.fileEnviron.ContextFileEnviron method)|hyperpage}{46}
+\indexentry{FileEnviron (class in src.fileEnviron)|hyperpage}{46}
+\indexentry{add\_comment() (src.fileEnviron.FileEnviron method)|hyperpage}{46}
+\indexentry{add\_echo() (src.fileEnviron.FileEnviron method)|hyperpage}{46}
+\indexentry{add\_line() (src.fileEnviron.FileEnviron method)|hyperpage}{46}
+\indexentry{add\_warning() (src.fileEnviron.FileEnviron method)|hyperpage}{46}
+\indexentry{append() (src.fileEnviron.FileEnviron method)|hyperpage}{46}
+\indexentry{append\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{46}
+\indexentry{command\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{finish() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{get() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{is\_defined() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{prepend() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{prepend\_value() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{set() (src.fileEnviron.FileEnviron method)|hyperpage}{47}
+\indexentry{LauncherFileEnviron (class in src.fileEnviron)|hyperpage}{47}
+\indexentry{add() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{47}
+\indexentry{add\_comment() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{47}
+\indexentry{add\_echo() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{47}
+\indexentry{add\_line() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{add\_warning() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{append() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{append\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{command\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{finish() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{get() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{is\_defined() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{prepend() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{48}
+\indexentry{set() (src.fileEnviron.LauncherFileEnviron method)|hyperpage}{49}
+\indexentry{ScreenEnviron (class in src.fileEnviron)|hyperpage}{49}
+\indexentry{add\_comment() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{add\_echo() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{add\_line() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{add\_warning() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{append() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{command\_value() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{get() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{is\_defined() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{prepend() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{run\_env\_script() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{set() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{write() (src.fileEnviron.ScreenEnviron method)|hyperpage}{49}
+\indexentry{get\_file\_environ() (in module src.fileEnviron)|hyperpage}{49}
+\indexentry{special\_path\_separator() (in module src.fileEnviron)|hyperpage}{49}
+\indexentry{src.fork (module)|hyperpage}{49}
+\indexentry{batch() (in module src.fork)|hyperpage}{49}
+\indexentry{batch\_salome() (in module src.fork)|hyperpage}{49}
+\indexentry{launch\_command() (in module src.fork)|hyperpage}{49}
+\indexentry{show\_progress() (in module src.fork)|hyperpage}{50}
+\indexentry{write\_back() (in module src.fork)|hyperpage}{50}
+\indexentry{src.loggingSat (module)|hyperpage}{50}
+\indexentry{DefaultFormatter (class in src.loggingSat)|hyperpage}{50}
+\indexentry{format() (src.loggingSat.DefaultFormatter method)|hyperpage}{50}
+\indexentry{setColorLevelname() (src.loggingSat.DefaultFormatter method)|hyperpage}{50}
+\indexentry{UnittestFormatter (class in src.loggingSat)|hyperpage}{50}
+\indexentry{format() (src.loggingSat.UnittestFormatter method)|hyperpage}{50}
+\indexentry{UnittestStream (class in src.loggingSat)|hyperpage}{50}
+\indexentry{flush() (src.loggingSat.UnittestStream method)|hyperpage}{50}
+\indexentry{getLogs() (src.loggingSat.UnittestStream method)|hyperpage}{50}
+\indexentry{getLogsAndClear() (src.loggingSat.UnittestStream method)|hyperpage}{51}
+\indexentry{write() (src.loggingSat.UnittestStream method)|hyperpage}{51}
+\indexentry{dirLogger() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{getDefaultLogger() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{getUnittestLogger() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{indent() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{indentUnittest() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{initLoggerAsDefault() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{initLoggerAsUnittest() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{log() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{testLogger\_1() (in module src.loggingSat)|hyperpage}{51}
+\indexentry{src.options (module)|hyperpage}{51}
+\indexentry{OptResult (class in src.options)|hyperpage}{51}
+\indexentry{Options (class in src.options)|hyperpage}{51}
+\indexentry{add\_option() (src.options.Options method)|hyperpage}{51}
+\indexentry{debug\_write() (src.options.Options method)|hyperpage}{51}
+\indexentry{getDetailOption() (src.options.Options method)|hyperpage}{51}
+\indexentry{get\_help() (src.options.Options method)|hyperpage}{52}
+\indexentry{indent() (src.options.Options method)|hyperpage}{52}
+\indexentry{parse\_args() (src.options.Options method)|hyperpage}{52}
+\indexentry{src.product (module)|hyperpage}{52}
+\indexentry{check\_config\_exists() (in module src.product)|hyperpage}{52}
+\indexentry{check\_installation() (in module src.product)|hyperpage}{52}
+\indexentry{get\_base\_install\_dir() (in module src.product)|hyperpage}{52}
+\indexentry{get\_install\_dir() (in module src.product)|hyperpage}{52}
+\indexentry{get\_product\_components() (in module src.product)|hyperpage}{53}
+\indexentry{get\_product\_config() (in module src.product)|hyperpage}{53}
+\indexentry{get\_product\_dependencies() (in module src.product)|hyperpage}{53}
+\indexentry{get\_product\_section() (in module src.product)|hyperpage}{53}
+\indexentry{get\_products\_infos() (in module src.product)|hyperpage}{53}
+\indexentry{product\_compiles() (in module src.product)|hyperpage}{53}
+\indexentry{product\_has\_env\_script() (in module src.product)|hyperpage}{54}
+\indexentry{product\_has\_logo() (in module src.product)|hyperpage}{54}
+\indexentry{product\_has\_patches() (in module src.product)|hyperpage}{54}
+\indexentry{product\_has\_salome\_gui() (in module src.product)|hyperpage}{54}
+\indexentry{product\_has\_script() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_SALOME() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_autotools() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_cmake() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_cpp() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_debug() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_dev() (in module src.product)|hyperpage}{54}
+\indexentry{product\_is\_fixed() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_generated() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_mpi() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_native() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_salome() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_sample() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_smesh\_plugin() (in module src.product)|hyperpage}{55}
+\indexentry{product\_is\_vcs() (in module src.product)|hyperpage}{55}
+\indexentry{src.pyconf (module)|hyperpage}{55}
+\indexentry{Config (class in src.pyconf)|hyperpage}{56}
+\indexentry{Config.Namespace (class in src.pyconf)|hyperpage}{56}
+\indexentry{addNamespace() (src.pyconf.Config method)|hyperpage}{57}
+\indexentry{getByPath() (src.pyconf.Config method)|hyperpage}{57}
+\indexentry{load() (src.pyconf.Config method)|hyperpage}{57}
+\indexentry{removeNamespace() (src.pyconf.Config method)|hyperpage}{57}
+\indexentry{ConfigError|hyperpage}{57}
+\indexentry{ConfigFormatError|hyperpage}{57}
+\indexentry{ConfigInputStream (class in src.pyconf)|hyperpage}{57}
+\indexentry{close() (src.pyconf.ConfigInputStream method)|hyperpage}{57}
+\indexentry{read() (src.pyconf.ConfigInputStream method)|hyperpage}{57}
+\indexentry{readline() (src.pyconf.ConfigInputStream method)|hyperpage}{57}
+\indexentry{ConfigList (class in src.pyconf)|hyperpage}{57}
+\indexentry{getByPath() (src.pyconf.ConfigList method)|hyperpage}{57}
+\indexentry{ConfigMerger (class in src.pyconf)|hyperpage}{57}
+\indexentry{handleMismatch() (src.pyconf.ConfigMerger method)|hyperpage}{57}
+\indexentry{merge() (src.pyconf.ConfigMerger method)|hyperpage}{58}
+\indexentry{mergeMapping() (src.pyconf.ConfigMerger method)|hyperpage}{58}
+\indexentry{mergeSequence() (src.pyconf.ConfigMerger method)|hyperpage}{58}
+\indexentry{overwriteKeys() (src.pyconf.ConfigMerger method)|hyperpage}{58}
+\indexentry{ConfigOutputStream (class in src.pyconf)|hyperpage}{58}
+\indexentry{close() (src.pyconf.ConfigOutputStream method)|hyperpage}{58}
+\indexentry{flush() (src.pyconf.ConfigOutputStream method)|hyperpage}{58}
+\indexentry{write() (src.pyconf.ConfigOutputStream method)|hyperpage}{58}
+\indexentry{ConfigReader (class in src.pyconf)|hyperpage}{58}
+\indexentry{getChar() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{getToken() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{load() (src.pyconf.ConfigReader method)|hyperpage}{58}
+\indexentry{location() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{match() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseFactor() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseKeyValuePair() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseMapping() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseMappingBody() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseReference() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseScalar() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseSequence() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseSuffix() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseTerm() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{parseValue() (src.pyconf.ConfigReader method)|hyperpage}{59}
+\indexentry{setStream() (src.pyconf.ConfigReader method)|hyperpage}{60}
+\indexentry{ConfigResolutionError|hyperpage}{60}
+\indexentry{Container (class in src.pyconf)|hyperpage}{60}
+\indexentry{evaluate() (src.pyconf.Container method)|hyperpage}{60}
+\indexentry{setPath() (src.pyconf.Container method)|hyperpage}{60}
+\indexentry{writeToStream() (src.pyconf.Container method)|hyperpage}{60}
+\indexentry{writeValue() (src.pyconf.Container method)|hyperpage}{60}
+\indexentry{Expression (class in src.pyconf)|hyperpage}{60}
+\indexentry{evaluate() (src.pyconf.Expression method)|hyperpage}{60}
+\indexentry{Mapping (class in src.pyconf)|hyperpage}{60}
+\indexentry{addMapping() (src.pyconf.Mapping method)|hyperpage}{61}
+\indexentry{get() (src.pyconf.Mapping method)|hyperpage}{61}
+\indexentry{iteritems() (src.pyconf.Mapping method)|hyperpage}{61}
+\indexentry{iterkeys() (src.pyconf.Mapping method)|hyperpage}{61}
+\indexentry{keys() (src.pyconf.Mapping method)|hyperpage}{61}
+\indexentry{writeToStream() (src.pyconf.Mapping method)|hyperpage}{61}
+\indexentry{Reference (class in src.pyconf)|hyperpage}{61}
+\indexentry{addElement() (src.pyconf.Reference method)|hyperpage}{61}
+\indexentry{findConfig() (src.pyconf.Reference method)|hyperpage}{61}
+\indexentry{resolve() (src.pyconf.Reference method)|hyperpage}{61}
+\indexentry{Sequence (class in src.pyconf)|hyperpage}{61}
+\indexentry{Sequence.SeqIter (class in src.pyconf)|hyperpage}{61}
+\indexentry{next() (src.pyconf.Sequence.SeqIter method)|hyperpage}{61}
+\indexentry{append() (src.pyconf.Sequence method)|hyperpage}{61}
+\indexentry{writeToStream() (src.pyconf.Sequence method)|hyperpage}{62}
+\indexentry{deepCopyMapping() (in module src.pyconf)|hyperpage}{62}
+\indexentry{defaultMergeResolve() (in module src.pyconf)|hyperpage}{62}
+\indexentry{defaultStreamOpener() (in module src.pyconf)|hyperpage}{62}
+\indexentry{isWord() (in module src.pyconf)|hyperpage}{62}
+\indexentry{makePath() (in module src.pyconf)|hyperpage}{62}
+\indexentry{overwriteMergeResolve() (in module src.pyconf)|hyperpage}{62}
+\indexentry{src.returnCode (module)|hyperpage}{63}
+\indexentry{ReturnCode (class in src.returnCode)|hyperpage}{63}
+\indexentry{KFSYS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{KNOWNFAILURE\_STATUS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{KOSYS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{KO\_STATUS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{NASYS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{NA\_STATUS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{NDSYS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{OKSYS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{OK\_STATUS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{TIMEOUT\_STATUS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{TOSYS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{UNKNOWN\_STATUS (src.returnCode.ReturnCode attribute)|hyperpage}{63}
+\indexentry{getValue() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{getWhy() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{indent() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{isOk() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{raiseIfKo() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{setStatus() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{setValue() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{setWhy() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{toSys() (src.returnCode.ReturnCode method)|hyperpage}{63}
+\indexentry{src.salomeTools (module)|hyperpage}{64}
+\indexentry{Sat (class in src.salomeTools)|hyperpage}{64}
+\indexentry{assumeAsList() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{execute\_cli() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getColoredVersion() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getCommandAndAppli() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getCommandInstance() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getConfig() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getConfigManager() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getLogger() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{getModule() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{get\_help() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{parseArguments() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{print\_help() (src.salomeTools.Sat method)|hyperpage}{64}
+\indexentry{assumeAsList() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{find\_command\_list() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{getCommandsList() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{getVersion() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{launchSat() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{setLocale() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{setNotLocale() (in module src.salomeTools)|hyperpage}{64}
+\indexentry{src.system (module)|hyperpage}{65}
+\indexentry{archive\_extract() (in module src.system)|hyperpage}{65}
+\indexentry{cvs\_extract() (in module src.system)|hyperpage}{65}
+\indexentry{git\_extract() (in module src.system)|hyperpage}{65}
+\indexentry{show\_in\_editor() (in module src.system)|hyperpage}{65}
+\indexentry{svn\_extract() (in module src.system)|hyperpage}{65}
+\indexentry{src.template (module)|hyperpage}{66}
+\indexentry{MyTemplate (class in src.template)|hyperpage}{66}
+\indexentry{delimiter (src.template.MyTemplate attribute)|hyperpage}{66}
+\indexentry{pattern (src.template.MyTemplate attribute)|hyperpage}{66}
+\indexentry{substitute() (in module src.template)|hyperpage}{66}
+\indexentry{src.test\_module (module)|hyperpage}{66}
+\indexentry{Test (class in src.test\_module)|hyperpage}{66}
+\indexentry{generate\_launching\_commands() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{generate\_script() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{get\_test\_timeout() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{get\_tmp\_dir() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{prepare\_testbase() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{prepare\_testbase\_from\_dir() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{prepare\_testbase\_from\_git() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{prepare\_testbase\_from\_svn() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{read\_results() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{run\_all\_tests() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{run\_grid\_tests() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{run\_script() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{run\_session\_tests() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{run\_testbase\_tests() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{run\_tests() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{search\_known\_errors() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{write\_test\_margin() (src.test\_module.Test method)|hyperpage}{66}
+\indexentry{getTmpDirDEFAULT() (in module src.test\_module)|hyperpage}{67}
+\indexentry{src.utilsSat (module)|hyperpage}{67}
+\indexentry{Path (class in src.utilsSat)|hyperpage}{67}
+\indexentry{base() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{chmod() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{copy() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{copydir() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{copyfile() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{copylink() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{dir() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{exists() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{isdir() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{isfile() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{islink() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{list() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{make() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{readlink() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{rm() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{smartcopy() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{symlink() (src.utilsSat.Path method)|hyperpage}{67}
+\indexentry{black() (in module src.utilsSat)|hyperpage}{67}
+\indexentry{blue() (in module src.utilsSat)|hyperpage}{67}
+\indexentry{check\_config\_has\_application() (in module src.utilsSat)|hyperpage}{67}
+\indexentry{check\_config\_has\_profile() (in module src.utilsSat)|hyperpage}{67}
+\indexentry{check\_has\_key() (in module src.utilsSat)|hyperpage}{67}
+\indexentry{config\_has\_application() (in module src.utilsSat)|hyperpage}{67}
+\indexentry{critical() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{cyan() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{date\_to\_datetime() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{deepcopy\_list() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{ensure\_path\_exists() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{error() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{find\_file\_in\_lpath() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{formatTuples() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{formatValue() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{get\_base\_path() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{get\_cfg\_param() (in module src.utilsSat)|hyperpage}{68}
+\indexentry{get\_launcher\_name() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{get\_log\_path() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{get\_property\_in\_product\_cfg() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{get\_salome\_version() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{get\_tmp\_filename() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{green() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{handleRemoveReadonly() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{header() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{info() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{label() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{list\_log\_file() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{log\_res\_step() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{log\_step() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{logger\_info\_tuples() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{magenta() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{merge\_dicts() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{normal() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{only\_numbers() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{parse\_date() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{read\_config\_from\_a\_file() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{red() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{remove\_item\_from\_list() (in module src.utilsSat)|hyperpage}{69}
+\indexentry{replace\_in\_file() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{reset() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{show\_command\_log() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{success() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{timedelta\_total\_seconds() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{update\_hat\_xml() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{warning() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{white() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{yellow() (in module src.utilsSat)|hyperpage}{70}
+\indexentry{src.xmlManager (module)|hyperpage}{70}
+\indexentry{ReadXmlFile (class in src.xmlManager)|hyperpage}{70}
+\indexentry{getRootAttrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{70}
+\indexentry{get\_attrib() (src.xmlManager.ReadXmlFile method)|hyperpage}{71}
+\indexentry{get\_node\_text() (src.xmlManager.ReadXmlFile method)|hyperpage}{71}
+\indexentry{XmlLogFile (class in src.xmlManager)|hyperpage}{71}
+\indexentry{add\_simple\_node() (src.xmlManager.XmlLogFile method)|hyperpage}{71}
+\indexentry{append\_node\_attrib() (src.xmlManager.XmlLogFile method)|hyperpage}{71}
+\indexentry{append\_node\_text() (src.xmlManager.XmlLogFile method)|hyperpage}{71}
+\indexentry{write\_tree() (src.xmlManager.XmlLogFile method)|hyperpage}{71}
+\indexentry{add\_simple\_node() (in module src.xmlManager)|hyperpage}{71}
+\indexentry{append\_node\_attrib() (in module src.xmlManager)|hyperpage}{71}
+\indexentry{find\_node\_by\_attrib() (in module src.xmlManager)|hyperpage}{72}
+\indexentry{write\_report() (in module src.xmlManager)|hyperpage}{72}
+\indexentry{src (module)|hyperpage}{72}
+\indexentry{commands.application (module)|hyperpage}{72}
+\indexentry{Command (class in commands.application)|hyperpage}{72}
+\indexentry{getParser() (commands.application.Command method)|hyperpage}{72}
+\indexentry{name (commands.application.Command attribute)|hyperpage}{72}
+\indexentry{run() (commands.application.Command method)|hyperpage}{72}
+\indexentry{add\_module\_to\_appli() (in module commands.application)|hyperpage}{73}
+\indexentry{create\_application() (in module commands.application)|hyperpage}{73}
+\indexentry{create\_config\_file() (in module commands.application)|hyperpage}{73}
+\indexentry{customize\_app() (in module commands.application)|hyperpage}{73}
+\indexentry{generate\_application() (in module commands.application)|hyperpage}{73}
+\indexentry{generate\_catalog() (in module commands.application)|hyperpage}{73}
+\indexentry{generate\_launch\_file() (in module commands.application)|hyperpage}{73}
+\indexentry{get\_SALOME\_modules() (in module commands.application)|hyperpage}{73}
+\indexentry{get\_step() (in module commands.application)|hyperpage}{73}
+\indexentry{make\_alias() (in module commands.application)|hyperpage}{73}
+\indexentry{commands.check (module)|hyperpage}{73}
+\indexentry{Command (class in commands.check)|hyperpage}{73}
+\indexentry{getParser() (commands.check.Command method)|hyperpage}{73}
+\indexentry{name (commands.check.Command attribute)|hyperpage}{73}
+\indexentry{run() (commands.check.Command method)|hyperpage}{73}
+\indexentry{check\_all\_products() (in module commands.check)|hyperpage}{73}
+\indexentry{check\_product() (in module commands.check)|hyperpage}{73}
+\indexentry{get\_products\_list() (in module commands.check)|hyperpage}{74}
+\indexentry{commands.clean (module)|hyperpage}{74}
+\indexentry{Command (class in commands.clean)|hyperpage}{74}
+\indexentry{getParser() (commands.clean.Command method)|hyperpage}{74}
+\indexentry{name (commands.clean.Command attribute)|hyperpage}{74}
+\indexentry{run() (commands.clean.Command method)|hyperpage}{74}
+\indexentry{get\_build\_directories() (in module commands.clean)|hyperpage}{74}
+\indexentry{get\_install\_directories() (in module commands.clean)|hyperpage}{74}
+\indexentry{get\_source\_directories() (in module commands.clean)|hyperpage}{74}
+\indexentry{product\_has\_dir() (in module commands.clean)|hyperpage}{75}
+\indexentry{suppress\_directories() (in module commands.clean)|hyperpage}{75}
+\indexentry{commands.compile (module)|hyperpage}{75}
+\indexentry{Command (class in commands.compile)|hyperpage}{75}
+\indexentry{getParser() (commands.compile.Command method)|hyperpage}{75}
+\indexentry{name (commands.compile.Command attribute)|hyperpage}{75}
+\indexentry{run() (commands.compile.Command method)|hyperpage}{75}
+\indexentry{add\_compile\_config\_file() (in module commands.compile)|hyperpage}{75}
+\indexentry{check\_dependencies() (in module commands.compile)|hyperpage}{75}
+\indexentry{compile\_all\_products() (in module commands.compile)|hyperpage}{75}
+\indexentry{compile\_product() (in module commands.compile)|hyperpage}{75}
+\indexentry{compile\_product\_cmake\_autotools() (in module commands.compile)|hyperpage}{76}
+\indexentry{compile\_product\_script() (in module commands.compile)|hyperpage}{76}
+\indexentry{extend\_with\_children() (in module commands.compile)|hyperpage}{76}
+\indexentry{extend\_with\_fathers() (in module commands.compile)|hyperpage}{76}
+\indexentry{get\_children() (in module commands.compile)|hyperpage}{76}
+\indexentry{get\_products\_list() (in module commands.compile)|hyperpage}{76}
+\indexentry{get\_recursive\_children() (in module commands.compile)|hyperpage}{76}
+\indexentry{get\_recursive\_fathers() (in module commands.compile)|hyperpage}{77}
+\indexentry{sort\_products() (in module commands.compile)|hyperpage}{77}
+\indexentry{commands.config (module)|hyperpage}{77}
+\indexentry{Command (class in commands.config)|hyperpage}{77}
+\indexentry{getParser() (commands.config.Command method)|hyperpage}{77}
+\indexentry{name (commands.config.Command attribute)|hyperpage}{77}
+\indexentry{run() (commands.config.Command method)|hyperpage}{77}
+\indexentry{commands.configure (module)|hyperpage}{77}
+\indexentry{Command (class in commands.configure)|hyperpage}{77}
+\indexentry{getParser() (commands.configure.Command method)|hyperpage}{78}
+\indexentry{name (commands.configure.Command attribute)|hyperpage}{78}
+\indexentry{run() (commands.configure.Command method)|hyperpage}{78}
+\indexentry{configure\_all\_products() (in module commands.configure)|hyperpage}{78}
+\indexentry{configure\_product() (in module commands.configure)|hyperpage}{78}
+\indexentry{get\_products\_list() (in module commands.configure)|hyperpage}{78}
+\indexentry{commands.environ (module)|hyperpage}{78}
+\indexentry{Command (class in commands.environ)|hyperpage}{78}
+\indexentry{getParser() (commands.environ.Command method)|hyperpage}{79}
+\indexentry{name (commands.environ.Command attribute)|hyperpage}{79}
+\indexentry{run() (commands.environ.Command method)|hyperpage}{79}
+\indexentry{write\_all\_source\_files() (in module commands.environ)|hyperpage}{79}
+\indexentry{commands.find\_duplicates (module)|hyperpage}{79}
+\indexentry{Command (class in commands.find\_duplicates)|hyperpage}{79}
+\indexentry{getParser() (commands.find\_duplicates.Command method)|hyperpage}{79}
+\indexentry{name (commands.find\_duplicates.Command attribute)|hyperpage}{79}
+\indexentry{run() (commands.find\_duplicates.Command method)|hyperpage}{79}
+\indexentry{Progress\_bar (class in commands.find\_duplicates)|hyperpage}{79}
+\indexentry{display\_value\_progression() (commands.find\_duplicates.Progress\_bar method)|hyperpage}{79}
+\indexentry{format\_list\_of\_str() (in module commands.find\_duplicates)|hyperpage}{79}
+\indexentry{list\_directory() (in module commands.find\_duplicates)|hyperpage}{80}
+\indexentry{commands.generate (module)|hyperpage}{80}
+\indexentry{Command (class in commands.generate)|hyperpage}{80}
+\indexentry{getParser() (commands.generate.Command method)|hyperpage}{80}
+\indexentry{name (commands.generate.Command attribute)|hyperpage}{80}
+\indexentry{run() (commands.generate.Command method)|hyperpage}{80}
+\indexentry{build\_context() (in module commands.generate)|hyperpage}{80}
+\indexentry{check\_module\_generator() (in module commands.generate)|hyperpage}{80}
+\indexentry{check\_yacsgen() (in module commands.generate)|hyperpage}{80}
+\indexentry{generate\_component() (in module commands.generate)|hyperpage}{80}
+\indexentry{generate\_component\_list() (in module commands.generate)|hyperpage}{81}
+\indexentry{commands.init (module)|hyperpage}{81}
+\indexentry{Command (class in commands.init)|hyperpage}{81}
+\indexentry{getParser() (commands.init.Command method)|hyperpage}{81}
+\indexentry{name (commands.init.Command attribute)|hyperpage}{81}
+\indexentry{run() (commands.init.Command method)|hyperpage}{81}
+\indexentry{check\_path() (in module commands.init)|hyperpage}{81}
+\indexentry{display\_local\_values() (in module commands.init)|hyperpage}{81}
+\indexentry{set\_local\_value() (in module commands.init)|hyperpage}{81}
+\indexentry{commands.job (module)|hyperpage}{81}
+\indexentry{Command (class in commands.job)|hyperpage}{81}
+\indexentry{getParser() (commands.job.Command method)|hyperpage}{81}
+\indexentry{name (commands.job.Command attribute)|hyperpage}{81}
+\indexentry{run() (commands.job.Command method)|hyperpage}{81}
+\indexentry{commands.jobs (module)|hyperpage}{82}
+\indexentry{Command (class in commands.jobs)|hyperpage}{82}
+\indexentry{getParser() (commands.jobs.Command method)|hyperpage}{82}
+\indexentry{name (commands.jobs.Command attribute)|hyperpage}{82}
+\indexentry{run() (commands.jobs.Command method)|hyperpage}{82}
+\indexentry{Gui (class in commands.jobs)|hyperpage}{82}
+\indexentry{add\_xml\_board() (commands.jobs.Gui method)|hyperpage}{82}
+\indexentry{find\_history() (commands.jobs.Gui method)|hyperpage}{82}
+\indexentry{find\_test\_log() (commands.jobs.Gui method)|hyperpage}{82}
+\indexentry{initialize\_boards() (commands.jobs.Gui method)|hyperpage}{82}
+\indexentry{last\_update() (commands.jobs.Gui method)|hyperpage}{82}
+\indexentry{parse\_csv\_boards() (commands.jobs.Gui method)|hyperpage}{82}
+\indexentry{put\_jobs\_not\_today() (commands.jobs.Gui method)|hyperpage}{83}
+\indexentry{update\_xml\_file() (commands.jobs.Gui method)|hyperpage}{83}
+\indexentry{update\_xml\_files() (commands.jobs.Gui method)|hyperpage}{83}
+\indexentry{write\_xml\_file() (commands.jobs.Gui method)|hyperpage}{83}
+\indexentry{write\_xml\_files() (commands.jobs.Gui method)|hyperpage}{83}
+\indexentry{Job (class in commands.jobs)|hyperpage}{83}
+\indexentry{cancel() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{check\_time() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{get\_log\_files() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{get\_pids() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{get\_status() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{has\_begun() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{has\_failed() (commands.jobs.Job method)|hyperpage}{83}
+\indexentry{has\_finished() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{is\_running() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{is\_timeout() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{kill\_remote\_process() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{run() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{time\_elapsed() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{total\_duration() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{write\_results() (commands.jobs.Job method)|hyperpage}{84}
+\indexentry{Jobs (class in commands.jobs)|hyperpage}{84}
+\indexentry{cancel\_dependencies\_of\_failing\_jobs() (commands.jobs.Jobs method)|hyperpage}{84}
+\indexentry{define\_job() (commands.jobs.Jobs method)|hyperpage}{84}
+\indexentry{determine\_jobs\_and\_machines() (commands.jobs.Jobs method)|hyperpage}{84}
+\indexentry{display\_status() (commands.jobs.Jobs method)|hyperpage}{84}
+\indexentry{find\_job\_that\_has\_name() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{is\_occupied() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{run\_jobs() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{ssh\_connection\_all\_machines() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{str\_of\_length() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{update\_jobs\_states\_list() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{write\_all\_results() (commands.jobs.Jobs method)|hyperpage}{85}
+\indexentry{Machine (class in commands.jobs)|hyperpage}{85}
+\indexentry{close() (commands.jobs.Machine method)|hyperpage}{85}
+\indexentry{connect() (commands.jobs.Machine method)|hyperpage}{85}
+\indexentry{copy\_sat() (commands.jobs.Machine method)|hyperpage}{85}
+\indexentry{exec\_command() (commands.jobs.Machine method)|hyperpage}{85}
+\indexentry{mkdir() (commands.jobs.Machine method)|hyperpage}{86}
+\indexentry{put\_dir() (commands.jobs.Machine method)|hyperpage}{86}
+\indexentry{successfully\_connected() (commands.jobs.Machine method)|hyperpage}{86}
+\indexentry{write\_info() (commands.jobs.Machine method)|hyperpage}{86}
+\indexentry{develop\_factorized\_jobs() (in module commands.jobs)|hyperpage}{86}
+\indexentry{getParamiko() (in module commands.jobs)|hyperpage}{86}
+\indexentry{get\_config\_file\_path() (in module commands.jobs)|hyperpage}{86}
+\indexentry{commands.launcher (module)|hyperpage}{86}
+\indexentry{Command (class in commands.launcher)|hyperpage}{86}
+\indexentry{getParser() (commands.launcher.Command method)|hyperpage}{86}
+\indexentry{name (commands.launcher.Command attribute)|hyperpage}{86}
+\indexentry{run() (commands.launcher.Command method)|hyperpage}{86}
+\indexentry{copy\_catalog() (in module commands.launcher)|hyperpage}{86}
+\indexentry{generate\_catalog() (in module commands.launcher)|hyperpage}{87}
+\indexentry{generate\_launch\_file() (in module commands.launcher)|hyperpage}{87}
+\indexentry{commands.log (module)|hyperpage}{87}
+\indexentry{Command (class in commands.log)|hyperpage}{87}
+\indexentry{getParser() (commands.log.Command method)|hyperpage}{87}
+\indexentry{name (commands.log.Command attribute)|hyperpage}{87}
+\indexentry{run() (commands.log.Command method)|hyperpage}{87}
+\indexentry{ask\_value() (in module commands.log)|hyperpage}{87}
+\indexentry{getMaxFormat() (in module commands.log)|hyperpage}{87}
+\indexentry{get\_last\_log\_file() (in module commands.log)|hyperpage}{87}
+\indexentry{print\_log\_command\_in\_terminal() (in module commands.log)|hyperpage}{88}
+\indexentry{remove\_log\_file() (in module commands.log)|hyperpage}{88}
+\indexentry{show\_last\_logs() (in module commands.log)|hyperpage}{88}
+\indexentry{show\_product\_last\_logs() (in module commands.log)|hyperpage}{88}
+\indexentry{commands.make (module)|hyperpage}{88}
+\indexentry{Command (class in commands.make)|hyperpage}{88}
+\indexentry{getParser() (commands.make.Command method)|hyperpage}{88}
+\indexentry{name (commands.make.Command attribute)|hyperpage}{88}
+\indexentry{run() (commands.make.Command method)|hyperpage}{88}
+\indexentry{get\_nb\_proc() (in module commands.make)|hyperpage}{88}
+\indexentry{get\_products\_list() (in module commands.make)|hyperpage}{88}
+\indexentry{make\_all\_products() (in module commands.make)|hyperpage}{88}
+\indexentry{make\_product() (in module commands.make)|hyperpage}{89}
+\indexentry{commands.makeinstall (module)|hyperpage}{89}
+\indexentry{Command (class in commands.makeinstall)|hyperpage}{89}
+\indexentry{getParser() (commands.makeinstall.Command method)|hyperpage}{89}
+\indexentry{name (commands.makeinstall.Command attribute)|hyperpage}{89}
+\indexentry{run() (commands.makeinstall.Command method)|hyperpage}{89}
+\indexentry{get\_products\_list() (in module commands.makeinstall)|hyperpage}{89}
+\indexentry{makeinstall\_all\_products() (in module commands.makeinstall)|hyperpage}{89}
+\indexentry{makeinstall\_product() (in module commands.makeinstall)|hyperpage}{90}
+\indexentry{commands.package (module)|hyperpage}{90}
+\indexentry{Command (class in commands.package)|hyperpage}{90}
+\indexentry{getParser() (commands.package.Command method)|hyperpage}{90}
+\indexentry{name (commands.package.Command attribute)|hyperpage}{90}
+\indexentry{run() (commands.package.Command method)|hyperpage}{90}
+\indexentry{add\_files() (in module commands.package)|hyperpage}{90}
+\indexentry{add\_readme() (in module commands.package)|hyperpage}{90}
+\indexentry{add\_salomeTools() (in module commands.package)|hyperpage}{90}
+\indexentry{binary\_package() (in module commands.package)|hyperpage}{91}
+\indexentry{create\_project\_for\_src\_package() (in module commands.package)|hyperpage}{91}
+\indexentry{exclude\_VCS\_and\_extensions() (in module commands.package)|hyperpage}{91}
+\indexentry{find\_application\_pyconf() (in module commands.package)|hyperpage}{91}
+\indexentry{find\_product\_scripts\_and\_pyconf() (in module commands.package)|hyperpage}{91}
+\indexentry{get\_archives() (in module commands.package)|hyperpage}{92}
+\indexentry{get\_archives\_vcs() (in module commands.package)|hyperpage}{92}
+\indexentry{hack\_for\_distene\_licence() (in module commands.package)|hyperpage}{92}
+\indexentry{make\_archive() (in module commands.package)|hyperpage}{92}
+\indexentry{produce\_install\_bin\_file() (in module commands.package)|hyperpage}{93}
+\indexentry{produce\_relative\_env\_files() (in module commands.package)|hyperpage}{93}
+\indexentry{produce\_relative\_launcher() (in module commands.package)|hyperpage}{93}
+\indexentry{product\_appli\_creation\_script() (in module commands.package)|hyperpage}{93}
+\indexentry{project\_package() (in module commands.package)|hyperpage}{93}
+\indexentry{source\_package() (in module commands.package)|hyperpage}{94}
+\indexentry{update\_config() (in module commands.package)|hyperpage}{94}
+\indexentry{commands.patch (module)|hyperpage}{94}
+\indexentry{Command (class in commands.patch)|hyperpage}{94}
+\indexentry{getParser() (commands.patch.Command method)|hyperpage}{94}
+\indexentry{name (commands.patch.Command attribute)|hyperpage}{94}
+\indexentry{run() (commands.patch.Command method)|hyperpage}{94}
+\indexentry{apply\_patch() (in module commands.patch)|hyperpage}{94}
+\indexentry{commands.prepare (module)|hyperpage}{95}
+\indexentry{Command (class in commands.prepare)|hyperpage}{95}
+\indexentry{getParser() (commands.prepare.Command method)|hyperpage}{95}
+\indexentry{name (commands.prepare.Command attribute)|hyperpage}{95}
+\indexentry{run() (commands.prepare.Command method)|hyperpage}{95}
+\indexentry{find\_products\_already\_getted() (in module commands.prepare)|hyperpage}{95}
+\indexentry{find\_products\_with\_patchs() (in module commands.prepare)|hyperpage}{95}
+\indexentry{remove\_products() (in module commands.prepare)|hyperpage}{95}
+\indexentry{commands.profile (module)|hyperpage}{95}
+\indexentry{Command (class in commands.profile)|hyperpage}{95}
+\indexentry{getParser() (commands.profile.Command method)|hyperpage}{95}
+\indexentry{name (commands.profile.Command attribute)|hyperpage}{96}
+\indexentry{run() (commands.profile.Command method)|hyperpage}{96}
+\indexentry{generate\_profile\_sources() (in module commands.profile)|hyperpage}{96}
+\indexentry{get\_profile\_name() (in module commands.profile)|hyperpage}{96}
+\indexentry{profileConfigReader (class in commands.profile)|hyperpage}{96}
+\indexentry{parseMapping() (commands.profile.profileConfigReader method)|hyperpage}{96}
+\indexentry{profileReference (class in commands.profile)|hyperpage}{96}
+\indexentry{update\_pyconf() (in module commands.profile)|hyperpage}{96}
+\indexentry{commands.run (module)|hyperpage}{96}
+\indexentry{Command (class in commands.run)|hyperpage}{96}
+\indexentry{getParser() (commands.run.Command method)|hyperpage}{96}
+\indexentry{name (commands.run.Command attribute)|hyperpage}{96}
+\indexentry{run() (commands.run.Command method)|hyperpage}{96}
+\indexentry{commands.script (module)|hyperpage}{96}
+\indexentry{Command (class in commands.script)|hyperpage}{96}
+\indexentry{getParser() (commands.script.Command method)|hyperpage}{96}
+\indexentry{name (commands.script.Command attribute)|hyperpage}{97}
+\indexentry{run() (commands.script.Command method)|hyperpage}{97}
+\indexentry{get\_products\_list() (in module commands.script)|hyperpage}{97}
+\indexentry{run\_script\_all\_products() (in module commands.script)|hyperpage}{97}
+\indexentry{run\_script\_of\_product() (in module commands.script)|hyperpage}{97}
+\indexentry{commands.shell (module)|hyperpage}{97}
+\indexentry{Command (class in commands.shell)|hyperpage}{97}
+\indexentry{getParser() (commands.shell.Command method)|hyperpage}{97}
+\indexentry{name (commands.shell.Command attribute)|hyperpage}{97}
+\indexentry{run() (commands.shell.Command method)|hyperpage}{97}
+\indexentry{commands.source (module)|hyperpage}{98}
+\indexentry{Command (class in commands.source)|hyperpage}{98}
+\indexentry{getParser() (commands.source.Command method)|hyperpage}{98}
+\indexentry{name (commands.source.Command attribute)|hyperpage}{98}
+\indexentry{run() (commands.source.Command method)|hyperpage}{98}
+\indexentry{check\_sources() (in module commands.source)|hyperpage}{98}
+\indexentry{get\_all\_product\_sources() (in module commands.source)|hyperpage}{98}
+\indexentry{get\_product\_sources() (in module commands.source)|hyperpage}{98}
+\indexentry{get\_source\_for\_dev() (in module commands.source)|hyperpage}{98}
+\indexentry{get\_source\_from\_archive() (in module commands.source)|hyperpage}{99}
+\indexentry{get\_source\_from\_cvs() (in module commands.source)|hyperpage}{99}
+\indexentry{get\_source\_from\_dir() (in module commands.source)|hyperpage}{99}
+\indexentry{get\_source\_from\_git() (in module commands.source)|hyperpage}{99}
+\indexentry{get\_source\_from\_svn() (in module commands.source)|hyperpage}{99}
+\indexentry{commands.template (module)|hyperpage}{100}
+\indexentry{Command (class in commands.template)|hyperpage}{100}
+\indexentry{getParser() (commands.template.Command method)|hyperpage}{100}
+\indexentry{name (commands.template.Command attribute)|hyperpage}{100}
+\indexentry{run() (commands.template.Command method)|hyperpage}{100}
+\indexentry{TParam (class in commands.template)|hyperpage}{100}
+\indexentry{check\_value() (commands.template.TParam method)|hyperpage}{100}
+\indexentry{TemplateSettings (class in commands.template)|hyperpage}{100}
+\indexentry{check\_file\_for\_substitution() (commands.template.TemplateSettings method)|hyperpage}{100}
+\indexentry{check\_user\_values() (commands.template.TemplateSettings method)|hyperpage}{100}
+\indexentry{get\_parameters() (commands.template.TemplateSettings method)|hyperpage}{100}
+\indexentry{get\_pyconf\_parameters() (commands.template.TemplateSettings method)|hyperpage}{100}
+\indexentry{has\_pyconf() (commands.template.TemplateSettings method)|hyperpage}{100}
+\indexentry{get\_dico\_param() (in module commands.template)|hyperpage}{100}
+\indexentry{get\_template\_info() (in module commands.template)|hyperpage}{100}
+\indexentry{prepare\_from\_template() (in module commands.template)|hyperpage}{100}
+\indexentry{search\_template() (in module commands.template)|hyperpage}{100}
+\indexentry{commands.test (module)|hyperpage}{101}
+\indexentry{Command (class in commands.test)|hyperpage}{101}
+\indexentry{check\_option() (commands.test.Command method)|hyperpage}{101}
+\indexentry{getParser() (commands.test.Command method)|hyperpage}{101}
+\indexentry{name (commands.test.Command attribute)|hyperpage}{101}
+\indexentry{run() (commands.test.Command method)|hyperpage}{101}
+\indexentry{ask\_a\_path() (in module commands.test)|hyperpage}{101}
+\indexentry{check\_remote\_machine() (in module commands.test)|hyperpage}{101}
+\indexentry{create\_test\_report() (in module commands.test)|hyperpage}{101}
+\indexentry{generate\_history\_xml\_path() (in module commands.test)|hyperpage}{101}
+\indexentry{move\_test\_results() (in module commands.test)|hyperpage}{101}
+\indexentry{save\_file() (in module commands.test)|hyperpage}{101}
+\indexentry{commands (module)|hyperpage}{101}
diff --git a/doc/build/latex/salomeTools.ilg b/doc/build/latex/salomeTools.ilg
new file mode 100644
index 0000000..dbd35b9
--- /dev/null
+++ b/doc/build/latex/salomeTools.ilg
@@ -0,0 +1,7 @@
+This is makeindex, version 2.15 [TeX Live 2017] (kpathsea + Thai support).
+Scanning style file ./python.ist.......done (7 attributes redefined, 0 ignored).
+Scanning input file salomeTools.idx....done (938 entries accepted, 0 rejected).
+Sorting entries..........done (10044 comparisons).
+Generating output file salomeTools.ind....done (1015 lines written, 0 warnings).
+Output written in salomeTools.ind.
+Transcript written in salomeTools.ilg.
diff --git a/doc/build/latex/salomeTools.ind b/doc/build/latex/salomeTools.ind
new file mode 100644
index 0000000..ae1e799
--- /dev/null
+++ b/doc/build/latex/salomeTools.ind
@@ -0,0 +1,1015 @@
+\begin{sphinxtheindex}
+\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
+
+  \bigletter A
+  \item add() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{47}
+  \item add\_comment() (src.environment.SalomeEnviron method), \hyperpage{41}
+  \item add\_comment() (src.fileEnviron.BatFileEnviron method), \hyperpage{45}
+  \item add\_comment() (src.fileEnviron.FileEnviron method), \hyperpage{46}
+  \item add\_comment() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{47}
+  \item add\_comment() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item add\_compile\_config\_file() (in module commands.compile), \hyperpage{75}
+  \item add\_echo() (src.fileEnviron.ContextFileEnviron method), \hyperpage{45}
+  \item add\_echo() (src.fileEnviron.FileEnviron method), \hyperpage{46}
+  \item add\_echo() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{47}
+  \item add\_echo() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item add\_files() (in module commands.package), \hyperpage{90}
+  \item add\_line() (src.environment.SalomeEnviron method), \hyperpage{41}
+  \item add\_line() (src.fileEnviron.FileEnviron method), \hyperpage{46}
+  \item add\_line() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item add\_line() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item add\_module\_to\_appli() (in module commands.application), \hyperpage{73}
+  \item add\_option() (src.options.Options method), \hyperpage{51}
+  \item add\_readme() (in module commands.package), \hyperpage{90}
+  \item add\_salomeTools() (in module commands.package), \hyperpage{90}
+  \item add\_simple\_node() (in module src.xmlManager), \hyperpage{71}
+  \item add\_simple\_node() (src.xmlManager.XmlLogFile method), \hyperpage{71}
+  \item add\_warning() (src.environment.SalomeEnviron method), \hyperpage{41}
+  \item add\_warning() (src.fileEnviron.ContextFileEnviron method), \hyperpage{45}
+  \item add\_warning() (src.fileEnviron.FileEnviron method), \hyperpage{46}
+  \item add\_warning() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item add\_warning() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item add\_xml\_board() (commands.jobs.Gui method), \hyperpage{82}
+  \item addElement() (src.pyconf.Reference method), \hyperpage{61}
+  \item addMapping() (src.pyconf.Mapping method), \hyperpage{61}
+  \item addNamespace() (src.pyconf.Config method), \hyperpage{57}
+  \item ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{31}
+  \item ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute), \hyperpage{31}
+  \item AnsiBack (class in src.colorama.ansi), \hyperpage{29}
+  \item AnsiCodes (class in src.colorama.ansi), \hyperpage{29}
+  \item AnsiCursor (class in src.colorama.ansi), \hyperpage{30}
+  \item AnsiFore (class in src.colorama.ansi), \hyperpage{30}
+  \item AnsiStyle (class in src.colorama.ansi), \hyperpage{30}
+  \item AnsiToWin32 (class in src.colorama.ansitowin32), \hyperpage{31}
+  \item append() (src.environment.Environ method), \hyperpage{40}
+  \item append() (src.environment.SalomeEnviron method), \hyperpage{41}
+  \item append() (src.fileEnviron.FileEnviron method), \hyperpage{46}
+  \item append() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item append() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item append() (src.pyconf.Sequence method), \hyperpage{61}
+  \item append\_node\_attrib() (in module src.xmlManager), \hyperpage{71}
+  \item append\_node\_attrib() (src.xmlManager.XmlLogFile method), \hyperpage{71}
+  \item append\_node\_text() (src.xmlManager.XmlLogFile method), \hyperpage{71}
+  \item append\_value() (src.environment.Environ method), \hyperpage{40}
+  \item append\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{45}
+  \item append\_value() (src.fileEnviron.FileEnviron method), \hyperpage{46}
+  \item append\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item apply\_patch() (in module commands.patch), \hyperpage{94}
+  \item archive\_extract() (in module src.system), \hyperpage{65}
+  \item ask\_a\_path() (in module commands.test), \hyperpage{101}
+  \item ask\_value() (in module commands.log), \hyperpage{87}
+  \item assumeAsList() (in module src.salomeTools), \hyperpage{64}
+  \item assumeAsList() (src.salomeTools.Sat method), \hyperpage{64}
+
+  \indexspace
+  \bigletter B
+  \item BACK() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+  \item back() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item base() (src.utilsSat.Path method), \hyperpage{67}
+  \item BashFileEnviron (class in src.fileEnviron), \hyperpage{44}
+  \item batch() (in module src.fork), \hyperpage{49}
+  \item batch\_salome() (in module src.fork), \hyperpage{49}
+  \item BatFileEnviron (class in src.fileEnviron), \hyperpage{44}
+  \item binary\_package() (in module commands.package), \hyperpage{91}
+  \item BLACK (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item BLACK (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item BLACK (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item black() (in module src.utilsSat), \hyperpage{67}
+  \item BLUE (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item BLUE (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item BLUE (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item blue() (in module src.utilsSat), \hyperpage{67}
+  \item BRIGHT (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+  \item BRIGHT (src.colorama.winterm.WinStyle attribute), \hyperpage{32}
+  \item BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute), \hyperpage{32}
+  \item build\_configure() (src.compilation.Builder method), \hyperpage{36}
+  \item build\_context() (in module commands.generate), \hyperpage{80}
+  \item Builder (class in src.compilation), \hyperpage{36}
+
+  \indexspace
+  \bigletter C
+  \item call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item cancel() (commands.jobs.Job method), \hyperpage{83}
+  \item cancel\_dependencies\_of\_failing\_jobs() (commands.jobs.Jobs method), \hyperpage{84}
+  \item CatchAll (class in src.catchAll), \hyperpage{35}
+  \item change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item check() (src.compilation.Builder method), \hyperpage{36}
+  \item check\_all\_products() (in module commands.check), \hyperpage{73}
+  \item check\_config\_exists() (in module src.product), \hyperpage{52}
+  \item check\_config\_has\_application() (in module src.utilsSat), \hyperpage{67}
+  \item check\_config\_has\_profile() (in module src.utilsSat), \hyperpage{67}
+  \item check\_dependencies() (in module commands.compile), \hyperpage{75}
+  \item check\_file\_for\_substitution() (commands.template.TemplateSettings method), 
+		\hyperpage{100}
+  \item check\_has\_key() (in module src.utilsSat), \hyperpage{67}
+  \item check\_installation() (in module src.product), \hyperpage{52}
+  \item check\_module\_generator() (in module commands.generate), \hyperpage{80}
+  \item check\_option() (commands.test.Command method), \hyperpage{101}
+  \item check\_path() (in module commands.init), \hyperpage{81}
+  \item check\_path() (in module src.configManager), \hyperpage{38}
+  \item check\_product() (in module commands.check), \hyperpage{73}
+  \item check\_remote\_machine() (in module commands.test), \hyperpage{101}
+  \item check\_sources() (in module commands.source), \hyperpage{98}
+  \item check\_time() (commands.jobs.Job method), \hyperpage{83}
+  \item check\_user\_values() (commands.template.TemplateSettings method), \hyperpage{100}
+  \item check\_value() (commands.template.TParam method), \hyperpage{100}
+  \item check\_yacsgen() (in module commands.generate), \hyperpage{80}
+  \item chmod() (src.utilsSat.Path method), \hyperpage{67}
+  \item cleanColors() (in module src.coloringSat), \hyperpage{36}
+  \item clear\_line() (in module src.colorama.ansi), \hyperpage{30}
+  \item clear\_screen() (in module src.colorama.ansi), \hyperpage{30}
+  \item close() (commands.jobs.Machine method), \hyperpage{85}
+  \item close() (src.debug.OutStream method), \hyperpage{39}
+  \item close() (src.ElementTree.TreeBuilder method), \hyperpage{34}
+  \item close() (src.ElementTree.XMLTreeBuilder method), \hyperpage{34}
+  \item close() (src.pyconf.ConfigInputStream method), \hyperpage{57}
+  \item close() (src.pyconf.ConfigOutputStream method), \hyperpage{58}
+  \item cmake() (src.compilation.Builder method), \hyperpage{36}
+  \item code\_to\_chars() (in module src.colorama.ansi), \hyperpage{30}
+  \item colorama\_text() (in module src.colorama.initialise), \hyperpage{31}
+  \item ColoringStream (class in src.coloringSat), \hyperpage{36}
+  \item Command (class in commands.application), \hyperpage{72}
+  \item Command (class in commands.check), \hyperpage{73}
+  \item Command (class in commands.clean), \hyperpage{74}
+  \item Command (class in commands.compile), \hyperpage{75}
+  \item Command (class in commands.config), \hyperpage{77}
+  \item Command (class in commands.configure), \hyperpage{77}
+  \item Command (class in commands.environ), \hyperpage{78}
+  \item Command (class in commands.find\_duplicates), \hyperpage{79}
+  \item Command (class in commands.generate), \hyperpage{80}
+  \item Command (class in commands.init), \hyperpage{81}
+  \item Command (class in commands.job), \hyperpage{81}
+  \item Command (class in commands.jobs), \hyperpage{82}
+  \item Command (class in commands.launcher), \hyperpage{86}
+  \item Command (class in commands.log), \hyperpage{87}
+  \item Command (class in commands.make), \hyperpage{88}
+  \item Command (class in commands.makeinstall), \hyperpage{89}
+  \item Command (class in commands.package), \hyperpage{90}
+  \item Command (class in commands.patch), \hyperpage{94}
+  \item Command (class in commands.prepare), \hyperpage{95}
+  \item Command (class in commands.profile), \hyperpage{95}
+  \item Command (class in commands.run), \hyperpage{96}
+  \item Command (class in commands.script), \hyperpage{96}
+  \item Command (class in commands.shell), \hyperpage{97}
+  \item Command (class in commands.source), \hyperpage{98}
+  \item Command (class in commands.template), \hyperpage{100}
+  \item Command (class in commands.test), \hyperpage{101}
+  \item command\_value() (src.environment.Environ method), \hyperpage{40}
+  \item command\_value() (src.fileEnviron.BashFileEnviron method), \hyperpage{44}
+  \item command\_value() (src.fileEnviron.BatFileEnviron method), \hyperpage{45}
+  \item command\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{45}
+  \item command\_value() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item command\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item command\_value() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item commands (module), \hyperpage{101}
+  \item commands.application (module), \hyperpage{72}
+  \item commands.check (module), \hyperpage{73}
+  \item commands.clean (module), \hyperpage{74}
+  \item commands.compile (module), \hyperpage{75}
+  \item commands.config (module), \hyperpage{77}
+  \item commands.configure (module), \hyperpage{77}
+  \item commands.environ (module), \hyperpage{78}
+  \item commands.find\_duplicates (module), \hyperpage{79}
+  \item commands.generate (module), \hyperpage{80}
+  \item commands.init (module), \hyperpage{81}
+  \item commands.job (module), \hyperpage{81}
+  \item commands.jobs (module), \hyperpage{82}
+  \item commands.launcher (module), \hyperpage{86}
+  \item commands.log (module), \hyperpage{87}
+  \item commands.make (module), \hyperpage{88}
+  \item commands.makeinstall (module), \hyperpage{89}
+  \item commands.package (module), \hyperpage{90}
+  \item commands.patch (module), \hyperpage{94}
+  \item commands.prepare (module), \hyperpage{95}
+  \item commands.profile (module), \hyperpage{95}
+  \item commands.run (module), \hyperpage{96}
+  \item commands.script (module), \hyperpage{96}
+  \item commands.shell (module), \hyperpage{97}
+  \item commands.source (module), \hyperpage{98}
+  \item commands.template (module), \hyperpage{100}
+  \item commands.test (module), \hyperpage{101}
+  \item Comment() (in module src.ElementTree), \hyperpage{34}
+  \item compile\_all\_products() (in module commands.compile), \hyperpage{75}
+  \item compile\_product() (in module commands.compile), \hyperpage{75}
+  \item compile\_product\_cmake\_autotools() (in module commands.compile), \hyperpage{76}
+  \item compile\_product\_script() (in module commands.compile), \hyperpage{76}
+  \item complete\_environment() (src.compilation.Builder method), \hyperpage{36}
+  \item Config (class in src.pyconf), \hyperpage{56}
+  \item Config.Namespace (class in src.pyconf), \hyperpage{56}
+  \item config\_has\_application() (in module src.utilsSat), \hyperpage{67}
+  \item ConfigError, \hyperpage{57}
+  \item ConfigFormatError, \hyperpage{57}
+  \item ConfigInputStream (class in src.pyconf), \hyperpage{57}
+  \item ConfigList (class in src.pyconf), \hyperpage{57}
+  \item ConfigManager (class in src.configManager), \hyperpage{37}
+  \item ConfigMerger (class in src.pyconf), \hyperpage{57}
+  \item ConfigOpener (class in src.configManager), \hyperpage{38}
+  \item ConfigOutputStream (class in src.pyconf), \hyperpage{58}
+  \item ConfigReader (class in src.pyconf), \hyperpage{58}
+  \item ConfigResolutionError, \hyperpage{60}
+  \item configure() (src.compilation.Builder method), \hyperpage{36}
+  \item configure\_all\_products() (in module commands.configure), \hyperpage{78}
+  \item configure\_product() (in module commands.configure), \hyperpage{78}
+  \item connect() (commands.jobs.Machine method), \hyperpage{85}
+  \item Container (class in src.pyconf), \hyperpage{60}
+  \item ContextFileEnviron (class in src.fileEnviron), \hyperpage{45}
+  \item convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item copy() (src.utilsSat.Path method), \hyperpage{67}
+  \item copy\_catalog() (in module commands.launcher), \hyperpage{86}
+  \item copy\_sat() (commands.jobs.Machine method), \hyperpage{85}
+  \item copydir() (src.utilsSat.Path method), \hyperpage{67}
+  \item copyfile() (src.utilsSat.Path method), \hyperpage{67}
+  \item copylink() (src.utilsSat.Path method), \hyperpage{67}
+  \item create\_application() (in module commands.application), \hyperpage{73}
+  \item create\_config\_file() (in module commands.application), \hyperpage{73}
+  \item create\_config\_file() (src.configManager.ConfigManager method), \hyperpage{37}
+  \item create\_project\_for\_src\_package() (in module commands.package), \hyperpage{91}
+  \item create\_test\_report() (in module commands.test), \hyperpage{101}
+  \item critical() (in module src.utilsSat), \hyperpage{68}
+  \item cursor\_adjust() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item customize\_app() (in module commands.application), \hyperpage{73}
+  \item cvs\_extract() (in module src.system), \hyperpage{65}
+  \item CYAN (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item CYAN (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item CYAN (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item cyan() (in module src.utilsSat), \hyperpage{68}
+
+  \indexspace
+  \bigletter D
+  \item data() (src.ElementTree.TreeBuilder method), \hyperpage{34}
+  \item date\_to\_datetime() (in module src.utilsSat), \hyperpage{68}
+  \item debug\_write() (src.options.Options method), \hyperpage{51}
+  \item deepcopy\_list() (in module src.utilsSat), \hyperpage{68}
+  \item deepCopyMapping() (in module src.pyconf), \hyperpage{62}
+  \item DefaultFormatter (class in src.loggingSat), \hyperpage{50}
+  \item defaultMergeResolve() (in module src.pyconf), \hyperpage{62}
+  \item defaultStreamOpener() (in module src.pyconf), \hyperpage{62}
+  \item define\_job() (commands.jobs.Jobs method), \hyperpage{84}
+  \item deinit() (in module src.colorama.initialise), \hyperpage{31}
+  \item delimiter (src.template.MyTemplate attribute), \hyperpage{66}
+  \item determine\_jobs\_and\_machines() (commands.jobs.Jobs method), \hyperpage{84}
+  \item develop\_factorized\_jobs() (in module commands.jobs), \hyperpage{86}
+  \item DIM (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+  \item dir() (src.utilsSat.Path method), \hyperpage{67}
+  \item dirLogger() (in module src.loggingSat), \hyperpage{51}
+  \item display\_local\_values() (in module commands.init), \hyperpage{81}
+  \item display\_status() (commands.jobs.Jobs method), \hyperpage{84}
+  \item display\_value\_progression() (commands.find\_duplicates.Progress\_bar method), 
+		\hyperpage{79}
+  \item do\_batch\_script\_build() (src.compilation.Builder method), \hyperpage{36}
+  \item do\_default\_build() (src.compilation.Builder method), \hyperpage{36}
+  \item do\_python\_script\_build() (src.compilation.Builder method), \hyperpage{37}
+  \item do\_script\_build() (src.compilation.Builder method), \hyperpage{37}
+  \item doctype() (src.ElementTree.XMLTreeBuilder method), \hyperpage{34}
+  \item DOWN() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+  \item dump() (in module src.ElementTree), \hyperpage{34}
+  \item dump() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item dumper() (in module src.catchAll), \hyperpage{35}
+  \item dumperType() (in module src.catchAll), \hyperpage{36}
+
+  \indexspace
+  \bigletter E
+  \item Element() (in module src.ElementTree), \hyperpage{34}
+  \item ElementTree (class in src.ElementTree), \hyperpage{34}
+  \item end() (src.ElementTree.TreeBuilder method), \hyperpage{34}
+  \item ensure\_path\_exists() (in module src.utilsSat), \hyperpage{68}
+  \item Environ (class in src.environment), \hyperpage{40}
+  \item erase\_line() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item erase\_screen() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item error() (in module src.utilsSat), \hyperpage{68}
+  \item evaluate() (src.pyconf.Container method), \hyperpage{60}
+  \item evaluate() (src.pyconf.Expression method), \hyperpage{60}
+  \item ExceptionSat, \hyperpage{44}
+  \item exclude\_VCS\_and\_extensions() (in module commands.package), \hyperpage{91}
+  \item exec\_command() (commands.jobs.Machine method), \hyperpage{85}
+  \item execute\_cli() (src.salomeTools.Sat method), \hyperpage{64}
+  \item exists() (src.utilsSat.Path method), \hyperpage{67}
+  \item Expression (class in src.pyconf), \hyperpage{60}
+  \item extend\_with\_children() (in module commands.compile), \hyperpage{76}
+  \item extend\_with\_fathers() (in module commands.compile), \hyperpage{76}
+  \item extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+
+  \indexspace
+  \bigletter F
+  \item feed() (src.ElementTree.XMLTreeBuilder method), \hyperpage{34}
+  \item FileEnviron (class in src.fileEnviron), \hyperpage{46}
+  \item FileEnvWriter (class in src.environment), \hyperpage{41}
+  \item find() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item find\_application\_pyconf() (in module commands.package), \hyperpage{91}
+  \item find\_command\_list() (in module src.salomeTools), \hyperpage{64}
+  \item find\_file\_in\_lpath() (in module src.utilsSat), \hyperpage{68}
+  \item find\_history() (commands.jobs.Gui method), \hyperpage{82}
+  \item find\_job\_that\_has\_name() (commands.jobs.Jobs method), \hyperpage{85}
+  \item find\_node\_by\_attrib() (in module src.xmlManager), \hyperpage{72}
+  \item find\_product\_scripts\_and\_pyconf() (in module commands.package), \hyperpage{91}
+  \item find\_products\_already\_getted() (in module commands.prepare), \hyperpage{95}
+  \item find\_products\_with\_patchs() (in module commands.prepare), \hyperpage{95}
+  \item find\_test\_log() (commands.jobs.Gui method), \hyperpage{82}
+  \item findall() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item findConfig() (src.pyconf.Reference method), \hyperpage{61}
+  \item findtext() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item finish() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item finish() (src.fileEnviron.BashFileEnviron method), \hyperpage{44}
+  \item finish() (src.fileEnviron.BatFileEnviron method), \hyperpage{45}
+  \item finish() (src.fileEnviron.ContextFileEnviron method), \hyperpage{46}
+  \item finish() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item finish() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item flush() (src.coloringSat.ColoringStream method), \hyperpage{36}
+  \item flush() (src.loggingSat.UnittestStream method), \hyperpage{50}
+  \item flush() (src.pyconf.ConfigOutputStream method), \hyperpage{58}
+  \item fore() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item format() (src.example.essai\_logging\_2.MyFormatter method), \hyperpage{33}
+  \item format() (src.loggingSat.DefaultFormatter method), \hyperpage{50}
+  \item format() (src.loggingSat.UnittestFormatter method), \hyperpage{50}
+  \item format\_color\_exception() (in module src.debug), \hyperpage{39}
+  \item format\_list\_of\_str() (in module commands.find\_duplicates), \hyperpage{79}
+  \item formatTuples() (in module src.utilsSat), \hyperpage{68}
+  \item formatValue() (in module src.utilsSat), \hyperpage{68}
+  \item FORWARD() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+  \item fromstring() (in module src.ElementTree), \hyperpage{34}
+
+  \indexspace
+  \bigletter G
+  \item generate\_application() (in module commands.application), \hyperpage{73}
+  \item generate\_catalog() (in module commands.application), \hyperpage{73}
+  \item generate\_catalog() (in module commands.launcher), \hyperpage{87}
+  \item generate\_component() (in module commands.generate), \hyperpage{80}
+  \item generate\_component\_list() (in module commands.generate), \hyperpage{81}
+  \item generate\_history\_xml\_path() (in module commands.test), \hyperpage{101}
+  \item generate\_launch\_file() (in module commands.application), \hyperpage{73}
+  \item generate\_launch\_file() (in module commands.launcher), \hyperpage{87}
+  \item generate\_launching\_commands() (src.test\_module.Test method), \hyperpage{66}
+  \item generate\_profile\_sources() (in module commands.profile), \hyperpage{96}
+  \item generate\_script() (src.test\_module.Test method), \hyperpage{66}
+  \item get() (src.environment.Environ method), \hyperpage{40}
+  \item get() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item get() (src.fileEnviron.BatFileEnviron method), \hyperpage{45}
+  \item get() (src.fileEnviron.ContextFileEnviron method), \hyperpage{46}
+  \item get() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item get() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item get() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item get() (src.pyconf.Mapping method), \hyperpage{61}
+  \item get\_all\_product\_sources() (in module commands.source), \hyperpage{98}
+  \item get\_archives() (in module commands.package), \hyperpage{92}
+  \item get\_archives\_vcs() (in module commands.package), \hyperpage{92}
+  \item get\_attrib() (src.xmlManager.ReadXmlFile method), \hyperpage{71}
+  \item get\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item get\_base\_install\_dir() (in module src.product), \hyperpage{52}
+  \item get\_base\_path() (in module src.utilsSat), \hyperpage{68}
+  \item get\_build\_directories() (in module commands.clean), \hyperpage{74}
+  \item get\_cfg\_param() (in module src.utilsSat), \hyperpage{68}
+  \item get\_children() (in module commands.compile), \hyperpage{76}
+  \item get\_command\_line\_overrides() (src.configManager.ConfigManager method), \hyperpage{37}
+  \item get\_config() (src.configManager.ConfigManager method), \hyperpage{37}
+  \item get\_config\_children() (in module src.configManager), \hyperpage{38}
+  \item get\_config\_file\_path() (in module commands.jobs), \hyperpage{86}
+  \item get\_dico\_param() (in module commands.template), \hyperpage{100}
+  \item get\_distrib\_version() (in module src.architecture), \hyperpage{35}
+  \item get\_distribution() (in module src.architecture), \hyperpage{35}
+  \item get\_file\_environ() (in module src.fileEnviron), \hyperpage{49}
+  \item get\_help() (src.options.Options method), \hyperpage{52}
+  \item get\_help() (src.salomeTools.Sat method), \hyperpage{64}
+  \item get\_install\_dir() (in module src.product), \hyperpage{52}
+  \item get\_install\_directories() (in module commands.clean), \hyperpage{74}
+  \item get\_last\_log\_file() (in module commands.log), \hyperpage{87}
+  \item get\_launcher\_name() (in module src.utilsSat), \hyperpage{69}
+  \item get\_log\_files() (commands.jobs.Job method), \hyperpage{83}
+  \item get\_log\_path() (in module src.utilsSat), \hyperpage{69}
+  \item get\_names() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item get\_nb\_proc() (in module commands.make), \hyperpage{88}
+  \item get\_nb\_proc() (in module src.architecture), \hyperpage{35}
+  \item get\_node\_text() (src.xmlManager.ReadXmlFile method), \hyperpage{71}
+  \item get\_parameters() (commands.template.TemplateSettings method), \hyperpage{100}
+  \item get\_path() (src.configManager.ConfigOpener method), \hyperpage{38}
+  \item get\_pids() (commands.jobs.Job method), \hyperpage{83}
+  \item get\_position() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item get\_product\_components() (in module src.product), \hyperpage{53}
+  \item get\_product\_config() (in module src.product), \hyperpage{53}
+  \item get\_product\_dependencies() (in module src.product), \hyperpage{53}
+  \item get\_product\_section() (in module src.product), \hyperpage{53}
+  \item get\_product\_sources() (in module commands.source), \hyperpage{98}
+  \item get\_products\_infos() (in module src.product), \hyperpage{53}
+  \item get\_products\_list() (in module commands.check), \hyperpage{74}
+  \item get\_products\_list() (in module commands.compile), \hyperpage{76}
+  \item get\_products\_list() (in module commands.configure), \hyperpage{78}
+  \item get\_products\_list() (in module commands.make), \hyperpage{88}
+  \item get\_products\_list() (in module commands.makeinstall), \hyperpage{89}
+  \item get\_products\_list() (in module commands.script), \hyperpage{97}
+  \item get\_products\_list() (in module src.configManager), \hyperpage{38}
+  \item get\_profile\_name() (in module commands.profile), \hyperpage{96}
+  \item get\_property\_in\_product\_cfg() (in module src.utilsSat), \hyperpage{69}
+  \item get\_pyconf\_parameters() (commands.template.TemplateSettings method), \hyperpage{100}
+  \item get\_python\_version() (in module src.architecture), \hyperpage{35}
+  \item get\_recursive\_children() (in module commands.compile), \hyperpage{76}
+  \item get\_recursive\_fathers() (in module commands.compile), \hyperpage{77}
+  \item get\_SALOME\_modules() (in module commands.application), \hyperpage{73}
+  \item get\_salome\_version() (in module src.utilsSat), \hyperpage{69}
+  \item get\_source\_directories() (in module commands.clean), \hyperpage{74}
+  \item get\_source\_for\_dev() (in module commands.source), \hyperpage{98}
+  \item get\_source\_from\_archive() (in module commands.source), \hyperpage{99}
+  \item get\_source\_from\_cvs() (in module commands.source), \hyperpage{99}
+  \item get\_source\_from\_dir() (in module commands.source), \hyperpage{99}
+  \item get\_source\_from\_git() (in module commands.source), \hyperpage{99}
+  \item get\_source\_from\_svn() (in module commands.source), \hyperpage{99}
+  \item get\_status() (commands.jobs.Job method), \hyperpage{83}
+  \item get\_step() (in module commands.application), \hyperpage{73}
+  \item get\_template\_info() (in module commands.template), \hyperpage{100}
+  \item get\_test\_timeout() (src.test\_module.Test method), \hyperpage{66}
+  \item get\_tmp\_dir() (src.test\_module.Test method), \hyperpage{66}
+  \item get\_tmp\_filename() (in module src.utilsSat), \hyperpage{69}
+  \item get\_user() (in module src.architecture), \hyperpage{35}
+  \item get\_user\_config\_file() (src.configManager.ConfigManager method), \hyperpage{37}
+  \item get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item getByPath() (src.pyconf.Config method), \hyperpage{57}
+  \item getByPath() (src.pyconf.ConfigList method), \hyperpage{57}
+  \item getChar() (src.pyconf.ConfigReader method), \hyperpage{58}
+  \item getColoredVersion() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getCommandAndAppli() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getCommandInstance() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getCommandsList() (in module src.salomeTools), \hyperpage{64}
+  \item getConfig() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getConfigColored() (in module src.configManager), \hyperpage{38}
+  \item getConfigManager() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getDefaultLogger() (in module src.loggingSat), \hyperpage{51}
+  \item getDetailOption() (src.options.Options method), \hyperpage{51}
+  \item getiterator() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item getLocalEnv() (in module src.debug), \hyperpage{39}
+  \item getLogger() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getLogs() (src.loggingSat.UnittestStream method), \hyperpage{50}
+  \item getLogsAndClear() (src.loggingSat.UnittestStream method), \hyperpage{51}
+  \item getMaxFormat() (in module commands.log), \hyperpage{87}
+  \item getModule() (src.salomeTools.Sat method), \hyperpage{64}
+  \item getMyLogger() (in module src.example.essai\_logging\_1), \hyperpage{33}
+  \item getMyLogger() (in module src.example.essai\_logging\_2), \hyperpage{33}
+  \item getParamiko() (in module commands.jobs), \hyperpage{86}
+  \item getParser() (commands.application.Command method), \hyperpage{72}
+  \item getParser() (commands.check.Command method), \hyperpage{73}
+  \item getParser() (commands.clean.Command method), \hyperpage{74}
+  \item getParser() (commands.compile.Command method), \hyperpage{75}
+  \item getParser() (commands.config.Command method), \hyperpage{77}
+  \item getParser() (commands.configure.Command method), \hyperpage{78}
+  \item getParser() (commands.environ.Command method), \hyperpage{79}
+  \item getParser() (commands.find\_duplicates.Command method), \hyperpage{79}
+  \item getParser() (commands.generate.Command method), \hyperpage{80}
+  \item getParser() (commands.init.Command method), \hyperpage{81}
+  \item getParser() (commands.job.Command method), \hyperpage{81}
+  \item getParser() (commands.jobs.Command method), \hyperpage{82}
+  \item getParser() (commands.launcher.Command method), \hyperpage{86}
+  \item getParser() (commands.log.Command method), \hyperpage{87}
+  \item getParser() (commands.make.Command method), \hyperpage{88}
+  \item getParser() (commands.makeinstall.Command method), \hyperpage{89}
+  \item getParser() (commands.package.Command method), \hyperpage{90}
+  \item getParser() (commands.patch.Command method), \hyperpage{94}
+  \item getParser() (commands.prepare.Command method), \hyperpage{95}
+  \item getParser() (commands.profile.Command method), \hyperpage{95}
+  \item getParser() (commands.run.Command method), \hyperpage{96}
+  \item getParser() (commands.script.Command method), \hyperpage{96}
+  \item getParser() (commands.shell.Command method), \hyperpage{97}
+  \item getParser() (commands.source.Command method), \hyperpage{98}
+  \item getParser() (commands.template.Command method), \hyperpage{100}
+  \item getParser() (commands.test.Command method), \hyperpage{101}
+  \item getroot() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item getRootAttrib() (src.xmlManager.ReadXmlFile method), \hyperpage{70}
+  \item getStrConfigDbg() (in module src.debug), \hyperpage{39}
+  \item getStrConfigStd() (in module src.debug), \hyperpage{39}
+  \item getTmpDirDEFAULT() (in module src.test\_module), \hyperpage{67}
+  \item getToken() (src.pyconf.ConfigReader method), \hyperpage{58}
+  \item getUnittestLogger() (in module src.loggingSat), \hyperpage{51}
+  \item getValue() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item getVersion() (in module src.salomeTools), \hyperpage{64}
+  \item getWhy() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item git\_extract() (in module src.system), \hyperpage{65}
+  \item GREEN (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item GREEN (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item GREEN (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item green() (in module src.utilsSat), \hyperpage{69}
+  \item GREY (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item Gui (class in commands.jobs), \hyperpage{82}
+
+  \indexspace
+  \bigletter H
+  \item hack\_for\_distene\_licence() (in module commands.package), \hyperpage{92}
+  \item hack\_libtool() (src.compilation.Builder method), \hyperpage{37}
+  \item handleMismatch() (src.pyconf.ConfigMerger method), \hyperpage{57}
+  \item handleRemoveReadonly() (in module src.utilsSat), \hyperpage{69}
+  \item has\_begun() (commands.jobs.Job method), \hyperpage{83}
+  \item has\_failed() (commands.jobs.Job method), \hyperpage{83}
+  \item has\_finished() (commands.jobs.Job method), \hyperpage{84}
+  \item has\_pyconf() (commands.template.TemplateSettings method), \hyperpage{100}
+  \item header() (in module src.utilsSat), \hyperpage{69}
+
+  \indexspace
+  \bigletter I
+  \item indent() (in module src.coloringSat), \hyperpage{36}
+  \item indent() (in module src.debug), \hyperpage{39}
+  \item indent() (in module src.loggingSat), \hyperpage{51}
+  \item indent() (src.options.Options method), \hyperpage{52}
+  \item indent() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item indentUnittest() (in module src.loggingSat), \hyperpage{51}
+  \item info() (in module src.utilsSat), \hyperpage{69}
+  \item init() (in module src.colorama.initialise), \hyperpage{31}
+  \item initialize\_boards() (commands.jobs.Gui method), \hyperpage{82}
+  \item initLoggerAsDefault() (in module src.loggingSat), \hyperpage{51}
+  \item initLoggerAsUnittest() (in module src.loggingSat), \hyperpage{51}
+  \item initMyLogger() (in module src.example.essai\_logging\_1), \hyperpage{33}
+  \item initMyLogger() (in module src.example.essai\_logging\_2), \hyperpage{33}
+  \item install() (src.compilation.Builder method), \hyperpage{37}
+  \item InStream (class in src.debug), \hyperpage{39}
+  \item is\_a\_tty() (in module src.colorama.ansitowin32), \hyperpage{31}
+  \item is\_defined() (src.environment.Environ method), \hyperpage{40}
+  \item is\_defined() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item is\_defined() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item is\_defined() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item is\_defined() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item is\_occupied() (commands.jobs.Jobs method), \hyperpage{85}
+  \item is\_running() (commands.jobs.Job method), \hyperpage{84}
+  \item is\_stream\_closed() (in module src.colorama.ansitowin32), \hyperpage{31}
+  \item is\_timeout() (commands.jobs.Job method), \hyperpage{84}
+  \item is\_windows() (in module src.architecture), \hyperpage{35}
+  \item isdir() (src.utilsSat.Path method), \hyperpage{67}
+  \item iselement() (in module src.ElementTree), \hyperpage{34}
+  \item isfile() (src.utilsSat.Path method), \hyperpage{67}
+  \item islink() (src.utilsSat.Path method), \hyperpage{67}
+  \item isOk() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item isTypeConfig() (in module src.debug), \hyperpage{39}
+  \item isWord() (in module src.pyconf), \hyperpage{62}
+  \item iteritems() (src.pyconf.Mapping method), \hyperpage{61}
+  \item iterkeys() (src.pyconf.Mapping method), \hyperpage{61}
+  \item iterparse (class in src.ElementTree), \hyperpage{34}
+
+  \indexspace
+  \bigletter J
+  \item Job (class in commands.jobs), \hyperpage{83}
+  \item Jobs (class in commands.jobs), \hyperpage{84}
+  \item jsonDumps() (in module src.catchAll), \hyperpage{36}
+  \item jsonDumps() (src.catchAll.CatchAll method), \hyperpage{35}
+
+  \indexspace
+  \bigletter K
+  \item keys() (src.pyconf.Mapping method), \hyperpage{61}
+  \item KFSYS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item kill\_remote\_process() (commands.jobs.Job method), \hyperpage{84}
+  \item KNOWNFAILURE\_STATUS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item KO\_STATUS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item KOSYS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+
+  \indexspace
+  \bigletter L
+  \item label() (in module src.utilsSat), \hyperpage{69}
+  \item last\_update() (commands.jobs.Gui method), \hyperpage{82}
+  \item launch\_command() (in module src.fork), \hyperpage{49}
+  \item LauncherFileEnviron (class in src.fileEnviron), \hyperpage{47}
+  \item launchSat() (in module src.salomeTools), \hyperpage{64}
+  \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item list() (src.utilsSat.Path method), \hyperpage{67}
+  \item list\_directory() (in module commands.find\_duplicates), \hyperpage{80}
+  \item list\_log\_file() (in module src.utilsSat), \hyperpage{69}
+  \item load() (src.pyconf.Config method), \hyperpage{57}
+  \item load() (src.pyconf.ConfigReader method), \hyperpage{58}
+  \item load\_cfg\_environment() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item load\_environment() (in module src.environment), \hyperpage{43}
+  \item location() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item log() (in module src.coloringSat), \hyperpage{36}
+  \item log() (in module src.loggingSat), \hyperpage{51}
+  \item log() (src.compilation.Builder method), \hyperpage{37}
+  \item log\_command() (src.compilation.Builder method), \hyperpage{37}
+  \item log\_res\_step() (in module src.utilsSat), \hyperpage{69}
+  \item log\_step() (in module src.utilsSat), \hyperpage{69}
+  \item logger\_info\_tuples() (in module src.utilsSat), \hyperpage{69}
+
+  \indexspace
+  \bigletter M
+  \item Machine (class in commands.jobs), \hyperpage{85}
+  \item MAGENTA (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item MAGENTA (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item MAGENTA (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item magenta() (in module src.utilsSat), \hyperpage{69}
+  \item make() (src.compilation.Builder method), \hyperpage{37}
+  \item make() (src.utilsSat.Path method), \hyperpage{67}
+  \item make\_alias() (in module commands.application), \hyperpage{73}
+  \item make\_all\_products() (in module commands.make), \hyperpage{88}
+  \item make\_archive() (in module commands.package), \hyperpage{92}
+  \item make\_product() (in module commands.make), \hyperpage{89}
+  \item makeinstall\_all\_products() (in module commands.makeinstall), \hyperpage{89}
+  \item makeinstall\_product() (in module commands.makeinstall), \hyperpage{90}
+  \item makePath() (in module src.pyconf), \hyperpage{62}
+  \item Mapping (class in src.pyconf), \hyperpage{60}
+  \item match() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item merge() (src.pyconf.ConfigMerger method), \hyperpage{58}
+  \item merge\_dicts() (in module src.utilsSat), \hyperpage{69}
+  \item mergeMapping() (src.pyconf.ConfigMerger method), \hyperpage{58}
+  \item mergeSequence() (src.pyconf.ConfigMerger method), \hyperpage{58}
+  \item mkdir() (commands.jobs.Machine method), \hyperpage{86}
+  \item move\_test\_results() (in module commands.test), \hyperpage{101}
+  \item MyFormatter (class in src.example.essai\_logging\_2), \hyperpage{33}
+  \item MyTemplate (class in src.template), \hyperpage{66}
+
+  \indexspace
+  \bigletter N
+  \item NA\_STATUS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item name (commands.application.Command attribute), \hyperpage{72}
+  \item name (commands.check.Command attribute), \hyperpage{73}
+  \item name (commands.clean.Command attribute), \hyperpage{74}
+  \item name (commands.compile.Command attribute), \hyperpage{75}
+  \item name (commands.config.Command attribute), \hyperpage{77}
+  \item name (commands.configure.Command attribute), \hyperpage{78}
+  \item name (commands.environ.Command attribute), \hyperpage{79}
+  \item name (commands.find\_duplicates.Command attribute), \hyperpage{79}
+  \item name (commands.generate.Command attribute), \hyperpage{80}
+  \item name (commands.init.Command attribute), \hyperpage{81}
+  \item name (commands.job.Command attribute), \hyperpage{81}
+  \item name (commands.jobs.Command attribute), \hyperpage{82}
+  \item name (commands.launcher.Command attribute), \hyperpage{86}
+  \item name (commands.log.Command attribute), \hyperpage{87}
+  \item name (commands.make.Command attribute), \hyperpage{88}
+  \item name (commands.makeinstall.Command attribute), \hyperpage{89}
+  \item name (commands.package.Command attribute), \hyperpage{90}
+  \item name (commands.patch.Command attribute), \hyperpage{94}
+  \item name (commands.prepare.Command attribute), \hyperpage{95}
+  \item name (commands.profile.Command attribute), \hyperpage{96}
+  \item name (commands.run.Command attribute), \hyperpage{96}
+  \item name (commands.script.Command attribute), \hyperpage{97}
+  \item name (commands.shell.Command attribute), \hyperpage{97}
+  \item name (commands.source.Command attribute), \hyperpage{98}
+  \item name (commands.template.Command attribute), \hyperpage{100}
+  \item name (commands.test.Command attribute), \hyperpage{101}
+  \item NASYS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item NDSYS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item next() (src.ElementTree.iterparse method), \hyperpage{34}
+  \item next() (src.pyconf.Sequence.SeqIter method), \hyperpage{61}
+  \item NORMAL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+  \item NORMAL (src.colorama.winterm.WinStyle attribute), \hyperpage{32}
+  \item normal() (in module src.utilsSat), \hyperpage{69}
+
+  \indexspace
+  \bigletter O
+  \item OK\_STATUS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item OKSYS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item only\_numbers() (in module src.utilsSat), \hyperpage{69}
+  \item Options (class in src.options), \hyperpage{51}
+  \item OptResult (class in src.options), \hyperpage{51}
+  \item OutStream (class in src.debug), \hyperpage{39}
+  \item overwriteKeys() (src.pyconf.ConfigMerger method), \hyperpage{58}
+  \item overwriteMergeResolve() (in module src.pyconf), \hyperpage{62}
+
+  \indexspace
+  \bigletter P
+  \item parse() (in module src.ElementTree), \hyperpage{34}
+  \item parse() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item parse\_args() (src.options.Options method), \hyperpage{52}
+  \item parse\_csv\_boards() (commands.jobs.Gui method), \hyperpage{82}
+  \item parse\_date() (in module src.utilsSat), \hyperpage{69}
+  \item parseArguments() (src.salomeTools.Sat method), \hyperpage{64}
+  \item parseFactor() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseKeyValuePair() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseMapping() (commands.profile.profileConfigReader method), \hyperpage{96}
+  \item parseMapping() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseMappingBody() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseReference() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseScalar() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseSequence() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseSuffix() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseTerm() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item parseValue() (src.pyconf.ConfigReader method), \hyperpage{59}
+  \item Path (class in src.utilsSat), \hyperpage{67}
+  \item pattern (src.template.MyTemplate attribute), \hyperpage{66}
+  \item PI() (in module src.ElementTree), \hyperpage{34}
+  \item pop\_debug() (in module src.debug), \hyperpage{39}
+  \item POS() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+  \item prepare() (src.compilation.Builder method), \hyperpage{37}
+  \item prepare\_from\_template() (in module commands.template), \hyperpage{100}
+  \item prepare\_testbase() (src.test\_module.Test method), \hyperpage{66}
+  \item prepare\_testbase\_from\_dir() (src.test\_module.Test method), \hyperpage{66}
+  \item prepare\_testbase\_from\_git() (src.test\_module.Test method), \hyperpage{66}
+  \item prepare\_testbase\_from\_svn() (src.test\_module.Test method), \hyperpage{66}
+  \item prepend() (src.environment.Environ method), \hyperpage{40}
+  \item prepend() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item prepend() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item prepend() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item prepend() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item prepend\_value() (src.environment.Environ method), \hyperpage{41}
+  \item prepend\_value() (src.fileEnviron.ContextFileEnviron method), \hyperpage{46}
+  \item prepend\_value() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item prepend\_value() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{48}
+  \item print\_debug() (in module src.configManager), \hyperpage{38}
+  \item print\_grep\_environs() (in module src.environs), \hyperpage{44}
+  \item print\_help() (src.salomeTools.Sat method), \hyperpage{64}
+  \item print\_log\_command\_in\_terminal() (in module commands.log), \hyperpage{88}
+  \item print\_split\_environs() (in module src.environs), \hyperpage{44}
+  \item print\_split\_pattern\_environs() (in module src.environs), \hyperpage{44}
+  \item print\_value() (in module src.configManager), \hyperpage{38}
+  \item ProcessingInstruction() (in module src.ElementTree), \hyperpage{34}
+  \item produce\_install\_bin\_file() (in module commands.package), \hyperpage{93}
+  \item produce\_relative\_env\_files() (in module commands.package), \hyperpage{93}
+  \item produce\_relative\_launcher() (in module commands.package), \hyperpage{93}
+  \item product\_appli\_creation\_script() (in module commands.package), \hyperpage{93}
+  \item product\_compiles() (in module src.product), \hyperpage{53}
+  \item product\_has\_dir() (in module commands.clean), \hyperpage{75}
+  \item product\_has\_env\_script() (in module src.product), \hyperpage{54}
+  \item product\_has\_logo() (in module src.product), \hyperpage{54}
+  \item product\_has\_patches() (in module src.product), \hyperpage{54}
+  \item product\_has\_salome\_gui() (in module src.product), \hyperpage{54}
+  \item product\_has\_script() (in module src.product), \hyperpage{54}
+  \item product\_is\_autotools() (in module src.product), \hyperpage{54}
+  \item product\_is\_cmake() (in module src.product), \hyperpage{54}
+  \item product\_is\_cpp() (in module src.product), \hyperpage{54}
+  \item product\_is\_debug() (in module src.product), \hyperpage{54}
+  \item product\_is\_dev() (in module src.product), \hyperpage{54}
+  \item product\_is\_fixed() (in module src.product), \hyperpage{55}
+  \item product\_is\_generated() (in module src.product), \hyperpage{55}
+  \item product\_is\_mpi() (in module src.product), \hyperpage{55}
+  \item product\_is\_native() (in module src.product), \hyperpage{55}
+  \item product\_is\_SALOME() (in module src.product), \hyperpage{54}
+  \item product\_is\_salome() (in module src.product), \hyperpage{55}
+  \item product\_is\_sample() (in module src.product), \hyperpage{55}
+  \item product\_is\_smesh\_plugin() (in module src.product), \hyperpage{55}
+  \item product\_is\_vcs() (in module src.product), \hyperpage{55}
+  \item profileConfigReader (class in commands.profile), \hyperpage{96}
+  \item profileReference (class in commands.profile), \hyperpage{96}
+  \item Progress\_bar (class in commands.find\_duplicates), \hyperpage{79}
+  \item project\_package() (in module commands.package), \hyperpage{93}
+  \item push\_debug() (in module src.debug), \hyperpage{40}
+  \item put\_dir() (commands.jobs.Machine method), \hyperpage{86}
+  \item put\_jobs\_not\_today() (commands.jobs.Gui method), \hyperpage{83}
+  \item put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method), \hyperpage{37}
+
+  \indexspace
+  \bigletter Q
+  \item QName (class in src.ElementTree), \hyperpage{34}
+
+  \indexspace
+  \bigletter R
+  \item raiseIfKo() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item read() (src.pyconf.ConfigInputStream method), \hyperpage{57}
+  \item read\_config\_from\_a\_file() (in module src.utilsSat), \hyperpage{69}
+  \item read\_results() (src.test\_module.Test method), \hyperpage{66}
+  \item readline() (src.pyconf.ConfigInputStream method), \hyperpage{57}
+  \item readlink() (src.utilsSat.Path method), \hyperpage{67}
+  \item ReadXmlFile (class in src.xmlManager), \hyperpage{70}
+  \item RED (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item RED (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item RED (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item red() (in module src.utilsSat), \hyperpage{69}
+  \item Reference (class in src.pyconf), \hyperpage{61}
+  \item reinit() (in module src.colorama.initialise), \hyperpage{31}
+  \item remove\_item\_from\_list() (in module src.utilsSat), \hyperpage{69}
+  \item remove\_log\_file() (in module commands.log), \hyperpage{88}
+  \item remove\_products() (in module commands.prepare), \hyperpage{95}
+  \item removeNamespace() (src.pyconf.Config method), \hyperpage{57}
+  \item replace() (in module src.coloringSat), \hyperpage{36}
+  \item replace\_in\_file() (in module src.utilsSat), \hyperpage{70}
+  \item RESET (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item RESET (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item reset() (in module src.utilsSat), \hyperpage{70}
+  \item RESET\_ALL (src.colorama.ansi.AnsiStyle attribute), \hyperpage{30}
+  \item reset\_all() (in module src.colorama.initialise), \hyperpage{31}
+  \item reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item reset\_all() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item resolve() (src.pyconf.Reference method), \hyperpage{61}
+  \item ReturnCode (class in src.returnCode), \hyperpage{63}
+  \item rm() (src.utilsSat.Path method), \hyperpage{67}
+  \item run() (commands.application.Command method), \hyperpage{72}
+  \item run() (commands.check.Command method), \hyperpage{73}
+  \item run() (commands.clean.Command method), \hyperpage{74}
+  \item run() (commands.compile.Command method), \hyperpage{75}
+  \item run() (commands.config.Command method), \hyperpage{77}
+  \item run() (commands.configure.Command method), \hyperpage{78}
+  \item run() (commands.environ.Command method), \hyperpage{79}
+  \item run() (commands.find\_duplicates.Command method), \hyperpage{79}
+  \item run() (commands.generate.Command method), \hyperpage{80}
+  \item run() (commands.init.Command method), \hyperpage{81}
+  \item run() (commands.job.Command method), \hyperpage{81}
+  \item run() (commands.jobs.Command method), \hyperpage{82}
+  \item run() (commands.jobs.Job method), \hyperpage{84}
+  \item run() (commands.launcher.Command method), \hyperpage{86}
+  \item run() (commands.log.Command method), \hyperpage{87}
+  \item run() (commands.make.Command method), \hyperpage{88}
+  \item run() (commands.makeinstall.Command method), \hyperpage{89}
+  \item run() (commands.package.Command method), \hyperpage{90}
+  \item run() (commands.patch.Command method), \hyperpage{94}
+  \item run() (commands.prepare.Command method), \hyperpage{95}
+  \item run() (commands.profile.Command method), \hyperpage{96}
+  \item run() (commands.run.Command method), \hyperpage{96}
+  \item run() (commands.script.Command method), \hyperpage{97}
+  \item run() (commands.shell.Command method), \hyperpage{97}
+  \item run() (commands.source.Command method), \hyperpage{98}
+  \item run() (commands.template.Command method), \hyperpage{100}
+  \item run() (commands.test.Command method), \hyperpage{101}
+  \item run\_all\_tests() (src.test\_module.Test method), \hyperpage{66}
+  \item run\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item run\_env\_script() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item run\_grid\_tests() (src.test\_module.Test method), \hyperpage{66}
+  \item run\_jobs() (commands.jobs.Jobs method), \hyperpage{85}
+  \item run\_script() (src.test\_module.Test method), \hyperpage{66}
+  \item run\_script\_all\_products() (in module commands.script), \hyperpage{97}
+  \item run\_script\_of\_product() (in module commands.script), \hyperpage{97}
+  \item run\_session\_tests() (src.test\_module.Test method), \hyperpage{66}
+  \item run\_simple\_env\_script() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item run\_testbase\_tests() (src.test\_module.Test method), \hyperpage{66}
+  \item run\_tests() (src.test\_module.Test method), \hyperpage{66}
+
+  \indexspace
+  \bigletter S
+  \item SalomeEnviron (class in src.environment), \hyperpage{41}
+  \item Sat (class in src.salomeTools), \hyperpage{64}
+  \item save\_file() (in module commands.test), \hyperpage{101}
+  \item saveConfigDbg() (in module src.debug), \hyperpage{40}
+  \item saveConfigStd() (in module src.debug), \hyperpage{40}
+  \item ScreenEnviron (class in src.fileEnviron), \hyperpage{49}
+  \item search\_known\_errors() (src.test\_module.Test method), \hyperpage{66}
+  \item search\_template() (in module commands.template), \hyperpage{100}
+  \item Sequence (class in src.pyconf), \hyperpage{61}
+  \item Sequence.SeqIter (class in src.pyconf), \hyperpage{61}
+  \item set() (src.environment.Environ method), \hyperpage{41}
+  \item set() (src.environment.SalomeEnviron method), \hyperpage{42}
+  \item set() (src.fileEnviron.BashFileEnviron method), \hyperpage{44}
+  \item set() (src.fileEnviron.BatFileEnviron method), \hyperpage{45}
+  \item set() (src.fileEnviron.ContextFileEnviron method), \hyperpage{46}
+  \item set() (src.fileEnviron.FileEnviron method), \hyperpage{47}
+  \item set() (src.fileEnviron.LauncherFileEnviron method), \hyperpage{49}
+  \item set() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item set\_a\_product() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_application\_env() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_attrs() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item set\_console() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item set\_cpp\_env() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_cursor\_position() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item set\_full\_environ() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_local\_value() (in module commands.init), \hyperpage{81}
+  \item set\_products() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_python\_libdirs() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method), \hyperpage{43}
+  \item set\_title() (in module src.colorama.ansi), \hyperpage{30}
+  \item set\_title() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item set\_user\_config\_file() (src.configManager.ConfigManager method), \hyperpage{38}
+  \item setColorLevelname() (src.loggingSat.DefaultFormatter method), \hyperpage{50}
+  \item SetConsoleTextAttribute() (in module src.colorama.win32), \hyperpage{32}
+  \item setLocale() (in module src.salomeTools), \hyperpage{64}
+  \item setNotLocale() (in module src.salomeTools), \hyperpage{64}
+  \item setPath() (src.pyconf.Container method), \hyperpage{60}
+  \item setStatus() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item setStream() (src.pyconf.ConfigReader method), \hyperpage{60}
+  \item setValue() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item setWhy() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item Shell (class in src.environment), \hyperpage{43}
+  \item should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item show\_command\_log() (in module src.utilsSat), \hyperpage{70}
+  \item show\_in\_editor() (in module src.system), \hyperpage{65}
+  \item show\_last\_logs() (in module commands.log), \hyperpage{88}
+  \item show\_patchs() (in module src.configManager), \hyperpage{39}
+  \item show\_product\_info() (in module src.configManager), \hyperpage{39}
+  \item show\_product\_last\_logs() (in module commands.log), \hyperpage{88}
+  \item show\_progress() (in module src.fork), \hyperpage{50}
+  \item smartcopy() (src.utilsSat.Path method), \hyperpage{67}
+  \item sort\_products() (in module commands.compile), \hyperpage{77}
+  \item source\_package() (in module commands.package), \hyperpage{94}
+  \item special\_path\_separator() (in module src.fileEnviron), \hyperpage{49}
+  \item src (module), \hyperpage{72}
+  \item src.architecture (module), \hyperpage{35}
+  \item src.catchAll (module), \hyperpage{35}
+  \item src.colorama (module), \hyperpage{33}
+  \item src.colorama.ansi (module), \hyperpage{29}
+  \item src.colorama.ansitowin32 (module), \hyperpage{31}
+  \item src.colorama.initialise (module), \hyperpage{31}
+  \item src.colorama.win32 (module), \hyperpage{32}
+  \item src.colorama.winterm (module), \hyperpage{32}
+  \item src.coloringSat (module), \hyperpage{36}
+  \item src.compilation (module), \hyperpage{36}
+  \item src.configManager (module), \hyperpage{37}
+  \item src.debug (module), \hyperpage{39}
+  \item src.ElementTree (module), \hyperpage{34}
+  \item src.environment (module), \hyperpage{40}
+  \item src.environs (module), \hyperpage{44}
+  \item src.example (module), \hyperpage{34}
+  \item src.example.essai\_logging\_1 (module), \hyperpage{33}
+  \item src.example.essai\_logging\_2 (module), \hyperpage{33}
+  \item src.exceptionSat (module), \hyperpage{44}
+  \item src.fileEnviron (module), \hyperpage{44}
+  \item src.fork (module), \hyperpage{49}
+  \item src.loggingSat (module), \hyperpage{50}
+  \item src.options (module), \hyperpage{51}
+  \item src.product (module), \hyperpage{52}
+  \item src.pyconf (module), \hyperpage{55}
+  \item src.returnCode (module), \hyperpage{63}
+  \item src.salomeTools (module), \hyperpage{64}
+  \item src.system (module), \hyperpage{65}
+  \item src.template (module), \hyperpage{66}
+  \item src.test\_module (module), \hyperpage{66}
+  \item src.utilsSat (module), \hyperpage{67}
+  \item src.xmlManager (module), \hyperpage{70}
+  \item ssh\_connection\_all\_machines() (commands.jobs.Jobs method), \hyperpage{85}
+  \item start() (src.ElementTree.TreeBuilder method), \hyperpage{34}
+  \item str\_of\_length() (commands.jobs.Jobs method), \hyperpage{85}
+  \item StreamWrapper (class in src.colorama.ansitowin32), \hyperpage{31}
+  \item style() (src.colorama.winterm.WinTerm method), \hyperpage{32}
+  \item SubElement() (in module src.ElementTree), \hyperpage{34}
+  \item substitute() (in module src.template), \hyperpage{66}
+  \item success() (in module src.utilsSat), \hyperpage{70}
+  \item successfully\_connected() (commands.jobs.Machine method), \hyperpage{86}
+  \item suppress\_directories() (in module commands.clean), \hyperpage{75}
+  \item svn\_extract() (in module src.system), \hyperpage{65}
+  \item symlink() (src.utilsSat.Path method), \hyperpage{67}
+
+  \indexspace
+  \bigletter T
+  \item TemplateSettings (class in commands.template), \hyperpage{100}
+  \item Test (class in src.test\_module), \hyperpage{66}
+  \item testLogger1() (in module src.example.essai\_logging\_1), \hyperpage{33}
+  \item testLogger1() (in module src.example.essai\_logging\_2), \hyperpage{33}
+  \item testLogger\_1() (in module src.loggingSat), \hyperpage{51}
+  \item time\_elapsed() (commands.jobs.Job method), \hyperpage{84}
+  \item timedelta\_total\_seconds() (in module src.utilsSat), \hyperpage{70}
+  \item TIMEOUT\_STATUS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item toColor() (in module src.coloringSat), \hyperpage{36}
+  \item toColor\_AnsiToWin32() (in module src.coloringSat), \hyperpage{36}
+  \item tofix() (in module src.debug), \hyperpage{40}
+  \item tostring() (in module src.ElementTree), \hyperpage{34}
+  \item TOSYS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item toSys() (src.returnCode.ReturnCode method), \hyperpage{63}
+  \item total\_duration() (commands.jobs.Job method), \hyperpage{84}
+  \item TParam (class in commands.template), \hyperpage{100}
+  \item TreeBuilder (class in src.ElementTree), \hyperpage{34}
+
+  \indexspace
+  \bigletter U
+  \item UnittestFormatter (class in src.loggingSat), \hyperpage{50}
+  \item UnittestStream (class in src.loggingSat), \hyperpage{50}
+  \item UNKNOWN\_STATUS (src.returnCode.ReturnCode attribute), \hyperpage{63}
+  \item UP() (src.colorama.ansi.AnsiCursor method), \hyperpage{30}
+  \item update\_config() (in module commands.package), \hyperpage{94}
+  \item update\_hat\_xml() (in module src.utilsSat), \hyperpage{70}
+  \item update\_jobs\_states\_list() (commands.jobs.Jobs method), \hyperpage{85}
+  \item update\_pyconf() (in module commands.profile), \hyperpage{96}
+  \item update\_xml\_file() (commands.jobs.Gui method), \hyperpage{83}
+  \item update\_xml\_files() (commands.jobs.Gui method), \hyperpage{83}
+
+  \indexspace
+  \bigletter W
+  \item warning() (in module src.utilsSat), \hyperpage{70}
+  \item WHITE (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item WHITE (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item white() (in module src.utilsSat), \hyperpage{70}
+  \item winapi\_test() (in module src.colorama.win32), \hyperpage{32}
+  \item WinColor (class in src.colorama.winterm), \hyperpage{32}
+  \item WinStyle (class in src.colorama.winterm), \hyperpage{32}
+  \item WinTerm (class in src.colorama.winterm), \hyperpage{32}
+  \item wmake() (src.compilation.Builder method), \hyperpage{37}
+  \item wrap\_stream() (in module src.colorama.initialise), \hyperpage{31}
+  \item write() (in module src.debug), \hyperpage{40}
+  \item write() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item write() (src.colorama.ansitowin32.StreamWrapper method), \hyperpage{31}
+  \item write() (src.coloringSat.ColoringStream method), \hyperpage{36}
+  \item write() (src.ElementTree.ElementTree method), \hyperpage{34}
+  \item write() (src.fileEnviron.ScreenEnviron method), \hyperpage{49}
+  \item write() (src.loggingSat.UnittestStream method), \hyperpage{51}
+  \item write() (src.pyconf.ConfigOutputStream method), \hyperpage{58}
+  \item write\_all\_results() (commands.jobs.Jobs method), \hyperpage{85}
+  \item write\_all\_source\_files() (in module commands.environ), \hyperpage{79}
+  \item write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item write\_back() (in module src.fork), \hyperpage{50}
+  \item write\_cfgForPy\_file() (src.environment.FileEnvWriter method), \hyperpage{41}
+  \item write\_env\_file() (src.environment.FileEnvWriter method), \hyperpage{41}
+  \item write\_info() (commands.jobs.Machine method), \hyperpage{86}
+  \item write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method), \hyperpage{31}
+  \item write\_report() (in module src.xmlManager), \hyperpage{72}
+  \item write\_results() (commands.jobs.Job method), \hyperpage{84}
+  \item write\_test\_margin() (src.test\_module.Test method), \hyperpage{66}
+  \item write\_tree() (src.xmlManager.XmlLogFile method), \hyperpage{71}
+  \item write\_xml\_file() (commands.jobs.Gui method), \hyperpage{83}
+  \item write\_xml\_files() (commands.jobs.Gui method), \hyperpage{83}
+  \item writeToStream() (src.pyconf.Container method), \hyperpage{60}
+  \item writeToStream() (src.pyconf.Mapping method), \hyperpage{61}
+  \item writeToStream() (src.pyconf.Sequence method), \hyperpage{62}
+  \item writeValue() (src.pyconf.Container method), \hyperpage{60}
+
+  \indexspace
+  \bigletter X
+  \item XML() (in module src.ElementTree), \hyperpage{34}
+  \item XmlLogFile (class in src.xmlManager), \hyperpage{71}
+  \item XMLTreeBuilder (class in src.ElementTree), \hyperpage{34}
+
+  \indexspace
+  \bigletter Y
+  \item YELLOW (src.colorama.ansi.AnsiBack attribute), \hyperpage{29}
+  \item YELLOW (src.colorama.ansi.AnsiFore attribute), \hyperpage{30}
+  \item YELLOW (src.colorama.winterm.WinColor attribute), \hyperpage{32}
+  \item yellow() (in module src.utilsSat), \hyperpage{70}
+
+\end{sphinxtheindex}
diff --git a/doc/build/latex/salomeTools.out b/doc/build/latex/salomeTools.out
new file mode 100644
index 0000000..696903d
--- /dev/null
+++ b/doc/build/latex/salomeTools.out
@@ -0,0 +1,24 @@
+\BOOKMARK [0][-]{chapter.1}{\376\377\000Q\000u\000i\000c\000k\000\040\000s\000t\000a\000r\000t}{}% 1
+\BOOKMARK [1][-]{section.1.1}{\376\377\000I\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{chapter.1}% 2
+\BOOKMARK [1][-]{section.1.2}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n}{chapter.1}% 3
+\BOOKMARK [1][-]{section.1.3}{\376\377\000U\000s\000a\000g\000e\000\040\000o\000f\000\040\000S\000A\000l\000o\000m\000e\000T\000o\000o\000l\000s}{chapter.1}% 4
+\BOOKMARK [0][-]{chapter.2}{\376\377\000L\000i\000s\000t\000\040\000o\000f\000\040\000C\000o\000m\000m\000a\000n\000d\000s}{}% 5
+\BOOKMARK [1][-]{section.2.1}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000n\000f\000i\000g}{chapter.2}% 6
+\BOOKMARK [1][-]{section.2.2}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000r\000e\000p\000a\000r\000e}{chapter.2}% 7
+\BOOKMARK [1][-]{section.2.3}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000o\000m\000p\000i\000l\000e}{chapter.2}% 8
+\BOOKMARK [1][-]{section.2.4}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000a\000u\000n\000c\000h\000e\000r}{chapter.2}% 9
+\BOOKMARK [1][-]{section.2.5}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000a\000p\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.2}% 10
+\BOOKMARK [1][-]{section.2.6}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000o\000g}{chapter.2}% 11
+\BOOKMARK [1][-]{section.2.7}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000e\000n\000v\000i\000r\000o\000n}{chapter.2}% 12
+\BOOKMARK [1][-]{section.2.8}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000c\000l\000e\000a\000n}{chapter.2}% 13
+\BOOKMARK [1][-]{section.2.9}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000p\000a\000c\000k\000a\000g\000e}{chapter.2}% 14
+\BOOKMARK [1][-]{section.2.10}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000g\000e\000n\000e\000r\000a\000t\000e}{chapter.2}% 15
+\BOOKMARK [0][-]{chapter.3}{\376\377\000D\000e\000v\000e\000l\000o\000p\000e\000r\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 16
+\BOOKMARK [1][-]{section.3.1}{\376\377\000A\000d\000d\000\040\000a\000\040\000u\000s\000e\000r\000\040\000c\000u\000s\000t\000o\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.3}% 17
+\BOOKMARK [0][-]{chapter.4}{\376\377\000C\000o\000d\000e\000\040\000d\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 18
+\BOOKMARK [1][-]{section.4.1}{\376\377\000s\000r\000c}{chapter.4}% 19
+\BOOKMARK [1][-]{section.4.2}{\376\377\000c\000o\000m\000m\000a\000n\000d\000s}{chapter.4}% 20
+\BOOKMARK [0][-]{chapter.5}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000N\000o\000t\000e\000s}{}% 21
+\BOOKMARK [1][-]{section.5.1}{\376\377\000R\000e\000l\000e\000a\000s\000e\000\040\000n\000o\000t\000e\000s}{chapter.5}% 22
+\BOOKMARK [0][-]{section*.961}{\376\377\000P\000y\000t\000h\000o\000n\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 23
+\BOOKMARK [0][-]{section*.962}{\376\377\000I\000n\000d\000e\000x}{}% 24
diff --git a/doc/build/latex/salomeTools.pdf b/doc/build/latex/salomeTools.pdf
new file mode 100644
index 0000000..5603c80
Binary files /dev/null and b/doc/build/latex/salomeTools.pdf differ
diff --git a/doc/build/latex/salomeTools.tex b/doc/build/latex/salomeTools.tex
new file mode 100644
index 0000000..10a5c4a
--- /dev/null
+++ b/doc/build/latex/salomeTools.tex
@@ -0,0 +1,13008 @@
+%% Generated by Sphinx.
+\def\sphinxdocclass{report}
+\documentclass[a4paper,10pt,english]{sphinxmanual}
+\ifdefined\pdfpxdimen
+   \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
+\fi \sphinxpxdimen=.75bp\relax
+
+\PassOptionsToPackage{warn}{textcomp}
+\usepackage[utf8]{inputenc}
+\ifdefined\DeclareUnicodeCharacter
+ \ifdefined\DeclareUnicodeCharacterAsOptional
+  \DeclareUnicodeCharacter{"00A0}{\nobreakspace}
+  \DeclareUnicodeCharacter{"2500}{\sphinxunichar{2500}}
+  \DeclareUnicodeCharacter{"2502}{\sphinxunichar{2502}}
+  \DeclareUnicodeCharacter{"2514}{\sphinxunichar{2514}}
+  \DeclareUnicodeCharacter{"251C}{\sphinxunichar{251C}}
+  \DeclareUnicodeCharacter{"2572}{\textbackslash}
+ \else
+  \DeclareUnicodeCharacter{00A0}{\nobreakspace}
+  \DeclareUnicodeCharacter{2500}{\sphinxunichar{2500}}
+  \DeclareUnicodeCharacter{2502}{\sphinxunichar{2502}}
+  \DeclareUnicodeCharacter{2514}{\sphinxunichar{2514}}
+  \DeclareUnicodeCharacter{251C}{\sphinxunichar{251C}}
+  \DeclareUnicodeCharacter{2572}{\textbackslash}
+ \fi
+\fi
+\usepackage{cmap}
+\usepackage[T1]{fontenc}
+\usepackage{amsmath,amssymb,amstext}
+\usepackage{babel}
+\usepackage{times}
+\usepackage[Bjarne]{fncychap}
+\usepackage{sphinx}
+\sphinxsetup{verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}}
+\usepackage{geometry}
+
+% Include hyperref last.
+\usepackage{hyperref}
+% Fix anchor placement for figures with captions.
+\usepackage{hypcap}% it must be loaded after hyperref.
+% Set up styles of URL: it should be placed after hyperref.
+\urlstyle{same}
+
+\addto\captionsenglish{\renewcommand{\figurename}{Fig.}}
+\addto\captionsenglish{\renewcommand{\tablename}{Table}}
+\addto\captionsenglish{\renewcommand{\literalblockname}{Listing}}
+
+\addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}}
+\addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}}
+
+\addto\extrasenglish{\def\pageautorefname{page}}
+
+\setcounter{tocdepth}{1}
+
+
+
+\title{salomeTools Documentation}
+\date{May 02, 2018}
+\release{5.0.0dev}
+\author{CEA DEN/DANS/DM2S/STMF/LGLS}
+\newcommand{\sphinxlogo}{\vbox{}}
+\renewcommand{\releasename}{Release}
+\makeindex
+
+\begin{document}
+
+\maketitle
+\sphinxtableofcontents
+\phantomsection\label{\detokenize{index::doc}}
+\clearpage
+
+
+
+\noindent{\hspace*{\fill}\sphinxincludegraphics[scale=1.0]{{sat_about}.png}\hspace*{\fill}}
+
+\begin{sphinxadmonition}{warning}{Warning:}
+This documentation is under construction.
+\end{sphinxadmonition}
+
+The \sphinxstylestrong{Sa}lome\sphinxstylestrong{T}ools (sat) is a suite of commands
+that can be used to perform operations on \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[1]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote}.
+
+For example, sat allows you to compile SALOME’s codes
+(prerequisites, products)
+create application, run tests, create package, etc.
+
+This utility code is a set of \sphinxhref{https://docs.python.org/2.7}{Python}%
+\begin{footnote}[2]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://docs.python.org/2.7}
+%
+\end{footnote} scripts files.
+
+Find a \sphinxhref{./../latex/salomeTools.pdf}{pdf version of this documentation}
+
+
+\chapter{Quick start}
+\label{\detokenize{index:quick-start}}\label{\detokenize{index:salome-tools}}
+
+\section{Installation}
+\label{\detokenize{installation_of_sat:installation}}\label{\detokenize{installation_of_sat::doc}}
+Usually user could find (and use) command \sphinxstylestrong{sat} directly after a ‘detar’ installation of SALOME.
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+tar \PYGZhy{}xf .../SALOME\PYGZus{}xx.tgz
+\PYG{n+nb}{cd} SALOME\PYGZus{}xx
+ls \PYGZhy{}l sat      \PYG{c+c1}{\PYGZsh{} sat \PYGZhy{}\PYGZgt{} salomeTools/sat}
+\end{sphinxVerbatim}
+
+Python package (scripts of salomeTools) actually remains in directory \sphinxstyleemphasis{salomeTools}.
+
+
+\section{Configuration}
+\label{\detokenize{configuration:configuration}}\label{\detokenize{configuration::doc}}
+\sphinxstyleemphasis{salomeTools} uses files to store its configuration parameters.
+
+There are several configuration files which are loaded by salomeTools in a specific order.
+When all the files are loaded a \sphinxstyleemphasis{config} object is created.
+Then, this object is passed to all command scripts.
+
+
+\subsection{Syntax}
+\label{\detokenize{configuration:syntax}}
+The configuration files use a python-like structure format
+(see \sphinxhref{http://www.red-dove.com/config-doc/}{config module}%
+\begin{footnote}[3]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.red-dove.com/config-doc/}
+%
+\end{footnote} for a complete description).
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{\{\}} define a dictionary,
+
+\item {} 
+\sphinxstylestrong{{[}{]}} define a list,
+
+\item {} 
+\sphinxstylestrong{@} can be used to include a file,
+
+\item {} 
+\sphinxstylestrong{\$prefix} reference to another parameter (ex: \sphinxcode{\sphinxupquote{\$PRODUCT.name}}),
+
+\item {} 
+\sphinxstylestrong{\#} comments.
+
+\end{itemize}
+
+\begin{sphinxadmonition}{note}{Note:}
+in this documentation a reference to a configuration parameter will be noted \sphinxcode{\sphinxupquote{XXX.YYY}}.
+\end{sphinxadmonition}
+
+
+\subsection{Description}
+\label{\detokenize{configuration:description}}
+
+\subsubsection{VARS section}
+\label{\detokenize{configuration:vars-section}}\label{\detokenize{configuration:id1}}
+\begin{DUlineblock}{0em}
+\item[] This section is dynamically created by salomeTools at run time.
+\item[] It contains information about the environment: date, time, OS, architecture etc.
+\end{DUlineblock}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} to get the current setting}
+\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{VARS}
+\end{sphinxVerbatim}
+
+
+\subsubsection{PRODUCTS section}
+\label{\detokenize{configuration:products-section}}
+\begin{DUlineblock}{0em}
+\item[] This section is defined in the product file.
+\item[] It contains instructions on how to build a version of SALOME (list of prerequisites-products and versions)
+\end{DUlineblock}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} to get the current setting}
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{PRODUCTS}
+\end{sphinxVerbatim}
+
+
+\subsubsection{APPLICATION section}
+\label{\detokenize{configuration:application-section}}
+\begin{DUlineblock}{0em}
+\item[] This section is optional, it is also defined in the product file.
+\item[] It gives additional parameters to create an application based on SALOME, as versions of products to use.
+\end{DUlineblock}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} to get the current setting}
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{APPLICATION}
+\end{sphinxVerbatim}
+
+
+\subsubsection{USER section}
+\label{\detokenize{configuration:user-section}}\label{\detokenize{configuration:id2}}
+This section is defined by the user configuration file,
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.salomeTools/salomeTools.pyconf}}.
+
+The \sphinxcode{\sphinxupquote{USER}} section defines some parameters (not exhaustive):
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{workDir} :
+\begin{quote}
+
+\begin{DUlineblock}{0em}
+\item[] The working directory.
+\item[] Each product will be usually installed here (in sub-directories).
+\end{DUlineblock}
+\end{quote}
+
+\item {} 
+\sphinxstylestrong{browser} : The web browser to use (\sphinxstyleemphasis{firefox}).
+
+\item {} 
+\sphinxstylestrong{editor} : The editor to use (\sphinxstyleemphasis{vi, pluma}).
+
+\item {} 
+and other user preferences.
+
+\end{itemize}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} to get the current setting}
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{value} \PYG{n}{USER}
+\end{sphinxVerbatim}
+
+\clearpage
+
+
+\section{Usage of SAlomeTools}
+\label{\detokenize{usage_of_sat:svn}}\label{\detokenize{usage_of_sat:usage-of-salometools}}\label{\detokenize{usage_of_sat::doc}}
+
+\subsection{Usage}
+\label{\detokenize{usage_of_sat:usage}}
+sat usage is a Command Line Interface (\sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
+\begin{footnote}[4]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
+%
+\end{footnote}).
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat \PYG{o}{[}generic\PYGZus{}options\PYG{o}{]} \PYG{o}{[}command\PYG{o}{]} \PYG{o}{[}product\PYG{o}{]} \PYG{o}{[}command\PYGZus{}options\PYG{o}{]}
+\end{sphinxVerbatim}
+
+
+\subsubsection{Options of sat}
+\label{\detokenize{usage_of_sat:options-of-sat}}
+Useful \sphinxstyleemphasis{not exhaustive} generic options of \sphinxstyleemphasis{sat} CLI.
+
+
+\paragraph{\sphinxstyleemphasis{\textendash{}help or -h}}
+\label{\detokenize{usage_of_sat:help-or-h}}
+Get help as simple text.
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat \PYGZhy{}\PYGZhy{}help          \PYG{c+c1}{\PYGZsh{} get the list of existing commands}
+sat \PYGZhy{}\PYGZhy{}help compile  \PYG{c+c1}{\PYGZsh{} get the help on a specific command \PYGZsq{}compile\PYGZsq{}}
+\end{sphinxVerbatim}
+
+
+\paragraph{\sphinxstyleemphasis{\textendash{}debug or -g}}
+\label{\detokenize{usage_of_sat:debug-or-g}}
+Execution in debug mode allows to see more trace and \sphinxstyleemphasis{stack} if an exception is raised.
+
+
+\paragraph{\sphinxstyleemphasis{\textendash{}verbose or -v}}
+\label{\detokenize{usage_of_sat:verbose-or-v}}
+Change verbosity level (default is 3).
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} for product \PYGZsq{}SALOME\PYGZus{}xx\PYGZsq{} for example}
+\PYG{c+c1}{\PYGZsh{} execute compile command in debug mode with trace level 4}
+sat \PYGZhy{}g \PYGZhy{}v \PYG{l+m}{4} compile SALOME\PYGZus{}xx
+\end{sphinxVerbatim}
+
+
+\subsection{Build a SALOME product}
+\label{\detokenize{usage_of_sat:build-a-salome-product}}
+
+\subsubsection{Get the list of available products}
+\label{\detokenize{usage_of_sat:get-the-list-of-available-products}}
+To get the list of the current available products in your context:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat config \PYGZhy{}\PYGZhy{}list
+\end{sphinxVerbatim}
+
+
+\subsubsection{Prepare sources of a product}
+\label{\detokenize{usage_of_sat:prepare-sources-of-a-product}}
+To prepare (get) \sphinxstyleemphasis{all} the sources of a product (\sphinxstyleemphasis{SALOME\_xx} for example):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat prepare SALOME\PYGZus{}xx
+\end{sphinxVerbatim}
+
+\begin{DUlineblock}{0em}
+\item[] The sources are usually copied in directories
+\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + SOURCES + \$PRODUCT.name}
+\end{DUlineblock}
+
+
+\subsubsection{Compile SALOME}
+\label{\detokenize{usage_of_sat:compile-salome}}
+To compile products:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} compile all prerequisites/products}
+sat compile SALOME\PYGZus{}xx
+
+\PYG{c+c1}{\PYGZsh{} compile only 2 products (KERNEL and SAMPLES), if not done yet}
+sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}products KERNEL,SAMPLES
+
+\PYG{c+c1}{\PYGZsh{} compile only 2 products, unconditionaly}
+sat compile SALOME\PYGZus{}xx \PYGZhy{}\PYGZhy{}\PYGZhy{}products SAMPLES \PYGZhy{}\PYGZhy{}clean\PYGZus{}all
+\end{sphinxVerbatim}
+
+\begin{DUlineblock}{0em}
+\item[] The products are usually build in the directories
+\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + BUILD + \$PRODUCT.name}
+\item[] 
+\item[] The products are usually installed in the directories
+\item[] \sphinxstyleemphasis{\$USER.workDir + SALOME\_xx… + INSTALL + \$PRODUCT.name}
+\end{DUlineblock}
+
+
+\chapter{List of Commands}
+\label{\detokenize{index:list-of-commands}}
+\clearpage
+
+
+\section{Command config}
+\label{\detokenize{commands/config:svn}}\label{\detokenize{commands/config:command-config}}\label{\detokenize{commands/config::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/config:description}}
+The \sphinxstylestrong{config} command manages sat configuration.
+It allows display, manipulation and operation on configuration files
+
+
+\subsection{Usage}
+\label{\detokenize{commands/config:usage}}\begin{itemize}
+\item {} 
+Edit the user personal configuration file \sphinxcode{\sphinxupquote{\$HOME/.salomeTools/SAT.pyconf}}. It is used to store the user personal choices, like the favorite editor, browser, pdf viewer:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
+\end{sphinxVerbatim}
+
+\item {} 
+List the available applications (they come from the sat projects defined in \sphinxcode{\sphinxupquote{data/local.pyconf}}:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{list}
+\end{sphinxVerbatim}
+
+\item {} 
+Edit the configuration of an application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{edit}
+\end{sphinxVerbatim}
+
+\item {} 
+Copy an application configuration file into the user personal directory:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{copy} \PYG{p}{[}\PYG{n}{new\PYGZus{}name}\PYG{p}{]}
+\end{sphinxVerbatim}
+
+\item {} 
+\begin{DUlineblock}{0em}
+\item[] Print the value of a configuration parameter.
+\item[] Use the automatic completion to get recursively the parameter names.
+\item[] Use \sphinxstyleemphasis{\textendash{}no\_label} option to get \sphinxstyleemphasis{only} the value, \sphinxstyleemphasis{without} label (useful in automatic scripts).
+\item[] Examples (with \sphinxstyleemphasis{SALOME-xx} as \sphinxstyleemphasis{SALOME-8.4.0} ):
+\end{DUlineblock}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} sat config \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
+sat config \PYGZhy{}\PYGZhy{}value .         \PYG{c+c1}{\PYGZsh{} all the configuration}
+sat config \PYGZhy{}\PYGZhy{}value LOCAL
+sat config \PYGZhy{}\PYGZhy{}value LOCAL.workdir
+
+\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}value \PYGZlt{}parameter\PYGZus{}path\PYGZgt{}}
+sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
+sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}no\PYGZus{}label \PYGZhy{}\PYGZhy{}value APPLICATION.workdir
+\end{sphinxVerbatim}
+
+\item {} 
+\begin{DUlineblock}{0em}
+\item[] Print in one-line-by-value mode the value of a configuration parameter,
+\item[] with its source \sphinxstyleemphasis{expression}, if any.
+\item[] This is a debug mode, useful for developers.
+\item[] Prints the parameter path, the source expression if any, and the final value:
+\end{DUlineblock}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{g} \PYG{n}{USER}
+\end{sphinxVerbatim}
+
+\begin{sphinxadmonition}{note}{Note:}
+And so, \sphinxstyleemphasis{not only for fun}, to get \sphinxstylestrong{all expressions} of configuration
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat config SALOME\PYGZhy{}xx \PYGZhy{}g . \PYG{p}{\textbar{}} grep \PYGZhy{}e \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZgt{}\PYGZdq{}}
+\end{sphinxVerbatim}
+\end{sphinxadmonition}
+
+\item {} 
+Print the patches that are applied:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show\PYGZus{}patchs}
+\end{sphinxVerbatim}
+
+\item {} 
+Get information on a product configuration:
+
+\end{itemize}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}}
+sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info KERNEL
+sat config SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}info qt
+\end{sphinxVerbatim}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/config:some-useful-configuration-pathes}}
+Exploring a current configuration.
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{PATHS}: To get list of directories where to find files.
+
+\item {} 
+\sphinxstylestrong{USER}: To get user preferences (editor, pdf viewer, web browser, default working dir).
+
+\end{itemize}
+
+sat commands:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{PATHS}
+\PYG{n}{sat} \PYG{n}{config} \PYG{n}{SALOME}\PYG{o}{\PYGZhy{}}\PYG{n}{xx} \PYG{o}{\PYGZhy{}}\PYG{n}{v} \PYG{n}{USERS}
+\end{sphinxVerbatim}
+
+\clearpage
+
+
+\section{Command prepare}
+\label{\detokenize{commands/prepare:svn}}\label{\detokenize{commands/prepare:command-prepare}}\label{\detokenize{commands/prepare::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/prepare:description}}
+The \sphinxstylestrong{prepare} command brings the sources of an application in the \sphinxstyleemphasis{sources
+application directory}, in order to compile them with the compile command.
+
+The sources can be prepared from VCS software (\sphinxstyleemphasis{cvs, svn, git}), an archive or a directory.
+
+\begin{sphinxadmonition}{warning}{Warning:}
+When sat prepares a product, it first removes the
+existing directory, except if the development mode is activated.
+When you are working on a product, you need to declare in
+the application configuration this product in \sphinxstylestrong{dev} mode.
+\end{sphinxadmonition}
+
+
+\subsection{Remarks}
+\label{\detokenize{commands/prepare:remarks}}
+
+\subsubsection{VCS bases (git, svn, cvs)}
+\label{\detokenize{commands/prepare:vcs-bases-git-svn-cvs}}
+The \sphinxstyleemphasis{prepare} command does not manage authentication on the cvs server.
+For example, to prepare modules from a cvs server, you first need to login once.
+
+To avoid typing a password for each product,
+you may use a ssh key with passphrase, or store your password
+(in .cvspass or .gitconfig files).
+If you have security concerns, it is also possible to use
+a bash agent and type your password only once.
+
+
+\subsubsection{Dev mode}
+\label{\detokenize{commands/prepare:dev-mode}}
+By default \sphinxstyleemphasis{prepare} uses \sphinxstyleemphasis{export} mode: it creates an image
+of the sources, corresponding to the tag or branch specified,
+without any link to the VCS base.
+To perform a \sphinxstyleemphasis{checkout} (svn, cvs) or a \sphinxstyleemphasis{git clone} (git),
+you need to declare the product in dev mode in your application configuration:
+edit the application configuration file (pyconf) and modify the product declaration:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}e
+\PYG{c+c1}{\PYGZsh{} and edit the product section:}
+\PYG{c+c1}{\PYGZsh{}   \PYGZlt{}product\PYGZgt{} : \PYGZob{}tag : \PYGZdq{}my\PYGZus{}tag\PYGZdq{}, dev : \PYGZdq{}yes\PYGZdq{}, debug : \PYGZdq{}yes\PYGZdq{}\PYGZcb{}}
+\end{sphinxVerbatim}
+
+The first time you will execute the \sphinxstyleemphasis{sat prepare} command,
+your module will be downloaded in \sphinxstyleemphasis{checkout} mode
+(inside the SOURCES directory of the application.
+Then, you can develop in this repository, and finally push
+them in the base when they are ready.
+If you type during the development process by mistake
+a \sphinxstyleemphasis{sat prepare} command, the sources in dev mode will
+not be altered/removed (Unless you use -f option)
+
+
+\subsection{Usage}
+\label{\detokenize{commands/prepare:usage}}\begin{itemize}
+\item {} 
+Prepare the sources of a complete application in SOURCES directory (all products):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Prepare only some modules:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}  \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
+\end{sphinxVerbatim}
+
+\item {} 
+Use \textendash{}force to force to prepare the products in development mode
+(this will remove the sources and do a new clone/checkout):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
+\end{sphinxVerbatim}
+
+\item {} 
+Use \textendash{}force\_patch to force to apply patch to the products
+in development mode (otherwise they are not applied):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{prepare} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force\PYGZus{}patch}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/prepare:some-useful-configuration-pathes}}
+Command \sphinxstyleemphasis{sat prepare} uses the \sphinxstyleemphasis{pyconf file configuration} of each product to know how to get the sources.
+
+\begin{sphinxadmonition}{note}{Note:}
+to verify configuration of a product, and get name of this \sphinxstyleemphasis{pyconf files configuration}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat config \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}info \PYGZlt{}product\PYGZgt{}
+\end{sphinxVerbatim}
+\end{sphinxadmonition}
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{get\_method}: the method to use to prepare the module, possible values are cvs, git, archive, dir.
+
+\item {} 
+\sphinxstylestrong{git\_info} : (used if get\_method = git) information to prepare sources from git.
+
+\item {} 
+\sphinxstylestrong{svn\_info} : (used if get\_method = svn) information to prepare sources from cvs.
+
+\item {} 
+\sphinxstylestrong{cvs\_info} : (used if get\_method = cvs) information to prepare sources from cvs.
+
+\item {} 
+\sphinxstylestrong{archive\_info} : (used if get\_method = archive) the path to the archive.
+
+\item {} 
+\sphinxstylestrong{dir\_info} : (used if get\_method = dir) the directory with the sources.
+
+\end{itemize}
+
+\clearpage
+
+
+\section{Command compile}
+\label{\detokenize{commands/compile:svn}}\label{\detokenize{commands/compile:command-compile}}\label{\detokenize{commands/compile::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/compile:description}}
+The \sphinxstylestrong{compile} command allows compiling the products of a \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[5]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote} application.
+
+
+\subsection{Usage}
+\label{\detokenize{commands/compile:usage}}\begin{itemize}
+\item {} 
+Compile a complete application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Compile only some products:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}\PYG{p}{,}\PYG{o}{\PYGZlt{}}\PYG{n}{product2}\PYG{o}{\PYGZgt{}} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
+\end{sphinxVerbatim}
+
+\item {} 
+Use \sphinxstyleemphasis{sat -t} to duplicate the logs in the terminal (by default the log are stored and displayed with \sphinxstyleemphasis{sat log} command):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{o}{\PYGZhy{}}\PYG{n}{t} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product1}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Compile a module and its dependencies:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}fathers}
+\end{sphinxVerbatim}
+
+\item {} 
+Compile a module and the modules depending on it (for example plugins):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{med} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}children}
+\end{sphinxVerbatim}
+
+\item {} 
+Clean the build and install directories before starting compilation:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{GEOM}  \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}all}
+\end{sphinxVerbatim}
+
+\begin{sphinxadmonition}{note}{Note:}
+\begin{DUlineblock}{0em}
+\item[] a warning will be shown if option \sphinxstyleemphasis{\textendash{}products} is missing
+\item[] (as it will clean everything)
+\end{DUlineblock}
+\end{sphinxadmonition}
+
+\item {} 
+Clean only the install directories before starting compilation:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}install}
+\end{sphinxVerbatim}
+
+\item {} 
+Add options for make:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{make\PYGZus{}flags} \PYG{o}{\PYGZlt{}}\PYG{n}{flags}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Use the \sphinxstyleemphasis{\textendash{}check} option to execute the unit tests after compilation:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{check}
+\end{sphinxVerbatim}
+
+\item {} 
+Remove the build directory after successful compilation (some build directory like qt are big):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{n}{qt} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean\PYGZus{}build\PYGZus{}after}
+\end{sphinxVerbatim}
+
+\item {} 
+Stop the compilation as soon as the compilation of a module fails:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{product}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{stop\PYGZus{}first\PYGZus{}fail}
+\end{sphinxVerbatim}
+
+\item {} 
+Do not compile, just show if products are installed or not, and where is the installation:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n+nb}{compile} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{show}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/compile:some-useful-configuration-pathes}}
+The way to compile a product is defined in the \sphinxstyleemphasis{pyconf file configuration}.
+The main options are:
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{build\_source} : the method used to build the product (cmake/autotools/script)
+
+\item {} 
+\sphinxstylestrong{compil\_script} : the compilation script if build\_source is equal to “script”
+
+\item {} 
+\sphinxstylestrong{cmake\_options} : additional options for cmake.
+
+\item {} 
+\sphinxstylestrong{nb\_proc} : number of jobs to use with make for this product.
+
+\end{itemize}
+
+\clearpage
+
+
+\section{Command launcher}
+\label{\detokenize{commands/launcher:svn}}\label{\detokenize{commands/launcher:command-launcher}}\label{\detokenize{commands/launcher::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/launcher:description}}
+The \sphinxstylestrong{launcher} command creates a SALOME launcher, a python script file to start \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[6]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote}.
+
+
+\subsection{Usage}
+\label{\detokenize{commands/launcher:usage}}\begin{itemize}
+\item {} 
+Create a launcher:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+Generate a launcher in the application directory, i.e \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.
+
+\item {} 
+Create a launcher with a given name (default name is \sphinxcode{\sphinxupquote{APPLICATION.profile.launcher\_name}})
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{ZeLauncher}
+\end{sphinxVerbatim}
+
+The launcher will be called \sphinxstyleemphasis{ZeLauncher}.
+
+\item {} 
+Set a specific resources catalog:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}  \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog}  \PYG{o}{\PYGZlt{}}\PYG{n}{path} \PYG{n}{of} \PYG{n}{a} \PYG{n}{salome} \PYG{n}{resources} \PYG{n}{catalog}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+Note that the catalog specified will be copied to the profile directory.
+
+\item {} 
+Generate the catalog for a list of machines:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{o}{\PYGZlt{}}\PYG{n+nb}{list} \PYG{n}{of} \PYG{n}{machines}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+This will create a catalog by querying each machine (memory, number of processor) with ssh.
+
+\item {} 
+Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Configuration}
+\label{\detokenize{commands/launcher:configuration}}
+Some useful configuration pathes:
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{APPLICATION.profile}
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{product} : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
+
+\item {} 
+\sphinxstylestrong{launcher\_name} : the name of the launcher.
+
+\end{itemize}
+
+\end{itemize}
+
+\clearpage
+
+
+\section{Command application}
+\label{\detokenize{commands/application:svn}}\label{\detokenize{commands/application::doc}}\label{\detokenize{commands/application:command-application}}
+
+\subsection{Description}
+\label{\detokenize{commands/application:description}}
+The \sphinxstylestrong{application} command creates a virtual \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[7]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote} application.
+Virtual SALOME applications are used to start SALOME when distribution is needed.
+
+
+\subsection{Usage}
+\label{\detokenize{commands/application:usage}}\begin{itemize}
+\item {} 
+Create an application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+Create the virtual application directory in the salomeTool application directory \sphinxcode{\sphinxupquote{\$APPLICATION.workdir}}.
+
+\item {} 
+Give a name to the application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}name}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\sphinxstyleemphasis{Remark}: this option overrides the name given in the virtual\_app section of the configuration file \sphinxcode{\sphinxupquote{\$APPLICATION.virtual\_app.name}}.
+
+\item {} 
+Change the directory where the application is created:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{target} \PYG{o}{\PYGZlt{}}\PYG{n}{my\PYGZus{}application\PYGZus{}directory}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Set a specific \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[8]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote} resources catalog (it will be used for the distribution of components on distant machines):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{catalog} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}catalog}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+Note that the catalog specified will be copied to the application directory.
+
+\item {} 
+Generate the catalog for a list of machines:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{application} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{gencat} \PYG{n}{machine1}\PYG{p}{,}\PYG{n}{machine2}\PYG{p}{,}\PYG{n}{machine3}
+\end{sphinxVerbatim}
+
+This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
+
+\item {} 
+Generate a mesa application (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{launcher} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{use\PYGZus{}mesa}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/application:some-useful-configuration-pathes}}
+The virtual application can be configured with the virtual\_app section of the configutation file.
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{APPLICATION.virtual\_app}
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{name} : name of the launcher (to replace the default runAppli).
+
+\item {} 
+\sphinxstylestrong{application\_name} : (optional) the name of the virtual application directory, if missing the default value is \sphinxcode{\sphinxupquote{\$name + \_appli}}.
+
+\end{itemize}
+
+\end{itemize}
+
+\clearpage
+
+
+\section{Command log}
+\label{\detokenize{commands/log:svn}}\label{\detokenize{commands/log:command-log}}\label{\detokenize{commands/log::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/log:description}}
+The \sphinxstylestrong{log} command displays sat log in a web browser or in a terminal.
+
+
+\subsection{Usage}
+\label{\detokenize{commands/log:usage}}\begin{itemize}
+\item {} 
+Show (in a web browser) the log of the commands corresponding to an application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Show the log for commands that do not use any application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{log}
+\end{sphinxVerbatim}
+
+\item {} 
+The \textendash{}terminal (or -t) display the log directly in the terminal, through a \sphinxhref{https://en.wikipedia.org/wiki/Command-line\_interface}{CLI}%
+\begin{footnote}[9]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Command-line\_interface}
+%
+\end{footnote} interactive menu:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{terminal}
+\end{sphinxVerbatim}
+
+\item {} 
+The \textendash{}last option displays only the last command:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last}
+\end{sphinxVerbatim}
+
+\item {} 
+To access the last compilation log in terminal mode, use \textendash{}last\_terminal option:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{last\PYGZus{}terminal}
+\end{sphinxVerbatim}
+
+\item {} 
+The \textendash{}clean (int) option erases the n older log files and print the number of remaining log files:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{log} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{clean} \PYG{l+m+mi}{50}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/log:some-useful-configuration-pathes}}\begin{itemize}
+\item {} 
+\sphinxstylestrong{USER}
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{browser} : The browser used to show the log (by default \sphinxstyleemphasis{firefox}).
+
+\item {} 
+\sphinxstylestrong{log\_dir} : The directory used to store the log files.
+
+\end{itemize}
+
+\end{itemize}
+
+\clearpage
+
+
+\section{Command environ}
+\label{\detokenize{commands/environ:svn}}\label{\detokenize{commands/environ:command-environ}}\label{\detokenize{commands/environ::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/environ:description}}
+The \sphinxstylestrong{environ} command generates the environment files used
+to run and compile your application (as \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[10]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote} is an example).
+
+\begin{sphinxadmonition}{note}{Note:}
+these files are \sphinxstylestrong{not} required,
+salomeTool set the environment himself, when compiling.
+And so does the salome launcher.
+
+These files are useful when someone wants to check the environment.
+They could be used in debug mode to set the environment for \sphinxstyleemphasis{gdb}.
+\end{sphinxadmonition}
+
+The configuration part at the end of this page explains how
+to specify the environment used by sat (at build or run time),
+and saved in some files by \sphinxstyleemphasis{sat environ} command.
+
+
+\subsection{Usage}
+\label{\detokenize{commands/environ:usage}}\begin{itemize}
+\item {} 
+Create the shell environment files of the application:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Create the environment files of the application for a given shell.
+Options are bash, bat (for windows) and cfg (the configuration format used by \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[11]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote}):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{environ} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{shell} \PYG{p}{[}\PYG{n}{bash}\PYG{o}{\textbar{}}\PYG{n}{cfg}\PYG{o}{\textbar{}}\PYG{n+nb}{all}\PYG{p}{]}
+\end{sphinxVerbatim}
+
+\item {} 
+Use a different prefix for the files (default is ‘env’):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} This will create file \PYGZlt{}prefix\PYGZgt{}\PYGZus{}launch.sh, \PYGZlt{}prefix\PYGZgt{}\PYGZus{}build.sh}
+sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}prefix \PYGZlt{}prefix\PYGZgt{}
+\end{sphinxVerbatim}
+
+\item {} 
+Use a different target directory for the files:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} This will create file env\PYGZus{}launch.sh, env\PYGZus{}build.sh}
+\PYG{c+c1}{\PYGZsh{} in the directory corresponding to \PYGZlt{}path\PYGZgt{}}
+sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}target \PYGZlt{}path\PYGZgt{}
+\end{sphinxVerbatim}
+
+\item {} 
+Generate the environment files only with the given products:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} This will create the environment files only for the given products}
+\PYG{c+c1}{\PYGZsh{} and their prerequisites.}
+\PYG{c+c1}{\PYGZsh{} It is useful when you want to visualise which environment uses}
+\PYG{c+c1}{\PYGZsh{} sat to compile a given product.}
+sat environ \PYGZlt{}application\PYGZgt{} \PYGZhy{}\PYGZhy{}product \PYGZlt{}product1\PYGZgt{},\PYGZlt{}product2\PYGZgt{}, ...
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Configuration}
+\label{\detokenize{commands/environ:configuration}}
+The specification of the environment can be done through several mechanisms.
+\begin{enumerate}
+\item {} 
+For salome products (the products with the property \sphinxcode{\sphinxupquote{is\_SALOME\_module}} as \sphinxcode{\sphinxupquote{yes}}) the environment is set automatically by sat, in respect with \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[12]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote} requirements.
+
+\item {} 
+For other products, the environment is set with the use of the environ section within the pyconf file of the product. The user has two possibilities, either set directly the environment within the section, or specify a python script which wil be used to set the environment programmatically.
+
+\end{enumerate}
+
+Within the section, the user can define environment variables. He can also modify PATH variables, by appending or prepending directories.
+In the following example, we prepend \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} (note the \sphinxstyleemphasis{left first} underscore), append \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}/lib} to \sphinxcode{\sphinxupquote{PYTHONPATH}} (note the \sphinxstyleemphasis{right last} underscore), and set \sphinxcode{\sphinxupquote{LAPACK\_ROOT\_DIR}} to \sphinxstyleemphasis{\textless{}install\_dir\textgreater{}}:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+environ :
+\PYG{o}{\PYGZob{}}
+  \PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
+  PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
+  LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
+\PYG{o}{\PYGZcb{}}
+\end{sphinxVerbatim}
+
+It is possible to distinguish the build environment from the launch environment: use a subsection called \sphinxstyleemphasis{build} or \sphinxstyleemphasis{launch}. In the example below, \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} and \sphinxcode{\sphinxupquote{PYTHONPATH}} are only modified at run time, not at compile time:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+environ :
+\PYG{o}{\PYGZob{}}
+  build :
+  \PYG{o}{\PYGZob{}}
+    LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
+  \PYG{o}{\PYGZcb{}}
+  launch :
+  \PYG{o}{\PYGZob{}}
+    LAPACK\PYGZus{}ROOT\PYGZus{}DIR : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir}
+    \PYGZus{}LD\PYGZus{}LIBRARY\PYGZus{}PATH : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
+    PYTHONPATH\PYGZus{} : \PYG{n+nv}{\PYGZdl{}install\PYGZus{}dir} + \PYG{n+nv}{\PYGZdl{}VARS}.sep + \PYG{l+s+s2}{\PYGZdq{}lib\PYGZdq{}}
+  \PYG{o}{\PYGZcb{}}
+\PYG{o}{\PYGZcb{}}
+\end{sphinxVerbatim}
+\begin{enumerate}
+\setcounter{enumi}{2}
+\item {} 
+The last possibility is to set the environment with a python script. The script should be provided in the \sphinxstyleemphasis{products/env\_scripts} directory of the sat project, and its name is specified in the environment section with the key \sphinxcode{\sphinxupquote{environ.env\_script}}:
+
+\end{enumerate}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{environ} \PYG{p}{:}
+\PYG{p}{\PYGZob{}}
+  \PYG{n}{env\PYGZus{}script} \PYG{p}{:} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lapack.py}\PYG{l+s+s1}{\PYGZsq{}}
+\PYG{p}{\PYGZcb{}}
+\end{sphinxVerbatim}
+
+Please note that the two modes are complementary and are both taken into account.
+Most of the time, the first mode is sufficient.
+
+The second mode can be used when the environment has to be set programmatically.
+The developer implements a handle (as a python method)
+which is called by sat to set the environment.
+Here is an example:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+ch}{\PYGZsh{}!/usr/bin/env python}
+\PYG{c+c1}{\PYGZsh{}\PYGZhy{}*\PYGZhy{} coding:utf\PYGZhy{}8 \PYGZhy{}*\PYGZhy{}}
+
+\PYG{k+kn}{import} \PYG{n+nn}{os.path}
+\PYG{k+kn}{import} \PYG{n+nn}{platform}
+
+\PYG{k}{def} \PYG{n+nf}{set\PYGZus{}env}\PYG{p}{(}\PYG{n}{env}\PYG{p}{,} \PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{n}{version}\PYG{p}{)}\PYG{p}{:}
+    \PYG{n}{env}\PYG{o}{.}\PYG{n}{set}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{TRUST\PYGZus{}ROOT\PYGZus{}DIR}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{,}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{)}
+    \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{bin}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
+    \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{include}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
+    \PYG{n}{env}\PYG{o}{.}\PYG{n}{prepend}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{LD\PYGZus{}LIBRARY\PYGZus{}PATH}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{os}\PYG{o}{.}\PYG{n}{path}\PYG{o}{.}\PYG{n}{join}\PYG{p}{(}\PYG{n}{prereq\PYGZus{}dir}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{lib}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)}
+    \PYG{k}{return}
+\end{sphinxVerbatim}
+
+SalomeTools defines four handles:
+\begin{itemize}
+\item {} 
+\sphinxstylestrong{set\_env(env, prereq\_dir, version)} : used at build and run time.
+
+\item {} 
+\sphinxstylestrong{set\_env\_launch(env, prereq\_dir, version)} : used only at run time (if defined!)
+
+\item {} 
+\sphinxstylestrong{set\_env\_build(env, prereq\_dir, version)} : used only at build time (if defined!)
+
+\item {} 
+\sphinxstylestrong{set\_native\_env(env)} : used only for native products, at build and run time.
+
+\end{itemize}
+
+\clearpage
+
+
+\section{Command clean}
+\label{\detokenize{commands/clean:svn}}\label{\detokenize{commands/clean:command-clean}}\label{\detokenize{commands/clean::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/clean:description}}
+The \sphinxstylestrong{clean} command removes products in the \sphinxstyleemphasis{source, build, or install} directories of an application. Theses directories are usually named \sphinxcode{\sphinxupquote{SOURCES, BUILD, INSTALL}}.
+
+Use the options to define what directories you want to suppress and to set the list of products
+
+
+\subsection{Usage}
+\label{\detokenize{commands/clean:usage}}\begin{itemize}
+\item {} 
+Clean all previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories (example application as \sphinxstyleemphasis{SALOME\_xx}):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} take care, is long time to restore, sometimes}
+sat clean SALOME\PYGZhy{}xx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install
+\end{sphinxVerbatim}
+
+\item {} 
+Clean previously created \sphinxstyleemphasis{build} and \sphinxstyleemphasis{install} directories, only for products with property \sphinxstyleemphasis{is\_salome\_module}:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+sat clean SALOME\PYGZhy{}xxx \PYGZhy{}\PYGZhy{}build \PYGZhy{}\PYGZhy{}install \PYG{l+s+se}{\PYGZbs{}}
+                     \PYGZhy{}\PYGZhy{}properties is\PYGZus{}salome\PYGZus{}module:yes
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\subsection{Availables options}
+\label{\detokenize{commands/clean:availables-options}}\begin{itemize}
+\item {} 
+\sphinxstylestrong{\textendash{}products} : Products to clean.
+
+\item {} 
+\sphinxstylestrong{\textendash{}properties} :
+
+\begin{DUlineblock}{0em}
+\item[] Filter the products by their properties.
+\item[] Syntax: \sphinxstyleemphasis{\textendash{}properties \textless{}property\textgreater{}:\textless{}value\textgreater{}}
+\end{DUlineblock}
+
+\item {} 
+\sphinxstylestrong{\textendash{}sources} : Clean the product source directories.
+
+\item {} 
+\sphinxstylestrong{\textendash{}build} : Clean the product build directories.
+
+\item {} 
+\sphinxstylestrong{\textendash{}install} : Clean the product install directories.
+
+\item {} 
+\sphinxstylestrong{\textendash{}all} : Clean the product source, build and install directories.
+
+\item {} 
+\sphinxstylestrong{\textendash{}sources\_without\_dev} :
+
+\begin{DUlineblock}{0em}
+\item[] Do not clean the products in development mode,
+\item[] (they could have \sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
+\begin{footnote}[13]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
+%
+\end{footnote} commits pending).
+\end{DUlineblock}
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/clean:some-useful-configuration-pathes}}
+No specific configuration.
+
+\clearpage
+
+
+\section{Command package}
+\label{\detokenize{commands/package:svn}}\label{\detokenize{commands/package:command-package}}\label{\detokenize{commands/package::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/package:description}}
+The \sphinxstylestrong{package} command creates a \sphinxhref{http://www.salome-platform.org}{SALOME}%
+\begin{footnote}[14]\sphinxAtStartFootnote
+\sphinxnolinkurl{http://www.salome-platform.org}
+%
+\end{footnote} archive (usually a compressed \sphinxhref{https://en.wikipedia.org/wiki/Tar\_(computing)}{Tar}%
+\begin{footnote}[15]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Tar\_(computing)}
+%
+\end{footnote} file .tgz).
+This tar file is used later to intall SALOME on other remote computer.
+
+Depending on the selected options, the archive includes sources and binaries
+of SALOME products and prerequisites.
+
+Usually utility \sphinxstyleemphasis{salomeTools} is included in the archive.
+
+\begin{sphinxadmonition}{note}{Note:}
+By default the package includes the sources of prerequisites and products.
+To select a subset use the \sphinxstyleemphasis{\textendash{}without\_property} or \sphinxstyleemphasis{\textendash{}with\_vcs} options.
+\end{sphinxadmonition}
+
+
+\subsection{Usage}
+\label{\detokenize{commands/package:usage}}\begin{itemize}
+\item {} 
+Create a package for a product (example as \sphinxstyleemphasis{SALOME\_xx}):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
+\end{sphinxVerbatim}
+
+This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx.tgz}}
+in the working directory (\sphinxcode{\sphinxupquote{USER.workDir}}).
+If the archive already exists, do nothing.
+
+\item {} 
+Create a package with a specific name:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{YourSpecificName}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+\begin{sphinxadmonition}{note}{Note:}
+By default, the archive is created in the working directory of the user (\sphinxcode{\sphinxupquote{USER.workDir}}).
+
+If the option \sphinxstyleemphasis{\textendash{}name} is used with a path (relative or absolute) it will be used.
+
+If the option \sphinxstyleemphasis{\textendash{}name} is not used and binaries (prerequisites and products)
+are included in the package, the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
+\begin{footnote}[16]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
+%
+\end{footnote} architecture
+will be appended to the name (example: \sphinxcode{\sphinxupquote{SALOME\_xx-CO7.tgz}}).
+
+Examples:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx.tgz in \PYGZdl{}USER.workDir}
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx}
+
+\PYG{c+c1}{\PYGZsh{} Creates SALOME\PYGZus{}xx\PYGZus{}\PYGZlt{}arch\PYGZgt{}.tgz in \PYGZdl{}USER.workDir}
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}
+
+\PYG{c+c1}{\PYGZsh{} Creates MySpecificName.tgz in \PYGZdl{}USER.workDir}
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{name} \PYG{n}{MySpecificName}
+\end{sphinxVerbatim}
+\end{sphinxadmonition}
+\begin{itemize}
+\item {} 
+Force the creation of the archive (if it already exists):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{force}
+\end{sphinxVerbatim}
+
+\item {} 
+Include the binaries in the archive (products and prerequisites):
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{binaries}
+\end{sphinxVerbatim}
+
+This command will create an archive named \sphinxcode{\sphinxupquote{SALOME\_xx \_\textless{}arch\textgreater{}.tgz}}
+where \textless{}arch\textgreater{} is the \sphinxhref{https://en.wikipedia.org/wiki/Operating\_system}{OS}%
+\begin{footnote}[17]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Operating\_system}
+%
+\end{footnote} architecture of the machine.
+
+\item {} 
+Do not delete Version Control System (\sphinxhref{https://en.wikipedia.org/wiki/Version\_control}{VCS}%
+\begin{footnote}[18]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Version\_control}
+%
+\end{footnote}) informations from the configurations files of the embedded salomeTools:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{package} \PYG{n}{SALOME\PYGZus{}xx} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{with\PYGZus{}vcs}
+\end{sphinxVerbatim}
+
+The version control systems known by this option are \sphinxhref{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}{CVS}%
+\begin{footnote}[19]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://fr.wikipedia.org/wiki/Concurrent\_versions\_system}
+%
+\end{footnote}, \sphinxhref{https://en.wikipedia.org/wiki/Apache\_Subversion}{SVN}%
+\begin{footnote}[20]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://en.wikipedia.org/wiki/Apache\_Subversion}
+%
+\end{footnote} and \sphinxhref{https://git-scm.com}{Git}%
+\begin{footnote}[21]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://git-scm.com}
+%
+\end{footnote}.
+
+\end{itemize}
+
+
+\subsection{Some useful configuration pathes}
+\label{\detokenize{commands/package:some-useful-configuration-pathes}}
+No specific configuration.
+
+\clearpage
+
+
+\section{Command generate}
+\label{\detokenize{commands/generate:svn}}\label{\detokenize{commands/generate:command-generate}}\label{\detokenize{commands/generate::doc}}
+
+\subsection{Description}
+\label{\detokenize{commands/generate:description}}
+The \sphinxstylestrong{generate} command generates and compile SALOME modules from cpp modules using YACSGEN.
+
+\begin{sphinxadmonition}{note}{Note:}
+This command uses YACSGEN to generate the module. It needs to be specified with \sphinxstyleemphasis{\textendash{}yacsgen} option, or defined in the product or by the environment variable \sphinxcode{\sphinxupquote{\$YACSGEN\_ROOT\_DIR}}.
+\end{sphinxadmonition}
+
+
+\subsection{Remarks}
+\label{\detokenize{commands/generate:remarks}}\begin{itemize}
+\item {} 
+This command will only apply on the CPP modules of the application, those who have both properties:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{cpp} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
+\PYG{n}{generate} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{yes}\PYG{l+s+s2}{\PYGZdq{}}
+\end{sphinxVerbatim}
+
+\item {} 
+The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
+
+\end{itemize}
+
+
+\subsection{Usage}
+\label{\detokenize{commands/generate:usage}}\begin{itemize}
+\item {} 
+Generate all the modules of a product:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\item {} 
+Generate only specific modules:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{products} \PYG{o}{\PYGZlt{}}\PYG{n}{list\PYGZus{}of\PYGZus{}products}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+Remark: modules which don’t have the \sphinxstyleemphasis{generate} property are ignored.
+
+\item {} 
+Use a specific version of YACSGEN:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{sat} \PYG{n}{generate} \PYG{o}{\PYGZlt{}}\PYG{n}{application}\PYG{o}{\PYGZgt{}} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{yacsgen} \PYG{o}{\PYGZlt{}}\PYG{n}{path\PYGZus{}to\PYGZus{}yacsgen}\PYG{o}{\PYGZgt{}}
+\end{sphinxVerbatim}
+
+\end{itemize}
+
+
+\chapter{Developer documentation}
+\label{\detokenize{index:developer-documentation}}
+\clearpage
+
+
+\section{Add a user custom command}
+\label{\detokenize{write_command:svn}}\label{\detokenize{write_command:add-a-user-custom-command}}\label{\detokenize{write_command::doc}}
+
+\subsection{Introduction}
+\label{\detokenize{write_command:introduction}}
+\begin{sphinxadmonition}{note}{Note:}
+This documentation is for \sphinxhref{https://docs.python.org/2.7}{Python}%
+\begin{footnote}[22]\sphinxAtStartFootnote
+\sphinxnolinkurl{https://docs.python.org/2.7}
+%
+\end{footnote} developers.
+\end{sphinxadmonition}
+
+The salomeTools product provides a simple way to develop commands.
+The first thing to do is to add a file with \sphinxstyleemphasis{.py} extension in the \sphinxcode{\sphinxupquote{commands}} directory of salomeTools.
+
+Here are the basic requirements that must be followed in this file in order to add a command.
+
+
+\subsection{Basic requirements}
+\label{\detokenize{write_command:basic-requirements}}
+\begin{sphinxadmonition}{warning}{Warning:}
+ALL THIS IS OBSOLETE FOR SAT 5.1
+\end{sphinxadmonition}
+
+By adding a file \sphinxstyleemphasis{mycommand.py} in the \sphinxcode{\sphinxupquote{commands}} directory, salomeTools will define a new command named \sphinxcode{\sphinxupquote{mycommand}}.
+
+In \sphinxstyleemphasis{mycommand.py}, there must be the following method:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+    \PYG{c+c1}{\PYGZsh{} your algorithm ...}
+    \PYG{k}{pass}
+\end{sphinxVerbatim}
+
+In fact, at this point, the command will already be functional.
+But there are some useful services provided by salomeTools :
+\begin{itemize}
+\item {} 
+You can give some options to your command:
+
+\end{itemize}
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{import} \PYG{n+nn}{src}
+
+\PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command :  \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
+\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
+\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{m}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
+                  \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
+                  \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
+
+\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+    \PYG{c+c1}{\PYGZsh{} Parse the options}
+    \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
+    \PYG{c+c1}{\PYGZsh{} algorithm}
+\end{sphinxVerbatim}
+\begin{itemize}
+\item {} 
+You can add a \sphinxstyleemphasis{description} method that will display a message when the user will call the help:
+
+\end{itemize}
+
+\fvset{hllines={, 9, 10,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+ \PYG{k+kn}{import} \PYG{n+nn}{src}
+
+ \PYG{c+c1}{\PYGZsh{} Define all possible option for mycommand command : \PYGZsq{}sat mycommand \PYGZlt{}options\PYGZgt{}\PYGZsq{}}
+ \PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
+ \PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{m}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
+                   \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{myoption}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYGZbs{}
+                   \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{My option changes the behavior of my command.}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
+
+ \PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
+     \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{The help of mycommand.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
+
+ \PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+     \PYG{c+c1}{\PYGZsh{} Parse the options}
+     \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
+     \PYG{c+c1}{\PYGZsh{} algorithm}
+\end{sphinxVerbatim}
+
+
+\subsection{HowTo access salomeTools config and other commands}
+\label{\detokenize{write_command:howto-access-salometools-config-and-other-commands}}
+The \sphinxstyleemphasis{runner} variable is an python instance of \sphinxstyleemphasis{Sat} class.
+It gives access to \sphinxstyleemphasis{runner.getConfig()} which is the data model defined from all
+\sphinxstyleemphasis{configuration pyconf files} of salomeTools
+For example, \sphinxstyleemphasis{runner.cfg.APPLICATION.workdir}
+contains the root directory of the current application.
+
+The \sphinxstyleemphasis{runner} variable gives also access to other commands of salomeTools:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} as CLI\PYGZus{} \PYGZsq{}sat prepare ...\PYGZsq{}}
+\PYG{n}{runner}\PYG{o}{.}\PYG{n}{prepare}\PYG{p}{(}\PYG{n}{runner}\PYG{o}{.}\PYG{n}{cfg}\PYG{o}{.}\PYG{n}{VARS}\PYG{o}{.}\PYG{n}{application}\PYG{p}{)}
+\end{sphinxVerbatim}
+
+
+\subsection{HowTo logger}
+\label{\detokenize{write_command:howto-logger}}
+The logger variable is an instance of the python \sphinxcode{\sphinxupquote{logging}} package class.
+It gives access to \sphinxcode{\sphinxupquote{debug, info, warning, error, critical}} methods.
+
+Using these methods, the message passed as parameter
+will be displayed in the terminal and written in an xml log file.
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{logger}\PYG{o}{.}\PYG{n}{info}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{My message}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
+\end{sphinxVerbatim}
+
+
+\subsection{HELLO example}
+\label{\detokenize{write_command:hello-example}}
+Here is a \sphinxstyleemphasis{hello} command, file \sphinxstyleemphasis{commands/hello.py}:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{import} \PYG{n+nn}{src}
+
+\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}
+\PYG{l+s+sd}{hello.py}
+\PYG{l+s+sd}{Define all possible options for hello command:}
+\PYG{l+s+sd}{sat hello \PYGZlt{}options\PYGZgt{}}
+\PYG{l+s+sd}{\PYGZdq{}\PYGZdq{}\PYGZdq{}}
+
+\PYG{n}{parser} \PYG{o}{=} \PYG{n}{src}\PYG{o}{.}\PYG{n}{options}\PYG{o}{.}\PYG{n}{Options}\PYG{p}{(}\PYG{p}{)}
+\PYG{n}{parser}\PYG{o}{.}\PYG{n}{add\PYGZus{}option}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{f}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{french}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{boolean}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{french}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{french set hello message in french.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
+
+\PYG{k}{def} \PYG{n+nf}{description}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:}
+    \PYG{k}{return} \PYG{n}{\PYGZus{}}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{The help of hello.}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
+
+\PYG{k}{def} \PYG{n+nf}{run}\PYG{p}{(}\PYG{n}{args}\PYG{p}{,} \PYG{n}{runner}\PYG{p}{,} \PYG{n}{logger}\PYG{p}{)}\PYG{p}{:}
+    \PYG{c+c1}{\PYGZsh{} Parse the options}
+    \PYG{p}{(}\PYG{n}{options}\PYG{p}{,} \PYG{n}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n}{parser}\PYG{o}{.}\PYG{n}{parse\PYGZus{}args}\PYG{p}{(}\PYG{n}{args}\PYG{p}{)}
+    \PYG{c+c1}{\PYGZsh{} algorithm}
+    \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{options}\PYG{o}{.}\PYG{n}{french}\PYG{p}{:}
+        \PYG{n}{logger}\PYG{o}{.}\PYG{n}{info}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{HELLO! WORLD!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
+    \PYG{k}{else}\PYG{p}{:}
+        \PYG{n}{logger}\PYG{o}{.}\PYG{n}{writeinfo}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{Bonjour tout le monde!}\PYG{l+s+se}{\PYGZbs{}n}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
+\end{sphinxVerbatim}
+
+A first call of hello:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c+c1}{\PYGZsh{} Get the help of hello:}
+./sat \PYGZhy{}\PYGZhy{}help hello
+
+\PYG{c+c1}{\PYGZsh{} To get bonjour}
+./sat hello \PYGZhy{}\PYGZhy{}french
+Bonjour tout le monde!
+
+\PYG{c+c1}{\PYGZsh{} To get hello}
+./sat hello
+HELLO! WORLD!
+
+\PYG{c+c1}{\PYGZsh{} To get the log}
+./sat log
+\end{sphinxVerbatim}
+
+
+\chapter{Code documentation}
+\label{\detokenize{index:code-documentation}}
+
+\section{src}
+\label{\detokenize{apidoc_src/modules:src}}\label{\detokenize{apidoc_src/modules::doc}}
+
+\subsection{src package}
+\label{\detokenize{apidoc_src/src::doc}}\label{\detokenize{apidoc_src/src:src-package}}
+
+\subsubsection{Subpackages}
+\label{\detokenize{apidoc_src/src:subpackages}}
+
+\paragraph{src.colorama package}
+\label{\detokenize{apidoc_src/src.colorama:src-colorama-package}}\label{\detokenize{apidoc_src/src.colorama::doc}}
+
+\subparagraph{Submodules}
+\label{\detokenize{apidoc_src/src.colorama:submodules}}
+
+\subparagraph{src.colorama.ansi module}
+\label{\detokenize{apidoc_src/src.colorama:module-src.colorama.ansi}}\label{\detokenize{apidoc_src/src.colorama:src-colorama-ansi-module}}\index{src.colorama.ansi (module)}
+This module generates ANSI character codes to printing colors to terminals.
+See: \sphinxurl{http://en.wikipedia.org/wiki/ANSI\_escape\_code}
+\index{AnsiBack (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiBack}}}
+Bases: {\hyperref[\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}})
+\index{BLACK (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 40}}}
+\end{fulllineitems}
+
+\index{BLUE (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 44}}}
+\end{fulllineitems}
+
+\index{CYAN (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 46}}}
+\end{fulllineitems}
+
+\index{GREEN (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 42}}}
+\end{fulllineitems}
+
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 100}}}
+\end{fulllineitems}
+
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 104}}}
+\end{fulllineitems}
+
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 106}}}
+\end{fulllineitems}
+
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 102}}}
+\end{fulllineitems}
+
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 105}}}
+\end{fulllineitems}
+
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 101}}}
+\end{fulllineitems}
+
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 107}}}
+\end{fulllineitems}
+
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 103}}}
+\end{fulllineitems}
+
+\index{MAGENTA (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 45}}}
+\end{fulllineitems}
+
+\index{RED (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 41}}}
+\end{fulllineitems}
+
+\index{RESET (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 49}}}
+\end{fulllineitems}
+
+\index{WHITE (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 47}}}
+\end{fulllineitems}
+
+\index{YELLOW (src.colorama.ansi.AnsiBack attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiBack.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 43}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{AnsiCodes (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCodes}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+\end{fulllineitems}
+
+\index{AnsiCursor (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiCursor}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{BACK() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.BACK}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{BACK}}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{DOWN() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.DOWN}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{DOWN}}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{FORWARD() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.FORWARD}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{FORWARD}}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+\index{POS() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.POS}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{POS}}}{\emph{x=1}, \emph{y=1}}{}
+\end{fulllineitems}
+
+\index{UP() (src.colorama.ansi.AnsiCursor method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCursor.UP}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{UP}}}{\emph{n=1}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{AnsiFore (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiFore}}}
+Bases: {\hyperref[\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}})
+\index{BLACK (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 30}}}
+\end{fulllineitems}
+
+\index{BLUE (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 34}}}
+\end{fulllineitems}
+
+\index{CYAN (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 36}}}
+\end{fulllineitems}
+
+\index{GREEN (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 32}}}
+\end{fulllineitems}
+
+\index{LIGHTBLACK\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLACK_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLACK\_EX}}\sphinxbfcode{\sphinxupquote{ = 90}}}
+\end{fulllineitems}
+
+\index{LIGHTBLUE\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTBLUE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTBLUE\_EX}}\sphinxbfcode{\sphinxupquote{ = 94}}}
+\end{fulllineitems}
+
+\index{LIGHTCYAN\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTCYAN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTCYAN\_EX}}\sphinxbfcode{\sphinxupquote{ = 96}}}
+\end{fulllineitems}
+
+\index{LIGHTGREEN\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTGREEN_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTGREEN\_EX}}\sphinxbfcode{\sphinxupquote{ = 92}}}
+\end{fulllineitems}
+
+\index{LIGHTMAGENTA\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTMAGENTA_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTMAGENTA\_EX}}\sphinxbfcode{\sphinxupquote{ = 95}}}
+\end{fulllineitems}
+
+\index{LIGHTRED\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTRED_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTRED\_EX}}\sphinxbfcode{\sphinxupquote{ = 91}}}
+\end{fulllineitems}
+
+\index{LIGHTWHITE\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTWHITE_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTWHITE\_EX}}\sphinxbfcode{\sphinxupquote{ = 97}}}
+\end{fulllineitems}
+
+\index{LIGHTYELLOW\_EX (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.LIGHTYELLOW_EX}}\pysigline{\sphinxbfcode{\sphinxupquote{LIGHTYELLOW\_EX}}\sphinxbfcode{\sphinxupquote{ = 93}}}
+\end{fulllineitems}
+
+\index{MAGENTA (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 35}}}
+\end{fulllineitems}
+
+\index{RED (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 31}}}
+\end{fulllineitems}
+
+\index{RESET (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.RESET}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET}}\sphinxbfcode{\sphinxupquote{ = 39}}}
+\end{fulllineitems}
+
+\index{WHITE (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.WHITE}}\pysigline{\sphinxbfcode{\sphinxupquote{WHITE}}\sphinxbfcode{\sphinxupquote{ = 37}}}
+\end{fulllineitems}
+
+\index{YELLOW (src.colorama.ansi.AnsiFore attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiFore.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 33}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{AnsiStyle (class in src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{AnsiStyle}}}
+Bases: {\hyperref[\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.colorama.ansi.AnsiCodes}}}}} (\autopageref*{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiCodes}})
+\index{BRIGHT (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 1}}}
+\end{fulllineitems}
+
+\index{DIM (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.DIM}}\pysigline{\sphinxbfcode{\sphinxupquote{DIM}}\sphinxbfcode{\sphinxupquote{ = 2}}}
+\end{fulllineitems}
+
+\index{NORMAL (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 22}}}
+\end{fulllineitems}
+
+\index{RESET\_ALL (src.colorama.ansi.AnsiStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.AnsiStyle.RESET_ALL}}\pysigline{\sphinxbfcode{\sphinxupquote{RESET\_ALL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{clear\_line() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.clear_line}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_line}}}{\emph{mode=2}}{}
+\end{fulllineitems}
+
+\index{clear\_screen() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.clear_screen}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{clear\_screen}}}{\emph{mode=2}}{}
+\end{fulllineitems}
+
+\index{code\_to\_chars() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.code_to_chars}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{code\_to\_chars}}}{\emph{code}}{}
+\end{fulllineitems}
+
+\index{set\_title() (in module src.colorama.ansi)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansi.set_title}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansi.}}\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{src.colorama.ansitowin32 module}
+\label{\detokenize{apidoc_src/src.colorama:module-src.colorama.ansitowin32}}\label{\detokenize{apidoc_src/src.colorama:src-colorama-ansitowin32-module}}\index{src.colorama.ansitowin32 (module)}\index{AnsiToWin32 (class in src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{AnsiToWin32}}}{\emph{wrapped}, \emph{convert=None}, \emph{strip=None}, \emph{autoreset=False}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Implements a ‘write()’ method which, on Windows, will strip ANSI character
+sequences from the text, and if outputting to a tty, will convert them into
+win32 function calls.
+\index{ANSI\_CSI\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_CSI_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_CSI\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x3504970\textgreater{}}}}
+\end{fulllineitems}
+
+\index{ANSI\_OSC\_RE (src.colorama.ansitowin32.AnsiToWin32 attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.ANSI_OSC_RE}}\pysigline{\sphinxbfcode{\sphinxupquote{ANSI\_OSC\_RE}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x350dc10\textgreater{}}}}
+\end{fulllineitems}
+
+\index{call\_win32() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.call_win32}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{call\_win32}}}{\emph{command}, \emph{params}}{}
+\end{fulllineitems}
+
+\index{convert\_ansi() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_ansi}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_ansi}}}{\emph{paramstring}, \emph{command}}{}
+\end{fulllineitems}
+
+\index{convert\_osc() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.convert_osc}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{convert\_osc}}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{extract\_params() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.extract_params}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{extract\_params}}}{\emph{command}, \emph{paramstring}}{}
+\end{fulllineitems}
+
+\index{get\_win32\_calls() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.get_win32_calls}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_win32\_calls}}}{}{}
+\end{fulllineitems}
+
+\index{reset\_all() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
+\end{fulllineitems}
+
+\index{should\_wrap() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.should_wrap}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{should\_wrap}}}{}{}
+True if this class is actually needed. If false, then the output
+stream will not be affected, nor will win32 calls be issued, so
+wrapping stdout is not actually required. This will generally be
+False on non-Windows platforms, unless optional functionality like
+autoreset has been requested using kwargs to init()
+
+\end{fulllineitems}
+
+\index{write() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{write\_and\_convert() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_and_convert}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_and\_convert}}}{\emph{text}}{}
+Write the given text to our wrapped stream, stripping any ANSI
+sequences from the text, and optionally converting them into win32
+calls.
+
+\end{fulllineitems}
+
+\index{write\_plain\_text() (src.colorama.ansitowin32.AnsiToWin32 method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.AnsiToWin32.write_plain_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_plain\_text}}}{\emph{text}, \emph{start}, \emph{end}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{StreamWrapper (class in src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.StreamWrapper}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{StreamWrapper}}}{\emph{wrapped}, \emph{converter}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Wraps a stream (such as stdout), acting as a transparent proxy for all
+attribute access apart from method ‘write()’, which is delegated to our
+Converter instance.
+\index{write() (src.colorama.ansitowin32.StreamWrapper method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.StreamWrapper.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{text}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{is\_a\_tty() (in module src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.is_a_tty}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_a\_tty}}}{\emph{stream}}{}
+\end{fulllineitems}
+
+\index{is\_stream\_closed() (in module src.colorama.ansitowin32)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.ansitowin32.is_stream_closed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.ansitowin32.}}\sphinxbfcode{\sphinxupquote{is\_stream\_closed}}}{\emph{stream}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{src.colorama.initialise module}
+\label{\detokenize{apidoc_src/src.colorama:src-colorama-initialise-module}}\label{\detokenize{apidoc_src/src.colorama:module-src.colorama.initialise}}\index{src.colorama.initialise (module)}\index{colorama\_text() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.initialise.colorama_text}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{colorama\_text}}}{\emph{*args}, \emph{**kwds}}{}
+\end{fulllineitems}
+
+\index{deinit() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.initialise.deinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{deinit}}}{}{}
+\end{fulllineitems}
+
+\index{init() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.initialise.init}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{init}}}{\emph{autoreset=False}, \emph{convert=None}, \emph{strip=None}, \emph{wrap=True}}{}
+\end{fulllineitems}
+
+\index{reinit() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.initialise.reinit}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reinit}}}{}{}
+\end{fulllineitems}
+
+\index{reset\_all() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.initialise.reset_all}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{reset\_all}}}{}{}
+\end{fulllineitems}
+
+\index{wrap\_stream() (in module src.colorama.initialise)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.initialise.wrap_stream}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.initialise.}}\sphinxbfcode{\sphinxupquote{wrap\_stream}}}{\emph{stream}, \emph{convert}, \emph{strip}, \emph{autoreset}, \emph{wrap}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{src.colorama.win32 module}
+\label{\detokenize{apidoc_src/src.colorama:src-colorama-win32-module}}\label{\detokenize{apidoc_src/src.colorama:module-src.colorama.win32}}\index{src.colorama.win32 (module)}\index{SetConsoleTextAttribute() (in module src.colorama.win32)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.win32.SetConsoleTextAttribute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{SetConsoleTextAttribute}}}{\emph{*\_}}{}
+\end{fulllineitems}
+
+\index{winapi\_test() (in module src.colorama.win32)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.win32.winapi_test}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.colorama.win32.}}\sphinxbfcode{\sphinxupquote{winapi\_test}}}{\emph{*\_}}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{src.colorama.winterm module}
+\label{\detokenize{apidoc_src/src.colorama:module-src.colorama.winterm}}\label{\detokenize{apidoc_src/src.colorama:src-colorama-winterm-module}}\index{src.colorama.winterm (module)}\index{WinColor (class in src.colorama.winterm)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinColor}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{BLACK (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.BLACK}}\pysigline{\sphinxbfcode{\sphinxupquote{BLACK}}\sphinxbfcode{\sphinxupquote{ = 0}}}
+\end{fulllineitems}
+
+\index{BLUE (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.BLUE}}\pysigline{\sphinxbfcode{\sphinxupquote{BLUE}}\sphinxbfcode{\sphinxupquote{ = 1}}}
+\end{fulllineitems}
+
+\index{CYAN (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.CYAN}}\pysigline{\sphinxbfcode{\sphinxupquote{CYAN}}\sphinxbfcode{\sphinxupquote{ = 3}}}
+\end{fulllineitems}
+
+\index{GREEN (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.GREEN}}\pysigline{\sphinxbfcode{\sphinxupquote{GREEN}}\sphinxbfcode{\sphinxupquote{ = 2}}}
+\end{fulllineitems}
+
+\index{GREY (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.GREY}}\pysigline{\sphinxbfcode{\sphinxupquote{GREY}}\sphinxbfcode{\sphinxupquote{ = 7}}}
+\end{fulllineitems}
+
+\index{MAGENTA (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.MAGENTA}}\pysigline{\sphinxbfcode{\sphinxupquote{MAGENTA}}\sphinxbfcode{\sphinxupquote{ = 5}}}
+\end{fulllineitems}
+
+\index{RED (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.RED}}\pysigline{\sphinxbfcode{\sphinxupquote{RED}}\sphinxbfcode{\sphinxupquote{ = 4}}}
+\end{fulllineitems}
+
+\index{YELLOW (src.colorama.winterm.WinColor attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinColor.YELLOW}}\pysigline{\sphinxbfcode{\sphinxupquote{YELLOW}}\sphinxbfcode{\sphinxupquote{ = 6}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{WinStyle (class in src.colorama.winterm)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinStyle}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinStyle}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{BRIGHT (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinStyle.BRIGHT}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT}}\sphinxbfcode{\sphinxupquote{ = 8}}}
+\end{fulllineitems}
+
+\index{BRIGHT\_BACKGROUND (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinStyle.BRIGHT_BACKGROUND}}\pysigline{\sphinxbfcode{\sphinxupquote{BRIGHT\_BACKGROUND}}\sphinxbfcode{\sphinxupquote{ = 128}}}
+\end{fulllineitems}
+
+\index{NORMAL (src.colorama.winterm.WinStyle attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinStyle.NORMAL}}\pysigline{\sphinxbfcode{\sphinxupquote{NORMAL}}\sphinxbfcode{\sphinxupquote{ = 0}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{WinTerm (class in src.colorama.winterm)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.colorama.winterm.}}\sphinxbfcode{\sphinxupquote{WinTerm}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+\index{back() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.back}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{back}}}{\emph{back=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{cursor\_adjust() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.cursor_adjust}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cursor\_adjust}}}{\emph{x}, \emph{y}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{erase\_line() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.erase_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_line}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{erase\_screen() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.erase_screen}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{erase\_screen}}}{\emph{mode=0}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{fore() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.fore}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{fore}}}{\emph{fore=None}, \emph{light=False}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{get\_attrs() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.get_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrs}}}{}{}
+\end{fulllineitems}
+
+\index{get\_position() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.get_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_position}}}{\emph{handle}}{}
+\end{fulllineitems}
+
+\index{reset\_all() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.reset_all}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{reset\_all}}}{\emph{on\_stderr=None}}{}
+\end{fulllineitems}
+
+\index{set\_attrs() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_attrs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_attrs}}}{\emph{value}}{}
+\end{fulllineitems}
+
+\index{set\_console() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_console}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_console}}}{\emph{attrs=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{set\_cursor\_position() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_cursor_position}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cursor\_position}}}{\emph{position=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+\index{set\_title() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.set_title}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_title}}}{\emph{title}}{}
+\end{fulllineitems}
+
+\index{style() (src.colorama.winterm.WinTerm method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.colorama:src.colorama.winterm.WinTerm.style}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{style}}}{\emph{style=None}, \emph{on\_stderr=False}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subparagraph{Module contents}
+\label{\detokenize{apidoc_src/src.colorama:module-src.colorama}}\label{\detokenize{apidoc_src/src.colorama:module-contents}}\index{src.colorama (module)}
+
+\paragraph{src.example package}
+\label{\detokenize{apidoc_src/src.example:src-example-package}}\label{\detokenize{apidoc_src/src.example::doc}}
+
+\subparagraph{Submodules}
+\label{\detokenize{apidoc_src/src.example:submodules}}
+
+\subparagraph{src.example.essai\_logging\_1 module}
+\label{\detokenize{apidoc_src/src.example:module-src.example.essai_logging_1}}\label{\detokenize{apidoc_src/src.example:src-example-essai-logging-1-module}}\index{src.example.essai\_logging\_1 (module)}
+\sphinxurl{http://sametmax.com/ecrire-des-logs-en-python/}
+\sphinxurl{https://docs.python.org/3/library/time.html\#time.strftime}
+
+essai utilisation logger plusieurs handler format different
+\begin{quote}
+
+/usr/lib/python2.7/logging/\_\_init\_\_.pyc
+
+init MyLogger, fmt=’\%(asctime)s :: \%(levelname)-8s :: \%(message)s’, level=‘20’
+
+2018-03-11 18:51:21 :: INFO     :: test logger info
+2018-03-11 18:51:21 :: WARNING  :: test logger warning
+2018-03-11 18:51:21 :: ERROR    :: test logger error
+2018-03-11 18:51:21 :: CRITICAL :: test logger critical
+
+init MyLogger, fmt=’None’, level=‘10’
+
+2018-03-11 18:51:21 :: DEBUG    :: test logger debug
+test logger debug
+2018-03-11 18:51:21 :: INFO     :: test logger info
+test logger info
+2018-03-11 18:51:21 :: WARNING  :: test logger warning
+test logger warning
+2018-03-11 18:51:21 :: ERROR    :: test logger error
+test logger error
+2018-03-11 18:51:21 :: CRITICAL :: test logger critical
+test logger critical
+\end{quote}
+\index{getMyLogger() (in module src.example.essai\_logging\_1)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_1.getMyLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.example.essai\_logging\_1.}}\sphinxbfcode{\sphinxupquote{getMyLogger}}}{}{}
+\end{fulllineitems}
+
+\index{initMyLogger() (in module src.example.essai\_logging\_1)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_1.initMyLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.example.essai\_logging\_1.}}\sphinxbfcode{\sphinxupquote{initMyLogger}}}{\emph{fmt=None}, \emph{level=None}}{}
+\end{fulllineitems}
+
+\index{testLogger1() (in module src.example.essai\_logging\_1)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_1.testLogger1}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.example.essai\_logging\_1.}}\sphinxbfcode{\sphinxupquote{testLogger1}}}{}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{src.example.essai\_logging\_2 module}
+\label{\detokenize{apidoc_src/src.example:module-src.example.essai_logging_2}}\label{\detokenize{apidoc_src/src.example:src-example-essai-logging-2-module}}\index{src.example.essai\_logging\_2 (module)}
+\sphinxurl{http://sametmax.com/ecrire-des-logs-en-python/}
+\sphinxurl{https://docs.python.org/3/library/time.html\#time.strftime}
+
+essai utilisation logger un handler format different 
+sur info() pas de format et su other format
+\begin{quote}
+
+/usr/lib/python2.7/logging/\_\_init\_\_.pyc
+
+init MyLogger, fmt=’\%(asctime)s :: \%(levelname)-8s :: \%(message)s’, level=‘20’
+
+test logger info
+2018-03-11 18:51:51 :: WARNING  :: test logger warning
+2018-03-11 18:51:51 :: ERROR    :: test logger error
+2018-03-11 18:51:51 :: CRITICAL :: test logger critical
+\end{quote}
+\index{MyFormatter (class in src.example.essai\_logging\_2)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_2.MyFormatter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.example.essai\_logging\_2.}}\sphinxbfcode{\sphinxupquote{MyFormatter}}}{\emph{fmt=None}, \emph{datefmt=None}}{}
+Bases: \sphinxcode{\sphinxupquote{logging.Formatter}}
+\index{format() (src.example.essai\_logging\_2.MyFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_2.MyFormatter.format}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{format}}}{\emph{record}}{}
+Format the specified record as text.
+
+The record’s attribute dictionary is used as the operand to a
+string formatting operation which yields the returned string.
+Before formatting the dictionary, a couple of preparatory steps
+are carried out. The message attribute of the record is computed
+using LogRecord.getMessage(). If the formatting string uses the
+time (as determined by a call to usesTime(), formatTime() is
+called to format the event time. If there is exception information,
+it is formatted using formatException() and appended to the message.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{getMyLogger() (in module src.example.essai\_logging\_2)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_2.getMyLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.example.essai\_logging\_2.}}\sphinxbfcode{\sphinxupquote{getMyLogger}}}{}{}
+\end{fulllineitems}
+
+\index{initMyLogger() (in module src.example.essai\_logging\_2)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_2.initMyLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.example.essai\_logging\_2.}}\sphinxbfcode{\sphinxupquote{initMyLogger}}}{\emph{fmt=None}, \emph{level=None}}{}
+\end{fulllineitems}
+
+\index{testLogger1() (in module src.example.essai\_logging\_2)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src.example:src.example.essai_logging_2.testLogger1}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.example.essai\_logging\_2.}}\sphinxbfcode{\sphinxupquote{testLogger1}}}{}{}
+\end{fulllineitems}
+
+
+
+\subparagraph{Module contents}
+\label{\detokenize{apidoc_src/src.example:module-contents}}\label{\detokenize{apidoc_src/src.example:module-src.example}}\index{src.example (module)}
+
+\subsubsection{Submodules}
+\label{\detokenize{apidoc_src/src:submodules}}
+
+\subsubsection{src.ElementTree module}
+\label{\detokenize{apidoc_src/src:src-elementtree-module}}\label{\detokenize{apidoc_src/src:module-src.ElementTree}}\index{src.ElementTree (module)}\index{Comment() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.Comment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Comment}}}{\emph{text=None}}{}
+\end{fulllineitems}
+
+\index{dump() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.dump}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{dump}}}{\emph{elem}}{}
+\end{fulllineitems}
+
+\index{Element() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.Element}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{Element}}}{\emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\end{fulllineitems}
+
+\index{ElementTree (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ElementTree}}}{\emph{element=None}, \emph{file=None}}{}~\index{find() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.find}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find}}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{findall() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.findall}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findall}}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{findtext() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.findtext}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findtext}}}{\emph{path}, \emph{default=None}}{}
+\end{fulllineitems}
+
+\index{getiterator() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.getiterator}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getiterator}}}{\emph{tag=None}}{}
+\end{fulllineitems}
+
+\index{getroot() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.getroot}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getroot}}}{}{}
+\end{fulllineitems}
+
+\index{parse() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.parse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
+
+\index{write() (src.ElementTree.ElementTree method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ElementTree.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{file}, \emph{encoding='us-ascii'}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{fromstring() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.fromstring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{fromstring}}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{iselement() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.iselement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iselement}}}{\emph{element}}{}
+\end{fulllineitems}
+
+\index{iterparse (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.iterparse}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{iterparse}}}{\emph{source}, \emph{events=None}}{}~\index{next() (src.ElementTree.iterparse method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.iterparse.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{parse() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.parse}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{parse}}}{\emph{source}, \emph{parser=None}}{}
+\end{fulllineitems}
+
+\index{PI() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.PI}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{PI}}}{\emph{target}, \emph{text=None}}{}
+\end{fulllineitems}
+
+\index{ProcessingInstruction() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.ProcessingInstruction}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{ProcessingInstruction}}}{\emph{target}, \emph{text=None}}{}
+\end{fulllineitems}
+
+\index{QName (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.QName}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{QName}}}{\emph{text\_or\_uri}, \emph{tag=None}}{}
+\end{fulllineitems}
+
+\index{SubElement() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.SubElement}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{SubElement}}}{\emph{parent}, \emph{tag}, \emph{attrib=\{\}}, \emph{**extra}}{}
+\end{fulllineitems}
+
+\index{tostring() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.tostring}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{tostring}}}{\emph{element}, \emph{encoding=None}}{}
+\end{fulllineitems}
+
+\index{TreeBuilder (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.TreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{TreeBuilder}}}{\emph{element\_factory=None}}{}~\index{close() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.TreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\end{fulllineitems}
+
+\index{data() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.TreeBuilder.data}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{data}}}{\emph{data}}{}
+\end{fulllineitems}
+
+\index{end() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.TreeBuilder.end}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{end}}}{\emph{tag}}{}
+\end{fulllineitems}
+
+\index{start() (src.ElementTree.TreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.TreeBuilder.start}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{start}}}{\emph{tag}, \emph{attrs}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{XML() (in module src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.XML}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XML}}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{XMLTreeBuilder (class in src.ElementTree)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.XMLTreeBuilder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.ElementTree.}}\sphinxbfcode{\sphinxupquote{XMLTreeBuilder}}}{\emph{html=0}, \emph{target=None}}{}~\index{close() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.XMLTreeBuilder.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\end{fulllineitems}
+
+\index{doctype() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.XMLTreeBuilder.doctype}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{doctype}}}{\emph{name}, \emph{pubid}, \emph{system}}{}
+\end{fulllineitems}
+
+\index{feed() (src.ElementTree.XMLTreeBuilder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.ElementTree.XMLTreeBuilder.feed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{feed}}}{\emph{data}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.architecture module}
+\label{\detokenize{apidoc_src/src:module-src.architecture}}\label{\detokenize{apidoc_src/src:src-architecture-module}}\index{src.architecture (module)}
+Contains all the stuff that can change with the architecture 
+on which SAT is running
+\index{get\_distrib\_version() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.architecture.get_distrib_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distrib\_version}}}{\emph{distrib}, \emph{codes}}{}
+Gets the version of the distribution
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{distrib}} \textendash{} (str) 
+The distribution on which the version will be found.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{codes}} \textendash{} (L\{Mapping\}) 
+The map containing distribution correlation table.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str)
+The version of the distribution on which 
+salomeTools is running, regarding the distribution 
+correlation table contained in codes variable.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_distribution() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.architecture.get_distribution}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_distribution}}}{\emph{codes}}{}
+Gets the code for the distribution
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{codes}} \textendash{} (L\{Mapping\}) 
+The map containing distribution correlation table.
+
+\item[{Returns}] \leavevmode
+(str)
+The distribution on which salomeTools is running, regarding the 
+distribution correlation table contained in codes variable.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_nb\_proc() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.architecture.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{}{}
+Gets the number of processors of the machine 
+on which salomeTools is running.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str) The number of processors.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_python\_version() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.architecture.get_python_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_python\_version}}}{}{}
+Gets the version of the running python.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str) The version of the running python.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_user() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.architecture.get_user}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{get\_user}}}{}{}
+Gets the username that launched sat
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str) environ var USERNAME
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_windows() (in module src.architecture)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.architecture.is_windows}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.architecture.}}\sphinxbfcode{\sphinxupquote{is\_windows}}}{}{}
+Checks windows OS
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(bool) True if system is Windows
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.catchAll module}
+\label{\detokenize{apidoc_src/src:module-src.catchAll}}\label{\detokenize{apidoc_src/src:src-catchall-module}}\index{src.catchAll (module)}
+define class as a simple dictionary with keys
+with pretty print \_\_str\_\_ and \_\_repr\_\_ (indented as recursive)
+and jsonDumps()
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import catchAll as CAA
+\textgreater{}\textgreater{} a = CAA.CatchAll()
+\textgreater{}\textgreater{} a.tintin = “reporter”
+\textgreater{}\textgreater{} a.milou = “dog”
+\textgreater{}\textgreater{} print(“a=\%s” \% a)
+\textgreater{}\textgreater{} print(“tintin: \%s” \% a.tintin)
+
+\end{description}
+\index{CatchAll (class in src.catchAll)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.catchAll.CatchAll}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.catchAll.}}\sphinxbfcode{\sphinxupquote{CatchAll}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+class as simple dynamic dictionary 
+with predefined keys as properties in
+inherited classes through \_\_init\_\_ method. Or NOT. 
+with pretty print \_\_str\_\_ and \_\_repr\_\_ (indented as recursive)
+with jsonDumps()
+
+usage:
+
+\textgreater{}\textgreater{} import catchAll as CAA
+\textgreater{}\textgreater{} a = CAA.CatchAll()
+\textgreater{}\textgreater{} a.tintin = “reporter”
+\textgreater{}\textgreater{} a.milou = “dog”
+\textgreater{}\textgreater{} print(“a=\%s” \% a)
+\textgreater{}\textgreater{} print(“tintin: \%s” \% a.tintin)
+
+as
+
+\textgreater{}\textgreater{} a = \{\}
+\textgreater{}\textgreater{} a{[}“tintin”{]} = “reporter”
+\textgreater{}\textgreater{} a{[}“milou”{]} = “dog”
+\textgreater{}\textgreater{} print(“tintin: \%s” \% a{[}“tintin”{]}
+\index{jsonDumps() (src.catchAll.CatchAll method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.catchAll.CatchAll.jsonDumps}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{jsonDumps}}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{dumper() (in module src.catchAll)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.catchAll.dumper}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.catchAll.}}\sphinxbfcode{\sphinxupquote{dumper}}}{\emph{obj}}{}
+to json explore subclass object as dict
+
+\end{fulllineitems}
+
+\index{dumperType() (in module src.catchAll)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.catchAll.dumperType}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.catchAll.}}\sphinxbfcode{\sphinxupquote{dumperType}}}{\emph{obj}}{}
+to get a “\_type” to trace json subclass object,
+but ignore all attributes begining with ‘\_’
+
+\end{fulllineitems}
+
+\index{jsonDumps() (in module src.catchAll)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.catchAll.jsonDumps}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.catchAll.}}\sphinxbfcode{\sphinxupquote{jsonDumps}}}{\emph{obj}}{}
+to get direct default jsonDumps method
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.coloringSat module}
+\label{\detokenize{apidoc_src/src:module-src.coloringSat}}\label{\detokenize{apidoc_src/src:src-coloringsat-module}}\index{src.coloringSat (module)}
+simple tagging as ‘\textless{}color\textgreater{}’ for simple coloring log messages on terminal(s)
+window or unix or ios using backend colorama
+
+using ‘\textless{}color\textgreater{}’ because EZ human readable
+so ‘\textless{}color\textgreater{}’ are not supposed existing in log message
+“\{\}”.format() is not choosen because “\{\}” are present
+in log messages of contents of python dict (as JSON) etc.
+
+usage:
+\textgreater{}\textgreater{} import src.coloringSat as COLS
+
+example:
+\textgreater{}\textgreater{} log(“this is in \textless{}green\textgreater{}color green\textless{}reset\textgreater{}, OK is in blue: \textless{}blue\textgreater{}OK?”)
+\index{ColoringStream (class in src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.ColoringStream}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{ColoringStream}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+write my stream class
+only write and flush are used for the streaming
+\sphinxurl{https://docs.python.org/2/library/logging.handlers.html}
+\sphinxurl{https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string}
+\index{flush() (src.coloringSat.ColoringStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.ColoringStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
+\end{fulllineitems}
+
+\index{write() (src.coloringSat.ColoringStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.ColoringStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{astr}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{cleanColors() (in module src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.cleanColors}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{cleanColors}}}{\emph{msg}}{}
+clean the message of color tags ‘\textless{}red\textgreater{} …
+
+\end{fulllineitems}
+
+\index{indent() (in module src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{msg}, \emph{nb}, \emph{car=' '}}{}
+indent nb car (spaces) multi lines message except first one
+
+\end{fulllineitems}
+
+\index{log() (in module src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{log}}}{\emph{msg}}{}
+elementary log stdout for debug if \_verbose
+
+\end{fulllineitems}
+
+\index{replace() (in module src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.replace}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{replace}}}{\emph{msg}, \emph{tags}}{}
+\end{fulllineitems}
+
+\index{toColor() (in module src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.toColor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{toColor}}}{\emph{msg}}{}
+automatically clean the message of color tags ‘\textless{}red\textgreater{} … 
+if the terminal output stdout is redirected by user
+if not, replace tags with ansi color codes
+
+example:
+\textgreater{}\textgreater{} sat compile SALOME \textgreater{} log.txt
+
+\end{fulllineitems}
+
+\index{toColor\_AnsiToWin32() (in module src.coloringSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.coloringSat.toColor_AnsiToWin32}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.coloringSat.}}\sphinxbfcode{\sphinxupquote{toColor\_AnsiToWin32}}}{\emph{msg}}{}
+for test debug no wrapping
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.compilation module}
+\label{\detokenize{apidoc_src/src:module-src.compilation}}\label{\detokenize{apidoc_src/src:src-compilation-module}}\index{src.compilation (module)}\index{Builder (class in src.compilation)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.compilation.}}\sphinxbfcode{\sphinxupquote{Builder}}}{\emph{config}, \emph{logger}, \emph{product\_info}, \emph{options=OptResult(   )}, \emph{check\_src=True}}{}
+Class to handle all construction steps, like cmake, configure, make, …
+\index{build\_configure() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.build_configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{build\_configure}}}{\emph{options=''}}{}
+\end{fulllineitems}
+
+\index{check() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.check}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check}}}{\emph{command=''}}{}
+\end{fulllineitems}
+
+\index{cmake() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.cmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cmake}}}{\emph{options=''}}{}
+\end{fulllineitems}
+
+\index{complete\_environment() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.complete_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{complete\_environment}}}{\emph{make\_options}}{}
+\end{fulllineitems}
+
+\index{configure() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.configure}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{configure}}}{\emph{options=''}}{}
+\end{fulllineitems}
+
+\index{do\_batch\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.do_batch_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_batch\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
+\end{fulllineitems}
+
+\index{do\_default\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.do_default_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_default\_build}}}{\emph{build\_conf\_options=''}, \emph{configure\_options=''}, \emph{show\_warning=True}}{}
+\end{fulllineitems}
+
+\index{do\_python\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.do_python_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_python\_script\_build}}}{\emph{script}, \emph{nb\_proc}}{}
+Performs a build with a script.
+
+\end{fulllineitems}
+
+\index{do\_script\_build() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.do_script_build}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{do\_script\_build}}}{\emph{script}, \emph{number\_of\_proc=0}}{}
+\end{fulllineitems}
+
+\index{hack\_libtool() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.hack_libtool}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{hack\_libtool}}}{}{}
+\end{fulllineitems}
+
+\index{install() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.install}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{install}}}{}{}
+\end{fulllineitems}
+
+\index{log() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log}}}{\emph{text}, \emph{level}, \emph{showInfo=True}}{}
+Shortcut method to log in log file.
+
+\end{fulllineitems}
+
+\index{log\_command() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.log_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{log\_command}}}{\emph{command}}{}
+Shortcut method to log a command.
+
+\end{fulllineitems}
+
+\index{make() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{nb\_proc}, \emph{make\_opt=''}}{}
+\end{fulllineitems}
+
+\index{prepare() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.prepare}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare}}}{}{}
+Prepares the environment.
+Build two environment: one for building and one for testing (launch).
+
+\end{fulllineitems}
+
+\index{put\_txt\_log\_in\_appli\_log\_dir() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.put_txt_log_in_appli_log_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_txt\_log\_in\_appli\_log\_dir}}}{\emph{file\_name}}{}
+Put the txt log (that contain the system logs, like make command output)
+in the directory \textless{}APPLICATION DIR\textgreater{}/LOGS/\textless{}product\_name\textgreater{}/
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{file\_name}} \textendash{} (str) The name of the file to write
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{wmake() (src.compilation.Builder method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.compilation.Builder.wmake}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{wmake}}}{\emph{nb\_proc}, \emph{opt\_nb\_proc=None}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.configManager module}
+\label{\detokenize{apidoc_src/src:module-src.configManager}}\label{\detokenize{apidoc_src/src:src-configmanager-module}}\index{src.configManager (module)}\index{ConfigManager (class in src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigManager}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{ConfigManager}}}{\emph{runner}}{}
+Class that manages the read of all the config .pyconf files of salomeTools
+\index{create\_config\_file() (src.configManager.ConfigManager method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigManager.create_config_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{create\_config\_file}}}{\emph{config}}{}
+This method is called when there are no user config file. 
+It build it from scratch.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global config.
+
+\item[{Returns}] \leavevmode
+(Config) 
+The config corresponding to the file created.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_command\_line\_overrides() (src.configManager.ConfigManager method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigManager.get_command_line_overrides}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_command\_line\_overrides}}}{\emph{options}, \emph{sections}}{}
+get all the overwrites that are in the command line
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} The options from salomeTools class initialization 
+(as ‘-l5’ or ‘\textendash{}overwrite’)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sections}} \textendash{} (str) The config section to overwrite.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of all the overwrites to apply.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_config() (src.configManager.ConfigManager method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigManager.get_config}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_config}}}{\emph{application=None}, \emph{options=None}, \emph{command=None}, \emph{datadir=None}}{}
+get the config from all the configuration files.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{application}} \textendash{} (str) 
+The application for which salomeTools is called.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The general salomeTools options 
+(as ‘\textendash{}overwrite’ or ‘-v5’)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) The command that is called.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{datadir}} \textendash{} (str) 
+The repository that contain external data for salomeTools.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(Config) The final config.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_user\_config\_file() (src.configManager.ConfigManager method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigManager.get_user_config_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_user\_config\_file}}}{}{}
+Get the user config file
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str) path to the user config file.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_user\_config\_file() (src.configManager.ConfigManager method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigManager.set_user_config_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_user\_config\_file}}}{\emph{config}}{}
+Set the user config file name and path.
+If necessary, build it from another one or create it from scratch.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) 
+The global config (containing all pyconf).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigOpener (class in src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigOpener}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{ConfigOpener}}}{\emph{pathList}}{}
+Class that helps to find an application pyconf 
+in all the possible directories (pathList)
+\index{get\_path() (src.configManager.ConfigOpener method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.ConfigOpener.get_path}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_path}}}{\emph{name}}{}
+The method that returns the entire path of the pyconf searched
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{name}} \textendash{} (str) The name of the searched pyconf.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{check\_path() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.check_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{check\_path}}}{\emph{path}, \emph{ext={[}{]}}}{}
+Construct a text with the input path and “not found” if it does not exist.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{path}} \textendash{} (str) The path to check.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{ext}} \textendash{} (list) 
+An extension. Verify that the path extension is in the list
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The string of the path with information
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{getConfigColored() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.getConfigColored}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{getConfigColored}}}{\emph{config}, \emph{path}, \emph{stream}, \emph{show\_label=False}, \emph{level=0}, \emph{show\_full\_path=False}}{}
+Get a colored representation value from a config pyconf instance.
+used recursively from the initial path.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) 
+The configuration from which the value is displayed.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{path}} \textendash{} (str) The path in the configuration of the value to print.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{show\_label}} \textendash{} (bool) 
+If True, do a basic display. (useful for bash completion)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{stream}} \textendash{} The output stream used
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{level}} \textendash{} (int) The number of spaces to add before display.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{show\_full\_path}} \textendash{} (bool) Display full path, else relative
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_config\_children() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.get_config_children}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{get\_config\_children}}}{\emph{config}, \emph{args}}{}
+Gets the names of the children of the given parameter.
+Useful only for completion mechanism
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The configuration where to read the values
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{args}} \textendash{} The path in the config from which get the keys
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{self}, \emph{options}, \emph{cfg}, \emph{logger}}{}
+Gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The Options instance that stores the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{print\_debug() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.print_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{print\_debug}}}{\emph{config}, \emph{aPath}, \emph{logger}, \emph{show\_label=False}, \emph{level=0}, \emph{show\_full\_path=False}}{}
+logger output for debugging a config/pyconf
+lines contains: path : expression \textendash{}\textgreater{} ‘evaluation’
+
+example:
+PROJECTS.projects.salome.project\_path : \$PWD \textendash{}\textgreater{} ‘/tmp/SALOME’
+
+\end{fulllineitems}
+
+\index{print\_value() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.print_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{print\_value}}}{\emph{config}, \emph{path}, \emph{logger}, \emph{show\_label=False}, \emph{level=0}, \emph{show\_full\_path=False}}{}
+print a colored representation value from a config pyconf instance.
+used recursively from the initial path.
+\begin{quote}\begin{description}
+\item[{Param}] \leavevmode
+as getConfigColored
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{show\_patchs() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.show_patchs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{show\_patchs}}}{\emph{config}, \emph{logger}}{}
+Prints all the used patchs in the application.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) the global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{show\_product\_info() (in module src.configManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.configManager.show_product_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.configManager.}}\sphinxbfcode{\sphinxupquote{show\_product\_info}}}{\emph{config}, \emph{name}, \emph{logger}}{}
+Display on the terminal and logger information about a product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) the global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{name}} \textendash{} (str) The name of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use for the display
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.debug module}
+\label{\detokenize{apidoc_src/src:module-src.debug}}\label{\detokenize{apidoc_src/src:src-debug-module}}\index{src.debug (module)}
+This file assume DEBUG functionalities use
+Print salomeTools debug messages in sys.stderr.
+Show pretty print debug representation from instances of SAT classes 
+(pretty print src.pyconf.Config)
+
+WARNING: supposedly show messages in SAT development phase, not production
+
+usage:
+\textgreater{}\textgreater{} import debug as DBG
+\textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable)        \# not shown in production 
+\textgreater{}\textgreater{} DBG.write(“aTitle”, aVariable, True)  \# unconditionaly shown
+\index{InStream (class in src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.InStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{InStream}}}{\emph{buf=''}}{}
+Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
+
+utility class for pyconf.Config input iostream
+
+\end{fulllineitems}
+
+\index{OutStream (class in src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.OutStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{OutStream}}}{\emph{buf=''}}{}
+Bases: \sphinxcode{\sphinxupquote{StringIO.StringIO}}
+
+utility class for pyconf.Config output iostream
+\index{close() (src.debug.OutStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.OutStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+because Config.\_\_save\_\_ calls close() stream as file
+keep value before lost as self.value
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{format\_color\_exception() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.format_color_exception}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{format\_color\_exception}}}{\emph{msg}, \emph{limit=None}, \emph{trace=None}}{}
+Format a stack trace and the exception information.
+as traceback.format\_exception(), with color
+with traceback only if (\_debug) or (DBG.\_user in DBG.\_developpers)
+
+\end{fulllineitems}
+
+\index{getLocalEnv() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.getLocalEnv}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getLocalEnv}}}{}{}
+get string for environment variables representation
+
+\end{fulllineitems}
+
+\index{getStrConfigDbg() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.getStrConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigDbg}}}{\emph{config}}{}
+set string as saveConfigDbg, 
+as (path expression evaluation) for debug
+
+\end{fulllineitems}
+
+\index{getStrConfigStd() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.getStrConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{getStrConfigStd}}}{\emph{config}}{}
+set string as saveConfigStd, 
+as file .pyconf
+
+\end{fulllineitems}
+
+\index{indent() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=2}, \emph{ch=' '}}{}
+indent multi lines message
+
+\end{fulllineitems}
+
+\index{isTypeConfig() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.isTypeConfig}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{isTypeConfig}}}{\emph{var}}{}
+To know if var is instance from Config/pyconf
+
+\end{fulllineitems}
+
+\index{pop\_debug() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.pop_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{pop\_debug}}}{}{}
+restore previous debug outputs status
+
+\end{fulllineitems}
+
+\index{push\_debug() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.push_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{push\_debug}}}{\emph{aBool}}{}
+set debug outputs activated, or not
+
+\end{fulllineitems}
+
+\index{saveConfigDbg() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.saveConfigDbg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigDbg}}}{\emph{config}, \emph{aStream}, \emph{indent=0}, \emph{path=''}}{}
+pyconf returns multilines (path expression evaluation) for debug
+
+\end{fulllineitems}
+
+\index{saveConfigStd() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.saveConfigStd}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{saveConfigStd}}}{\emph{config}, \emph{aStream}}{}
+returns as file .pyconf
+
+\end{fulllineitems}
+
+\index{tofix() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.tofix}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{tofix}}}{\emph{title}, \emph{var=''}, \emph{force=None}}{}
+write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
+use this only if no logger accessible for classic logger.warning(message)
+
+\end{fulllineitems}
+
+\index{write() (in module src.debug)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.debug.write}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.debug.}}\sphinxbfcode{\sphinxupquote{write}}}{\emph{title}, \emph{var=''}, \emph{force=None}, \emph{fmt='\textbackslash{}n\#\#\#\# DEBUG: \%s:\textbackslash{}n\%s\textbackslash{}n'}}{}
+write sys.stderr a message if \_debug{[}-1{]}==True or optionaly force=True
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.environment module}
+\label{\detokenize{apidoc_src/src:src-environment-module}}\label{\detokenize{apidoc_src/src:module-src.environment}}\index{src.environment (module)}\index{Environ (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Environ}}}{\emph{environ=None}}{}
+Class to manage an environment context
+\index{append() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as append\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str or list) the value(s) to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string (usually ‘:’)
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string (usually ‘:’)
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command “command” 
+and put it in the environment variable key
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as prepend\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str or list) the value(s) to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string (usually ‘:’)
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string (usually ‘:’)
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.environment.Environ method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Environ.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{FileEnvWriter (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.FileEnvWriter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{FileEnvWriter}}}{\emph{config}, \emph{logger}, \emph{out\_dir}, \emph{src\_root}, \emph{env\_info=None}}{}
+Class to dump the environment to a file.
+\index{write\_cfgForPy\_file() (src.environment.FileEnvWriter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.FileEnvWriter.write_cfgForPy_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_cfgForPy\_file}}}{\emph{filename}, \emph{additional\_env=\{\}}, \emph{for\_package=None}, \emph{with\_commercial=True}}{}
+Append to current opened aFile a cfgForPy 
+environment (SALOME python launcher).
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{filename}} \textendash{} (str) the file path
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{additional\_env}} \textendash{} (dict) 
+a dictionary of additional variables to add to the environment
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{for\_package}} \textendash{} (str) 
+If not None, produce a relative environment 
+(designed for a package)
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_env\_file() (src.environment.FileEnvWriter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.FileEnvWriter.write_env_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_env\_file}}}{\emph{filename}, \emph{forBuild}, \emph{shell}, \emph{for\_package=None}}{}
+Create an environment file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{filename}} \textendash{} (str) the file path
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{forBuild}} \textendash{} (bool) if true, the build environment
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{shell}} \textendash{} (str) the type of file wanted (.sh, .bat)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The path to the generated file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{SalomeEnviron (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{SalomeEnviron}}}{\emph{cfg}, \emph{environ}, \emph{forBuild=False}, \emph{for\_package=None}, \emph{enable\_simple\_env\_script=True}}{}
+Class to manage the environment of SALOME.
+\index{add\_comment() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+Add a commentary to the out stream (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{comment}} \textendash{} (str) the commentary to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_line() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{nb\_line}}{}
+Add empty lines to the out stream (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{nb\_line}} \textendash{} (int) the number of empty lines to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning to the out stream (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{warning}} \textendash{} (str) the warning to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{dump() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.dump}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dump}}}{\emph{out}}{}
+Write the environment to out
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{out}} \textendash{} (file) the stream where to write the environment
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{required}} \textendash{} (bool) Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_names() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.get_names}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_names}}}{\emph{lProducts}}{}
+Get the products name to add in SALOME\_MODULES environment variable
+It is the name of the product, except in the case where the is a 
+component name. And it has to be in SALOME\_MODULES variable only 
+if the product has the property has\_salome\_hui = “yes”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{lProducts}} \textendash{} (list) List of products to potentially add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{load\_cfg\_environment() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.load_cfg_environment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load\_cfg\_environment}}}{\emph{cfg\_env}}{}
+Loads environment defined in cfg\_env
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{cfg\_env}} \textendash{} (Config) A config containing an environment
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_env\_script() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{product\_info}, \emph{logger=None}, \emph{native=False}}{}
+Runs an environment script.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) The product description
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{native}} \textendash{} (bool) If True load set\_native\_env instead of set\_env
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_simple\_env\_script() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.run_simple_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_simple\_env\_script}}}{\emph{script\_path}, \emph{logger=None}}{}~\begin{description}
+\item[{Runs an environment script. Same as run\_env\_script, but with a }] \leavevmode
+script path as parameter.
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{script\_path}} \textendash{} (str) A path to an environment script
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_a\_product() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_a_product}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_a\_product}}}{\emph{product}, \emph{logger}}{}
+Sets the environment of a product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product}} \textendash{} (str) The product name
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_application\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_application_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_application\_env}}}{\emph{logger}}{}
+Sets the environment defined in the APPLICATION file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_cpp\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_cpp_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_cpp\_env}}}{\emph{product\_info}}{}
+Sets the generic environment for a SALOME cpp product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) The product description
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_full\_environ() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_full_environ}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_full\_environ}}}{\emph{logger}, \emph{env\_info}}{}
+Sets the full environment for products 
+specified in env\_info dictionary.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{env\_info}} \textendash{} (list) the list of products
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_products() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_products}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_products}}}{\emph{logger}, \emph{src\_root=None}}{}
+Sets the environment for all the products.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{src\_root}} \textendash{} the application working directory
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_python\_libdirs() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_python_libdirs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_python\_libdirs}}}{}{}
+Set some generic variables for python library paths
+
+\end{fulllineitems}
+
+\index{set\_salome\_generic\_product\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_salome_generic_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_generic\_product\_env}}}{\emph{pi}}{}
+Sets the generic environment for a SALOME product.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{pi}} \textendash{} (Config) The product description
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_salome\_minimal\_product\_env() (src.environment.SalomeEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.SalomeEnviron.set_salome_minimal_product_env}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set\_salome\_minimal\_product\_env}}}{\emph{product\_info}, \emph{logger}}{}
+Sets the minimal environment for a SALOME product.
+xxx\_ROOT\_DIR and xxx\_SRC\_DIR
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) The product description
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Shell (class in src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.Shell}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{Shell}}}{\emph{name}, \emph{extension}}{}
+Definition of a Shell.
+
+\end{fulllineitems}
+
+\index{load\_environment() (in module src.environment)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environment.load_environment}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environment.}}\sphinxbfcode{\sphinxupquote{load\_environment}}}{\emph{config}, \emph{build}, \emph{logger}}{}
+Loads the environment (used to run the tests, for example).
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) the global config
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{build}} \textendash{} (bool) build environement if True
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to display messages
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.environs module}
+\label{\detokenize{apidoc_src/src:module-src.environs}}\label{\detokenize{apidoc_src/src:src-environs-module}}\index{src.environs (module)}
+Utility for print environment variables
+\begin{description}
+\item[{examples: }] \leavevmode\begin{itemize}
+\item {} 
+split all or specific environment variables \$XXX(s)…
+\textgreater{}\textgreater{} environs.py -\textgreater{} all
+\textgreater{}\textgreater{} environs.py SHELL PATH -\textgreater{} specific \$SHELL \$PATH
+
+\item {} 
+split all or specific environment variables on pattern \$*XXX*(s)…
+\textgreater{}\textgreater{} environs.py \textendash{}pat ROOT -\textgreater{} specific \$*ROOT*
+
+\item {} 
+split search specific substrings in contents of environment variables \$XXX(s)…
+\textgreater{}\textgreater{} environs.py \textendash{}grep usr  -\textgreater{} all specific environment variables containing usr
+
+\end{itemize}
+
+\item[{tips:}] \leavevmode\begin{itemize}
+\item {} 
+create unix alias as shortcut for bash console
+\textgreater{}\textgreater{} alias envs=”…/environs.py”
+
+\end{itemize}
+
+\end{description}
+\index{print\_grep\_environs() (in module src.environs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environs.print_grep_environs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environs.}}\sphinxbfcode{\sphinxupquote{print\_grep\_environs}}}{\emph{args={[}{]}}}{}
+\end{fulllineitems}
+
+\index{print\_split\_environs() (in module src.environs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environs.print_split_environs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environs.}}\sphinxbfcode{\sphinxupquote{print\_split\_environs}}}{\emph{args={[}{]}}}{}
+\end{fulllineitems}
+
+\index{print\_split\_pattern\_environs() (in module src.environs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.environs.print_split_pattern_environs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.environs.}}\sphinxbfcode{\sphinxupquote{print\_split\_pattern\_environs}}}{\emph{args={[}{]}}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{src.exceptionSat module}
+\label{\detokenize{apidoc_src/src:module-src.exceptionSat}}\label{\detokenize{apidoc_src/src:src-exceptionsat-module}}\index{src.exceptionSat (module)}\index{ExceptionSat}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.exceptionSat.ExceptionSat}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.exceptionSat.}}\sphinxbfcode{\sphinxupquote{ExceptionSat}}}
+Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
+
+rename Exception Class for sat convenience (for future…)
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.fileEnviron module}
+\label{\detokenize{apidoc_src/src:src-fileenviron-module}}\label{\detokenize{apidoc_src/src:module-src.fileEnviron}}\index{src.fileEnviron (module)}\index{BashFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BashFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BashFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}})
+
+Class for bash shell.
+\index{command\_value() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BashFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command “command” 
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BashFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{required}} \textendash{} (bool) Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.BashFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BashFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{BatFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BatFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{BatFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}})
+
+for Windows batch shell.
+\index{add\_comment() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BatFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+Add a comment in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{comment}} \textendash{} (str) the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BatFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command “command” 
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BatFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+In the particular windows case, do nothing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{required}} \textendash{} (bool) Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BatFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.BatFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.BatFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ContextFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ContextFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}})
+
+Class for a salome context configuration file.
+\index{add\_echo() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+Add a comment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the warning to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command “command” 
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{required}} \textendash{} (bool) Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.ContextFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ContextFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{FileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{FileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Base class for shell environment
+\index{add\_comment() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+Add a comment in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{comment}} \textendash{} (str) the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+Add a ‘echo’ in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the text to echo
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_line() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
+Add some empty lines in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{number}} \textendash{} (int) the number of lines to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning “echo” in the shell file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{warning}} \textendash{} (str) the text to echo
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as append\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str or list) the value(s) to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command “command” 
+and put it in the environment variable key.
+Has to be overwritten in the derived classes
+This can be seen as a virtual method
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{required}} \textendash{} (bool) Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as prepend\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str or list) the value(s) to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} str) the value to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.FileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{LauncherFileEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{LauncherFileEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Class to generate a launcher file script 
+(in python syntax) SalomeContext API
+\index{add() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add}}}{\emph{key}, \emph{value}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to prepend to key
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_comment() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+Add a comment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the comment to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_line() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
+Add some empty lines in the launcher file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{number}} \textendash{} (int) the number of lines to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+Add a warning
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the warning to add
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as append\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str or list) the value(s) to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_value() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.append_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+append value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to append
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to append to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{change\_to\_launcher() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.change_to_launcher}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{change\_to\_launcher}}}{\emph{value}}{}
+obsolete? do nothing
+
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+Get the value given by the system command “command” 
+and put it in the environment variable key.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) the command to execute
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{finish() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.finish}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{finish}}}{\emph{required=True}}{}
+Add a final instruction in the out file (in case of file generation)
+In the particular launcher case, do nothing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{required}} \textendash{} (bool) Do nothing if required is False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}}{}
+Get the value of the environment variable “key”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_defined() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{key}}{}
+Check if the key exists in the environment
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to check
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+Same as prepend\_value but the value argument can be a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str or list) the value(s) to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{prepend\_value() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.prepend_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend\_value}}}{\emph{key}, \emph{value}, \emph{sep=':'}}{}
+prepend value to key using sep
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to prepend
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to prepend to key
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sep}} \textendash{} (str) the separator string
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.LauncherFileEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.LauncherFileEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{key}, \emph{value}}{}
+Set the environment variable “key” to value “value”
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the environment variable to set
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ScreenEnviron (class in src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{ScreenEnviron}}}{\emph{output}, \emph{environ=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.fileEnviron.FileEnviron}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.fileEnviron.FileEnviron}})
+\index{add\_comment() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_comment}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_comment}}}{\emph{comment}}{}
+\end{fulllineitems}
+
+\index{add\_echo() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_echo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_echo}}}{\emph{text}}{}
+\end{fulllineitems}
+
+\index{add\_line() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_line}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_line}}}{\emph{number}}{}
+\end{fulllineitems}
+
+\index{add\_warning() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.add_warning}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_warning}}}{\emph{warning}}{}
+\end{fulllineitems}
+
+\index{append() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\end{fulllineitems}
+
+\index{command\_value() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.command_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{command\_value}}}{\emph{key}, \emph{command}}{}
+\end{fulllineitems}
+
+\index{get() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{name}}{}
+\end{fulllineitems}
+
+\index{is\_defined() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.is_defined}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_defined}}}{\emph{name}}{}
+\end{fulllineitems}
+
+\index{prepend() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.prepend}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepend}}}{\emph{name}, \emph{value}, \emph{sep=':'}}{}
+\end{fulllineitems}
+
+\index{run\_env\_script() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.run_env_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_env\_script}}}{\emph{module}, \emph{script}}{}
+\end{fulllineitems}
+
+\index{set() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.set}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{set}}}{\emph{name}, \emph{value}}{}
+\end{fulllineitems}
+
+\index{write() (src.fileEnviron.ScreenEnviron method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.ScreenEnviron.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{command}, \emph{name}, \emph{value}, \emph{sign='='}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_file\_environ() (in module src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.get_file_environ}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{get\_file\_environ}}}{\emph{output}, \emph{shell}, \emph{environ=None}}{}
+Instantiate correct FileEnvironment sub-class.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{output}} \textendash{} (file) the output file stream.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{shell}} \textendash{} (str) the type of shell syntax to use.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environ}} \textendash{} (dict) a potential additional environment.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{special\_path\_separator() (in module src.fileEnviron)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fileEnviron.special_path_separator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fileEnviron.}}\sphinxbfcode{\sphinxupquote{special\_path\_separator}}}{\emph{name}}{}
+TCLLIBPATH, TKLIBPATH, PV\_PLUGIN\_PATH environments variables 
+need some exotic path separator.
+This function gives the separator regarding the name of the variable
+to append or prepend.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{name}} \textendash{} (str) The name of the variable to find the separator
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.fork module}
+\label{\detokenize{apidoc_src/src:module-src.fork}}\label{\detokenize{apidoc_src/src:src-fork-module}}\index{src.fork (module)}\index{batch() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fork.batch}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}}{}
+Launch a batch
+
+\end{fulllineitems}
+
+\index{batch\_salome() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fork.batch_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{batch\_salome}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args}, \emph{getTmpDir}, \emph{pendant='SALOME\_Session\_Server'}, \emph{fin='killSalome.py'}, \emph{log=None}, \emph{delai=20}, \emph{sommeil=1}, \emph{delaiapp=0}}{}
+Launch a salome process
+
+\end{fulllineitems}
+
+\index{launch\_command() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fork.launch_command}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{launch\_command}}}{\emph{cmd}, \emph{logger}, \emph{cwd}, \emph{args={[}{]}}, \emph{log=None}}{}
+Launch command
+
+\end{fulllineitems}
+
+\index{show\_progress() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fork.show_progress}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{show\_progress}}}{\emph{logger}, \emph{top}, \emph{delai}, \emph{ss=''}}{}
+shortcut function to display the progression
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{top}} \textendash{} (int) the number to display
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{delai}} \textendash{} (int) the number max
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{ss}} \textendash{} (str) the string to display
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_back() (in module src.fork)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.fork.write_back}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.fork.}}\sphinxbfcode{\sphinxupquote{write\_back}}}{\emph{logger}, \emph{message}}{}
+shortcut function to write at the begin of the line
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{message}} \textendash{} (str) the text to display
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{level}} \textendash{} (int) the level of verbosity
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.loggingSat module}
+\label{\detokenize{apidoc_src/src:module-src.loggingSat}}\label{\detokenize{apidoc_src/src:src-loggingsat-module}}\index{src.loggingSat (module)}
+\sphinxurl{http://sametmax.com/ecrire-des-logs-en-python/}
+\sphinxurl{https://docs.python.org/3/library/time.html\#time.strftime}
+
+use logging package for salometools
+\begin{description}
+\item[{handler:}] \leavevmode
+on info() no format
+on other formatted indented on multi lines messages
+
+\end{description}
+\index{DefaultFormatter (class in src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.DefaultFormatter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{DefaultFormatter}}}{\emph{fmt=None}, \emph{datefmt=None}}{}
+Bases: \sphinxcode{\sphinxupquote{logging.Formatter}}
+\index{format() (src.loggingSat.DefaultFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.DefaultFormatter.format}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{format}}}{\emph{record}}{}
+Format the specified record as text.
+
+The record’s attribute dictionary is used as the operand to a
+string formatting operation which yields the returned string.
+Before formatting the dictionary, a couple of preparatory steps
+are carried out. The message attribute of the record is computed
+using LogRecord.getMessage(). If the formatting string uses the
+time (as determined by a call to usesTime(), formatTime() is
+called to format the event time. If there is exception information,
+it is formatted using formatException() and appended to the message.
+
+\end{fulllineitems}
+
+\index{setColorLevelname() (src.loggingSat.DefaultFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.DefaultFormatter.setColorLevelname}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setColorLevelname}}}{\emph{levelname}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{UnittestFormatter (class in src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestFormatter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{UnittestFormatter}}}{\emph{fmt=None}, \emph{datefmt=None}}{}
+Bases: \sphinxcode{\sphinxupquote{logging.Formatter}}
+\index{format() (src.loggingSat.UnittestFormatter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestFormatter.format}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{format}}}{\emph{record}}{}
+Format the specified record as text.
+
+The record’s attribute dictionary is used as the operand to a
+string formatting operation which yields the returned string.
+Before formatting the dictionary, a couple of preparatory steps
+are carried out. The message attribute of the record is computed
+using LogRecord.getMessage(). If the formatting string uses the
+time (as determined by a call to usesTime(), formatTime() is
+called to format the event time. If there is exception information,
+it is formatted using formatException() and appended to the message.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{UnittestStream (class in src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestStream}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{UnittestStream}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+write my stream class
+only write and flush are used for the streaming
+\sphinxurl{https://docs.python.org/2/library/logging.handlers.html}
+\sphinxurl{https://stackoverflow.com/questions/31999627/storing-logger-messages-in-a-string}
+\index{flush() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
+\end{fulllineitems}
+
+\index{getLogs() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestStream.getLogs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getLogs}}}{}{}
+\end{fulllineitems}
+
+\index{getLogsAndClear() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestStream.getLogsAndClear}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getLogsAndClear}}}{}{}
+\end{fulllineitems}
+
+\index{write() (src.loggingSat.UnittestStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.UnittestStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{astr}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{dirLogger() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.dirLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{dirLogger}}}{\emph{logger}}{}
+\end{fulllineitems}
+
+\index{getDefaultLogger() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.getDefaultLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{getDefaultLogger}}}{}{}
+\end{fulllineitems}
+
+\index{getUnittestLogger() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.getUnittestLogger}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{getUnittestLogger}}}{}{}
+\end{fulllineitems}
+
+\index{indent() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.indent}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{indent}}}{\emph{msg}, \emph{nb}, \emph{car=' '}}{}
+indent nb car (spaces) multi lines message except first one
+
+\end{fulllineitems}
+
+\index{indentUnittest() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.indentUnittest}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{indentUnittest}}}{\emph{msg}, \emph{prefix=' \textbar{} '}}{}
+indent car multi lines message except first one
+car default is less spaces for size logs files
+keep human readable
+
+\end{fulllineitems}
+
+\index{initLoggerAsDefault() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.initLoggerAsDefault}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{initLoggerAsDefault}}}{\emph{logger}, \emph{fmt=None}, \emph{level=None}}{}
+init logger as prefixed message and indented message if multi line
+exept info() outed ‘as it’ without any format
+
+\end{fulllineitems}
+
+\index{initLoggerAsUnittest() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.initLoggerAsUnittest}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{initLoggerAsUnittest}}}{\emph{logger}, \emph{fmt=None}, \emph{level=None}}{}
+init logger as silent on stdout/stderr
+used for retrieve messages in memory for post execution unittest
+\sphinxurl{https://docs.python.org/2/library/logging.handlers.html}
+
+\end{fulllineitems}
+
+\index{log() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{log}}}{\emph{msg}}{}
+elementary log when no logger yet
+
+\end{fulllineitems}
+
+\index{testLogger\_1() (in module src.loggingSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.loggingSat.testLogger_1}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.loggingSat.}}\sphinxbfcode{\sphinxupquote{testLogger\_1}}}{\emph{logger}}{}
+small test
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.options module}
+\label{\detokenize{apidoc_src/src:module-src.options}}\label{\detokenize{apidoc_src/src:src-options-module}}\index{src.options (module)}
+The Options class that manages the access to all options passed as 
+parameters in salomeTools command lines
+\index{OptResult (class in src.options)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.OptResult}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{OptResult}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+An instance of this class will be the object manipulated
+in code of all salomeTools commands
+The aim of this class is to have an elegant syntax to manipulate the options.
+
+example: 
+\textgreater{}\textgreater{} print(options.level)
+\textgreater{}\textgreater{} 5
+
+\end{fulllineitems}
+
+\index{Options (class in src.options)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.options.}}\sphinxbfcode{\sphinxupquote{Options}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage all salomeTools options
+\index{add\_option() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options.add_option}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_option}}}{\emph{shortName}, \emph{longName}, \emph{optionType}, \emph{destName}, \emph{helpString=''}, \emph{default=None}}{}
+Add an option to a command. It gets all attributes
+of an option and append it in the options field
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{shortName}} \textendash{} (str) 
+The short name of the option (as ‘-l’ for level option).
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{longName}} \textendash{} (str) 
+The long name of the option (as ‘\textendash{}level’ for level option).
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{optionType}} \textendash{} (str) The type of the option (ex “int”).
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{destName}} \textendash{} (str) The name that will be used in the code.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{helpString}} \textendash{} (str) 
+The text to display when user ask for help on a command.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{debug\_write() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options.debug_write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{debug\_write}}}{}{}
+\end{fulllineitems}
+
+\index{getDetailOption() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options.getDetailOption}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getDetailOption}}}{\emph{option}}{}
+for convenience
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(tuple) 4-elements (shortName, longName, optionType, helpString)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_help() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options.get_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_help}}}{}{}
+Returns all options stored in self.options 
+as help message colored string
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str) colored string
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{indent() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options.indent}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount}, \emph{car=' '}}{}
+indent multi lines message
+
+\end{fulllineitems}
+
+\index{parse\_args() (src.options.Options method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.options.Options.parse_args}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_args}}}{\emph{argList=None}}{}
+Instantiates the class OptResult 
+that gives access to all options in the code
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{argList}} \textendash{} (list) the raw list of arguments that were passed
+
+\item[{Returns}] \leavevmode
+(OptResult, list) as (optResult, args) 
+optResult is the option instance to manipulate in the code. 
+args is the full raw list of passed options
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.product module}
+\label{\detokenize{apidoc_src/src:module-src.product}}\label{\detokenize{apidoc_src/src:src-product-module}}\index{src.product (module)}
+Contains the methods 
+relative to the product notion of salomeTools
+\index{check\_config\_exists() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.check_config_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_config\_exists}}}{\emph{config}, \emph{prod\_dir}, \emph{prod\_info}}{}
+Verify that the installation directory of a product in a base exists
+Check all the config-\textless{}i\textgreater{} directory and verify the sat-config.pyconf file
+that is in it
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prod\_dir}} \textendash{} (str) 
+The product installation directory path 
+(without config-\textless{}i\textgreater{})
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(tuple) as (boolean, str)
+True or false is the installation is found or not 
+and if it is found, the path of the found installation
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_installation() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.check_installation}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{check\_installation}}}{\emph{product\_info}}{}
+Verify if a product is well installed. 
+Checks install directory presence
+and some additional files if it is defined in the config
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) True if it is well installed
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_base\_install\_dir() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_base_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_base\_install\_dir}}}{\emph{config}, \emph{prod\_info}, \emph{version}}{}
+Compute the installation directory of a product in base
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{version}} \textendash{} (str) The version of the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The path of the product installation
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_install\_dir() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_install_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_install\_dir}}}{\emph{config}, \emph{base}, \emph{version}, \emph{prod\_info}}{}
+Compute the installation directory of a given product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{base}} \textendash{} (str) 
+This corresponds to the value given by user in its application.pyconf 
+for the specific product. 
+If “yes”, the user wants the product to be in base. 
+If “no”, he wants the product to be in the application workdir
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{version}} \textendash{} (str) The version of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) The configuration specific to the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The path of the product installation
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_components() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_product_components}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_components}}}{\emph{product\_info}}{}
+Get the component list to generate with the product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(list) The list of names of the components
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_config() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_product_config}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_config}}}{\emph{config}, \emph{product\_name}, \emph{with\_install\_dir=True}}{}
+Get the specific configuration of a product 
+from the global configuration
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_name}} \textendash{} (str) The name of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{with\_install\_dir}} \textendash{} (boolean)
+If false, do not provide an install directory 
+(at false only for internal use of the function check\_config\_exists)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(Config) The specific configuration of the product
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_dependencies() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_product_dependencies}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_dependencies}}}{\emph{config}, \emph{product\_info}}{}
+Get recursively the list of products that are 
+in the product\_info dependencies
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) the list of products in dependence
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_section() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_product_section}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_product\_section}}}{\emph{config}, \emph{product\_name}, \emph{version}, \emph{section=None}}{}
+Get the product description from the configuration
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_name}} \textendash{} (str) The product name
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{version}} \textendash{} (str) The version of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{section}} \textendash{} (str) 
+The searched section
+(if not None, the section is explicitly given)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(Config) The product description
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_products\_infos() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.get_products_infos}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{get\_products\_infos}}}{\emph{products}, \emph{config}}{}
+Get the specific configuration of a list of products
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products}} \textendash{} (list) The list of product names
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) of tuples (str, Config)
+as (product name, specific configuration of the product)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_compiles() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_compiles}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_compiles}}}{\emph{product\_info}}{}~\begin{description}
+\item[{Know if a product compiles or not (some products do not have a }] \leavevmode
+compilation procedure)
+
+\end{description}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product compiles, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_env\_script() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_has_env_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_env\_script}}}{\emph{product\_info}}{}
+Know if a product has an environment script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product it has an environment script, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_logo() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_has_logo}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_logo}}}{\emph{product\_info}}{}
+Know if a product has a logo (YACSGEN generate)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(str) 
+The path of the logo if the product has a logo, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_patches() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_has_patches}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_patches}}}{\emph{product\_info}}{}
+Know if a product has one or more patches
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product has one or more patches
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_salome\_gui() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_has_salome_gui}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_salome\_gui}}}{\emph{product\_info}}{}
+Know if a product has a SALOME gui
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product has a SALOME gui, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_script() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_has_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_has\_script}}}{\emph{product\_info}}{}
+Know if a product has a compilation script
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product it has a compilation script, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_SALOME() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_SALOME}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_SALOME}}}{\emph{product\_info}}{}
+Know if a product is a SALOME module
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is a SALOME module, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_autotools() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_autotools}}}{\emph{product\_info}}{}
+Know if a product is compiled using the autotools
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is autotools, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_cmake() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_cmake}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cmake}}}{\emph{product\_info}}{}
+Know if a product is compiled using the cmake
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is cmake, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_cpp() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_cpp}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_cpp}}}{\emph{product\_info}}{}
+Know if a product is cpp
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is a cpp, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_debug() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_debug}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_debug}}}{\emph{product\_info}}{}
+Know if a product is in debug mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is in debug mode, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_dev() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_dev}}}{\emph{product\_info}}{}
+Know if a product is in dev mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is in dev mode, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_fixed() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_fixed}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_fixed}}}{\emph{product\_info}}{}
+Know if a product is fixed
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is fixed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_generated() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_generated}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_generated}}}{\emph{product\_info}}{}
+Know if a product is generated (YACSGEN)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) True if the product is generated
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_mpi() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_mpi}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_mpi}}}{\emph{product\_info}}{}
+Know if a product has openmpi in its dependencies
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product has openmpi inits dependencies
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_native() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_native}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_native}}}{\emph{product\_info}}{}
+Know if a product is native
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is native, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_salome() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_salome}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_salome}}}{\emph{product\_info}}{}
+Know if a product is of type salome
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product is salome, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_sample() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_sample}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_sample}}}{\emph{product\_info}}{}
+Know if a product has the sample type
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the product has the sample type, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_smesh\_plugin() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_smesh_plugin}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_smesh\_plugin}}}{\emph{product\_info}}{}
+Know if a product is a SMESH plugin
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool)
+True if the product is a SMESH plugin, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_is\_vcs() (in module src.product)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.product.product_is_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.product.}}\sphinxbfcode{\sphinxupquote{product\_is\_vcs}}}{\emph{product\_info}}{}
+Know if a product is download using git, svn or cvs (not archive)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product
+
+\item[{Returns}] \leavevmode
+(bool)
+True if the product is vcs, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.pyconf module}
+\label{\detokenize{apidoc_src/src:src-pyconf-module}}\label{\detokenize{apidoc_src/src:module-src.pyconf}}\index{src.pyconf (module)}
+This is a configuration module for Python.
+
+This module should work under Python versions \textgreater{}= 2.2, and cannot be used with
+earlier versions since it uses new-style classes.
+
+Development and testing has only been carried out (so far) on Python 2.3.4 and
+Python 2.4.2. See the test module (test\_config.py) included in the
+U\{distribution\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} (follow the
+download link).
+
+A simple example - with the example configuration file:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+messages:
+[
+  \PYGZob{}
+    stream : {}`sys.stderr{}`
+    message: \PYGZsq{}Welcome\PYGZsq{}
+    name: \PYGZsq{}Harry\PYGZsq{}
+  \PYGZcb{}
+  \PYGZob{}
+    stream : {}`sys.stdout{}`
+    message: \PYGZsq{}Welkom\PYGZsq{}
+    name: \PYGZsq{}Ruud\PYGZsq{}
+  \PYGZcb{}
+  \PYGZob{}
+    stream : \PYGZdl{}messages[0].stream
+    message: \PYGZsq{}Bienvenue\PYGZsq{}
+    name: Yves
+  \PYGZcb{}
+]
+\end{sphinxVerbatim}
+
+a program to read the configuration would be:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{k+kn}{from} \PYG{n+nn}{config} \PYG{k}{import} \PYG{n}{Config}
+
+\PYG{n}{f} \PYG{o}{=} \PYG{n}{file}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{simple.cfg}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}
+\PYG{n}{cfg} \PYG{o}{=} \PYG{n}{Config}\PYG{p}{(}\PYG{n}{f}\PYG{p}{)}
+\PYG{k}{for} \PYG{n}{m} \PYG{o+ow}{in} \PYG{n}{cfg}\PYG{o}{.}\PYG{n}{messages}\PYG{p}{:}
+    \PYG{n}{s} \PYG{o}{=} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{, }\PYG{l+s+si}{\PYGZpc{}s}\PYG{l+s+s1}{\PYGZsq{}} \PYG{o}{\PYGZpc{}} \PYG{p}{(}\PYG{n}{m}\PYG{o}{.}\PYG{n}{message}\PYG{p}{,} \PYG{n}{m}\PYG{o}{.}\PYG{n}{name}\PYG{p}{)}
+    \PYG{k}{try}\PYG{p}{:}
+        \PYG{n+nb}{print} \PYG{o}{\PYGZgt{}\PYGZgt{}} \PYG{n}{m}\PYG{o}{.}\PYG{n}{stream}\PYG{p}{,} \PYG{n}{s}
+    \PYG{k}{except} \PYG{n+ne}{IOError}\PYG{p}{,} \PYG{n}{e}\PYG{p}{:}
+        \PYG{n+nb}{print} \PYG{n}{e}
+\end{sphinxVerbatim}
+
+which, when run, would yield the console output:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{Welcome}\PYG{p}{,} \PYG{n}{Harry}
+\PYG{n}{Welkom}\PYG{p}{,} \PYG{n}{Ruud}
+\PYG{n}{Bienvenue}\PYG{p}{,} \PYG{n}{Yves}
+\end{sphinxVerbatim}
+
+See U\{this tutorial\textless{}\sphinxurl{http://www.red-dove.com/python\_config}.html\textbar{}\_blank\textgreater{}\} for more
+information.
+
+\#modified for salomeTools
+@version: 0.3.7.1
+
+@author: Vinay Sajip
+
+@copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.
+
+@var streamOpener: The default stream opener. This is a factory function which
+takes a string (e.g. filename) and returns a stream suitable for reading. If
+unable to open the stream, an IOError exception should be thrown.
+
+The default value of this variable is L\{defaultStreamOpener\}. For an example
+of how it’s used, see test\_config.py (search for streamOpener).
+\index{Config (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Config}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Config}}}{\emph{streamOrFile=None}, \emph{parent=None}, \emph{PWD=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.Mapping}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Mapping}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.Mapping}})
+
+This class represents a configuration, and is the only one which clients
+need to interface to, under normal circumstances.
+\index{Config.Namespace (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Config.Namespace}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{Namespace}}}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This internal class is used for implementing default namespaces.
+
+An instance acts as a namespace.
+
+\end{fulllineitems}
+
+\index{addNamespace() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Config.addNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addNamespace}}}{\emph{ns}, \emph{name=None}}{}
+Add a namespace to this configuration which can be used to evaluate
+(resolve) dotted-identifier expressions.
+@param ns: The namespace to be added.
+@type ns: A module or other namespace suitable for passing as an
+argument to vars().
+@param name: A name for the namespace, which, if specified, provides
+an additional level of indirection.
+@type name: str
+
+\end{fulllineitems}
+
+\index{getByPath() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Config.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
+Obtain a value in the configuration via its path.
+@param path: The path of the required value
+@type path: str
+@return the value at the specified path.
+@rtype: any
+@raise ConfigError: If the path is invalid
+
+\end{fulllineitems}
+
+\index{load() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Config.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}}{}
+Load the configuration from the specified stream. Multiple streams can
+be used to populate the same instance, as long as there are no
+clashing keys. The stream is closed.
+@param stream: A stream from which the configuration is read.
+@type stream: A read-only stream (file-like object).
+@raise ConfigError: if keys in the loaded configuration clash with
+existing keys.
+@raise ConfigFormatError: if there is a syntax error in the stream.
+
+\end{fulllineitems}
+
+\index{removeNamespace() (src.pyconf.Config method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Config.removeNamespace}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{removeNamespace}}}{\emph{ns}, \emph{name=None}}{}
+Remove a namespace added with L\{addNamespace\}.
+@param ns: The namespace to be removed.
+@param name: The name which was specified when L\{addNamespace\} was
+called.
+@type name: str
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigError}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigError}}}
+Bases: \sphinxcode{\sphinxupquote{exceptions.Exception}}
+
+This is the base class of exceptions raised by this module.
+
+\end{fulllineitems}
+
+\index{ConfigFormatError}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigFormatError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigFormatError}}}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.ConfigError}})
+
+This is the base class of exceptions raised due to syntax errors in
+configurations.
+
+\end{fulllineitems}
+
+\index{ConfigInputStream (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigInputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigInputStream}}}{\emph{stream}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+An input stream which can read either ANSI files with default encoding
+or Unicode files with BOMs.
+
+Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.
+\index{close() (src.pyconf.ConfigInputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigInputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\end{fulllineitems}
+
+\index{read() (src.pyconf.ConfigInputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigInputStream.read}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read}}}{\emph{size}}{}
+\end{fulllineitems}
+
+\index{readline() (src.pyconf.ConfigInputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigInputStream.readline}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readline}}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigList (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigList}}\pysigline{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigList}}}
+Bases: \sphinxcode{\sphinxupquote{list}}
+
+This class implements an ordered list of configurations and allows you
+to try getting the configuration from each entry in turn, returning
+the first successfully obtained value.
+\index{getByPath() (src.pyconf.ConfigList method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigList.getByPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getByPath}}}{\emph{path}}{}
+Obtain a value from the first configuration in the list which defines
+it.
+
+@param path: The path of the value to retrieve.
+@type path: str
+@return: The value from the earliest configuration in the list which
+defines it.
+@rtype: any
+@raise ConfigError: If no configuration in the list has an entry with
+the specified path.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigMerger (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigMerger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigMerger}}}{\emph{resolver=\textless{}function defaultMergeResolve at 0x3561c80\textgreater{}}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This class is used for merging two configurations. If a key exists in the
+merge operand but not the merge target, then the entry is copied from the
+merge operand to the merge target. If a key exists in both configurations,
+then a resolver (a callable) is called to decide how to handle the
+conflict.
+\index{handleMismatch() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigMerger.handleMismatch}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{handleMismatch}}}{\emph{obj1}, \emph{obj2}}{}
+Handle a mismatch between two objects.
+
+@param obj1: The object to merge into.
+@type obj1: any
+@param obj2: The object to merge.
+@type obj2: any
+
+\end{fulllineitems}
+
+\index{merge() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigMerger.merge}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{merge}}}{\emph{merged}, \emph{mergee}}{}
+Merge two configurations. The second configuration is unchanged,
+and the first is changed to reflect the results of the merge.
+
+@param merged: The configuration to merge into.
+@type merged: L\{Config\}.
+@param mergee: The configuration to merge.
+@type mergee: L\{Config\}.
+
+\end{fulllineitems}
+
+\index{mergeMapping() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigMerger.mergeMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeMapping}}}{\emph{map1}, \emph{map2}}{}
+Merge two mappings recursively. The second mapping is unchanged,
+and the first is changed to reflect the results of the merge.
+
+@param map1: The mapping to merge into.
+@type map1: L\{Mapping\}.
+@param map2: The mapping to merge.
+@type map2: L\{Mapping\}.
+
+\end{fulllineitems}
+
+\index{mergeSequence() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigMerger.mergeSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mergeSequence}}}{\emph{seq1}, \emph{seq2}}{}
+Merge two sequences. The second sequence is unchanged,
+and the first is changed to have the elements of the second
+appended to it.
+
+@param seq1: The sequence to merge into.
+@type seq1: L\{Sequence\}.
+@param seq2: The sequence to merge.
+@type seq2: L\{Sequence\}.
+
+\end{fulllineitems}
+
+\index{overwriteKeys() (src.pyconf.ConfigMerger method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigMerger.overwriteKeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overwriteKeys}}}{\emph{map1}, \emph{seq2}}{}
+Renint variables. The second mapping is unchanged,
+and the first is changed depending the keys of the second mapping.
+@param map1: The mapping to reinit keys into.
+@type map1: L\{Mapping\}.
+@param map2: The mapping container reinit information.
+@type map2: L\{Mapping\}.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigOutputStream (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigOutputStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigOutputStream}}}{\emph{stream}, \emph{encoding=None}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+An output stream which can write either ANSI files with default encoding
+or Unicode files with BOMs.
+
+Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
+built-in support.
+\index{close() (src.pyconf.ConfigOutputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigOutputStream.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+\end{fulllineitems}
+
+\index{flush() (src.pyconf.ConfigOutputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigOutputStream.flush}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{flush}}}{}{}
+\end{fulllineitems}
+
+\index{write() (src.pyconf.ConfigOutputStream method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigOutputStream.write}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write}}}{\emph{data}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigReader (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigReader}}}{\emph{config}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This internal class implements a parser for configurations.
+\index{getChar() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.getChar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getChar}}}{}{}
+Get the next char from the stream. Update line and column numbers
+appropriately.
+
+@return: The next character from the stream.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{getToken() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.getToken}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getToken}}}{}{}
+Get a token from the stream. String values are returned in a form
+where you need to eval() the returned value to get the actual
+string. The return value is (token\_type, token\_value).
+
+Multiline string tokenizing is thanks to David Janes (BlogMatrix)
+
+@return: The next token.
+@rtype: A token tuple.
+
+\end{fulllineitems}
+
+\index{load() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.load}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{load}}}{\emph{stream}, \emph{parent=None}, \emph{suffix=None}}{}
+Load the configuration from the specified stream.
+
+@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
+@param parent: The parent of the configuration (to which this reader
+belongs) in the hierarchy. Specified when the configuration is
+included in another one.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix of this configuration in the parent
+configuration. Should be specified whenever the parent is not None.
+@raise ConfigError: If parent is specified but suffix is not.
+@raise ConfigFormatError: If there are syntax errors in the stream.
+
+\end{fulllineitems}
+
+\index{location() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.location}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{location}}}{}{}
+Return the current location (filename, line, column) in the stream
+as a string.
+
+Used when printing error messages,
+
+@return: A string representing a location in the stream being read.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{match() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.match}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{match}}}{\emph{t}}{}
+Ensure that the current token type matches the specified value, and
+advance to the next token.
+
+@param t: The token type to match.
+@type t: A valid token type.
+@return: The token which was last read from the stream before this
+function is called.
+@rtype: a token tuple - see L\{getToken\}.
+@raise ConfigFormatError: If the token does not match what’s expected.
+
+\end{fulllineitems}
+
+\index{parseFactor() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseFactor}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseFactor}}}{}{}
+Parse a factor in an multiplicative expression (a * b, a / b, a \% b)
+
+@return: the parsed factor
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseKeyValuePair() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseKeyValuePair}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseKeyValuePair}}}{\emph{parent}}{}
+Parse a key-value pair, and add it to the provided L\{Mapping\}.
+
+@param parent: The mapping to add entries to.
+@type parent: A L\{Mapping\} instance.
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseMapping() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
+Parse a mapping.
+
+@param parent: The container to which the mapping will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L\{Mapping\} instance representing the mapping.
+@rtype: L\{Mapping\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseMappingBody() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseMappingBody}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMappingBody}}}{\emph{parent}}{}
+Parse the internals of a mapping, and add entries to the provided
+L\{Mapping\}.
+
+@param parent: The mapping to add entries to.
+@type parent: A L\{Mapping\} instance.
+
+\end{fulllineitems}
+
+\index{parseReference() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseReference}}}{\emph{type}}{}
+Parse a reference.
+
+@return: the parsed reference
+@rtype: L\{Reference\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseScalar() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseScalar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseScalar}}}{}{}
+Parse a scalar - a terminal value such as a string or number, or
+an L\{Expression\} or L\{Reference\}.
+
+@return: the parsed scalar
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseSequence() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseSequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSequence}}}{\emph{parent}, \emph{suffix}}{}
+Parse a sequence.
+
+@param parent: The container to which the sequence will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L\{Sequence\} instance representing the sequence.
+@rtype: L\{Sequence\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseSuffix() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseSuffix}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseSuffix}}}{\emph{ref}}{}
+Parse a reference suffix.
+
+@param ref: The reference of which this suffix is a part.
+@type ref: L\{Reference\}.
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseTerm() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseTerm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseTerm}}}{}{}
+Parse a term in an additive expression (a + b, a - b)
+
+@return: the parsed term
+@rtype: any scalar
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{parseValue() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.parseValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseValue}}}{\emph{parent}, \emph{suffix}}{}
+Parse a value.
+
+@param parent: The container to which the value will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: The value
+@rtype: any
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+\index{setStream() (src.pyconf.ConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigReader.setStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStream}}}{\emph{stream}}{}
+Set the stream to the specified value, and prepare to read from it.
+
+@param stream: A stream from which to load the configuration.
+@type stream: A stream (file-like object).
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ConfigResolutionError}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.ConfigResolutionError}}\pysigline{\sphinxbfcode{\sphinxupquote{exception }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{ConfigResolutionError}}}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.ConfigError}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigError}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.ConfigError}})
+
+This is the base class of exceptions raised due to semantic errors in
+configurations.
+
+\end{fulllineitems}
+
+\index{Container (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Container}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Container}}}{\emph{parent}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This internal class is the base class for mappings and sequences.
+
+@ivar path: A string which describes how to get
+to this instance from the root of the hierarchy.
+
+Example:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{a}\PYG{o}{.}\PYG{n}{list}\PYG{o}{.}\PYG{n}{of}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{o}{.}\PYG{o+ow}{or}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{more}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{o}{.}\PYG{n}{elements}
+\end{sphinxVerbatim}
+\index{evaluate() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Container.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{item}}{}
+Evaluate items which are instances of L\{Reference\} or L\{Expression\}.
+
+L\{Reference\} instances are evaluated using L\{Reference.resolve\},
+and L\{Expression\} instances are evaluated using
+L\{Expression.evaluate\}.
+
+@param item: The item to be evaluated.
+@type item: any
+@return: If the item is an instance of L\{Reference\} or L\{Expression\},
+the evaluated value is returned, otherwise the item is returned
+unchanged.
+
+\end{fulllineitems}
+
+\index{setPath() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Container.setPath}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setPath}}}{\emph{path}}{}
+Set the path for this instance.
+@param path: The path - a string which describes how to get
+to this instance from the root of the hierarchy.
+@type path: str
+
+\end{fulllineitems}
+
+\index{writeToStream() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Container.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
+
+Should be redefined in subclasses.
+
+@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L\{Container\}
+@raise NotImplementedError: If a subclass does not override this
+
+\end{fulllineitems}
+
+\index{writeValue() (src.pyconf.Container method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Container.writeValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeValue}}}{\emph{value}, \emph{stream}, \emph{indent}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Expression (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Expression}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Expression}}}{\emph{op}, \emph{lhs}, \emph{rhs}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This internal class implements a value which is obtained by evaluating an expression.
+\index{evaluate() (src.pyconf.Expression method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Expression.evaluate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{evaluate}}}{\emph{container}}{}
+Evaluate this instance in the context of a container.
+
+@param container: The container to evaluate in from.
+@type container: L\{Container\}
+@return: The evaluated value.
+@rtype: any
+@raise ConfigResolutionError: If evaluation fails.
+@raise ZeroDivideError: If division by zero occurs.
+@raise TypeError: If the operation is invalid, e.g.
+subtracting one string from another.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Mapping (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Mapping}}}{\emph{parent=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.Container}})
+
+This internal class implements key-value mappings in configurations.
+\index{addMapping() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping.addMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addMapping}}}{\emph{key}, \emph{value}, \emph{comment}, \emph{setting=False}}{}
+Add a key-value mapping with a comment.
+
+@param key: The key for the mapping.
+@type key: str
+@param value: The value for the mapping.
+@type value: any
+@param comment: The comment for the key (can be None).
+@type comment: str
+@param setting: If True, ignore clashes. This is set
+to true when called from L\{\_\_setattr\_\_\}.
+@raise ConfigFormatError: If an existing key is seen
+again and setting is False.
+
+\end{fulllineitems}
+
+\index{get() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping.get}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get}}}{\emph{key}, \emph{default=None}}{}
+Allows a dictionary-style get operation.
+
+\end{fulllineitems}
+
+\index{iteritems() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping.iteritems}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iteritems}}}{}{}
+\end{fulllineitems}
+
+\index{iterkeys() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping.iterkeys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{iterkeys}}}{}{}
+\end{fulllineitems}
+
+\index{keys() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping.keys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{keys}}}{}{}
+Return the keys in a similar way to a dictionary.
+
+\end{fulllineitems}
+
+\index{writeToStream() (src.pyconf.Mapping method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Mapping.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
+
+Should be redefined in subclasses.
+
+@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L\{Container\}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Reference (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Reference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Reference}}}{\emph{config}, \emph{type}, \emph{ident}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This internal class implements a value which is a reference to another value.
+\index{addElement() (src.pyconf.Reference method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Reference.addElement}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{addElement}}}{\emph{type}, \emph{ident}}{}
+Add an element to the reference.
+
+@param type: The type of reference.
+@type type: BACKTICK or DOLLAR
+@param ident: The identifier which continues the reference.
+@type ident: str
+
+\end{fulllineitems}
+
+\index{findConfig() (src.pyconf.Reference method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Reference.findConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{findConfig}}}{\emph{container}}{}
+Find the closest enclosing configuration to the specified container.
+
+@param container: The container to start from.
+@type container: L\{Container\}
+@return: The closest enclosing configuration, or None.
+@rtype: L\{Config\}
+
+\end{fulllineitems}
+
+\index{resolve() (src.pyconf.Reference method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Reference.resolve}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{resolve}}}{\emph{container}}{}
+Resolve this instance in the context of a container.
+
+@param container: The container to resolve from.
+@type container: L\{Container\}
+@return: The resolved value.
+@rtype: any
+@raise ConfigResolutionError: If resolution fails.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Sequence (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Sequence}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{Sequence}}}{\emph{parent=None}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.Container}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Container}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.Container}})
+
+This internal class implements a value which is a sequence of other values.
+\index{Sequence.SeqIter (class in src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Sequence.SeqIter}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxbfcode{\sphinxupquote{SeqIter}}}{\emph{seq}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+This internal class implements an iterator for a L\{Sequence\} instance.
+\index{next() (src.pyconf.Sequence.SeqIter method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Sequence.SeqIter.next}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{next}}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{append() (src.pyconf.Sequence method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Sequence.append}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append}}}{\emph{item}, \emph{comment}}{}
+Add an item to the sequence.
+
+@param item: The item to add.
+@type item: any
+@param comment: A comment for the item.
+@type comment: str
+
+\end{fulllineitems}
+
+\index{writeToStream() (src.pyconf.Sequence method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.Sequence.writeToStream}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{writeToStream}}}{\emph{stream}, \emph{indent}, \emph{container}}{}
+Write this instance to a stream at the specified indentation level.
+
+Should be redefined in subclasses.
+
+@param stream: The stream to write to
+@type stream: A writable stream (file-like object)
+@param indent: The indentation level
+@type indent: int
+@param container: The container of this instance
+@type container: L\{Container\}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{deepCopyMapping() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.deepCopyMapping}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{deepCopyMapping}}}{\emph{inMapping}}{}
+\end{fulllineitems}
+
+\index{defaultMergeResolve() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.defaultMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
+A default resolver for merge conflicts. 
+Returns a string indicating what action to take to resolve the conflict.
+
+@param map1: The map being merged into.
+@type map1: L\{Mapping\}.
+@param map2: The map being used as the merge operand.
+@type map2: L\{Mapping\}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str
+@return: One of “merge”, “append”, “mismatch” or “overwrite” 
+indicating what action should be taken. This should
+be appropriate to the objects being merged - e.g.
+there is no point returning “merge” if the two objects
+are instances of L\{Sequence\}.
+@rtype: str
+
+\end{fulllineitems}
+
+\index{defaultStreamOpener() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.defaultStreamOpener}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{defaultStreamOpener}}}{\emph{name}}{}
+This function returns a read-only stream, given its name. The name passed
+in should correspond to an existing stream, otherwise an exception will be
+raised.
+
+This is the default value of L\{streamOpener\}; assign your own callable to
+streamOpener to return streams based on names. For example, you could use
+urllib2.urlopen().
+
+@param name: The name of a stream, most commonly a file name.
+@type name: str
+@return: A stream with the specified name.
+@rtype: A read-only stream (file-like object)
+
+\end{fulllineitems}
+
+\index{isWord() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.isWord}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{isWord}}}{\emph{s}}{}
+See if a passed-in value is an identifier. If the value passed in is not a
+string, False is returned. An identifier consists of alphanumerics or
+underscore characters.
+
+Examples:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a word}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{False}
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{award}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{True}
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+m+mi}{9}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}} \PYG{k+kc}{False}
+\PYG{n}{isWord}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{a\PYGZus{}b\PYGZus{}c\PYGZus{}}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{k+kc}{True}
+\end{sphinxVerbatim}
+
+@note: isWord(‘9abc’) will return True - not exactly correct, but adequate
+for the way it’s used here.
+
+@param s: The name to be tested
+@type s: any
+@return: True if a word, else False
+@rtype: bool
+
+\end{fulllineitems}
+
+\index{makePath() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.makePath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{makePath}}}{\emph{prefix}, \emph{suffix}}{}
+Make a path from a prefix and suffix.
+
+Examples::
+makePath(‘’, ‘suffix’) -\textgreater{} ‘suffix’
+makePath(‘prefix’, ‘suffix’) -\textgreater{} ‘prefix.suffix’
+makePath(‘prefix’, ‘{[}1{]}’) -\textgreater{} ‘prefix{[}1{]}’
+
+@param prefix:  The prefix to use. If it evaluates as false, the suffix is returned.
+@type prefix:   str
+@param suffix:  The suffix to use. It is either an identifier or an index in brackets.
+@type suffix:   str
+@return:        The path concatenation of prefix and suffix, with a dot if the suffix is not a bracketed index.
+@rtype:         str
+
+\end{fulllineitems}
+
+\index{overwriteMergeResolve() (in module src.pyconf)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.pyconf.overwriteMergeResolve}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.pyconf.}}\sphinxbfcode{\sphinxupquote{overwriteMergeResolve}}}{\emph{map1}, \emph{map2}, \emph{key}}{}
+An overwriting resolver for merge conflicts. Calls L\{defaultMergeResolve\},
+but where a “mismatch” is detected, returns “overwrite” instead.
+
+@param map1: The map being merged into.
+@type map1: L\{Mapping\}.
+@param map2: The map being used as the merge operand.
+@type map2: L\{Mapping\}.
+@param key: The key in map2 (which also exists in map1).
+@type key: str
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.returnCode module}
+\label{\detokenize{apidoc_src/src:module-src.returnCode}}\label{\detokenize{apidoc_src/src:src-returncode-module}}\index{src.returnCode (module)}
+This file contains ReturnCode class
+
+usage:
+\textgreater{}\textgreater{} import returnCode as RCO
+\index{ReturnCode (class in src.returnCode)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.returnCode.}}\sphinxbfcode{\sphinxupquote{ReturnCode}}}{\emph{status=None}, \emph{why=None}, \emph{value=None}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+assume simple return code for methods, with explanation as ‘why’
+obviously why is why it is not OK, 
+but also why is why it is OK (if you want). 
+and optionnaly contains a return value as self.getValue()
+
+usage:
+\textgreater{}\textgreater{} import returnCode as RCO
+
+\textgreater{}\textgreater{} aValue = doSomethingToReturn()
+\textgreater{}\textgreater{} return RCO.ReturnCode(“KO”, “there is no problem here”, aValue)
+\textgreater{}\textgreater{} return RCO.ReturnCode(“KO”, “there is a problem here because etc”, None)
+\textgreater{}\textgreater{} return RCO.ReturnCode(“TIMEOUT\_STATUS”, “too long here because etc”)
+\textgreater{}\textgreater{} return RCO.ReturnCode(“NA”, “not applicable here because etc”)
+
+\textgreater{}\textgreater{} rc = doSomething()
+\textgreater{}\textgreater{} print(“short returnCode string”, str(rc))
+\textgreater{}\textgreater{} print(“long returnCode string with value”, repr(rc))
+
+\textgreater{}\textgreater{} rc1 = RCO.ReturnCode(“OK”, …)
+\textgreater{}\textgreater{} rc2 = RCO.ReturnCode(“KO”, …)
+\textgreater{}\textgreater{} rcFinal = rc1 + rc2
+\textgreater{}\textgreater{} print(“long returnCode string with value”, repr(rcFinal)) \# KO!
+\index{KFSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.KFSYS}}\pysigline{\sphinxbfcode{\sphinxupquote{KFSYS}}\sphinxbfcode{\sphinxupquote{ = 4}}}
+\end{fulllineitems}
+
+\index{KNOWNFAILURE\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.KNOWNFAILURE_STATUS}}\pysigline{\sphinxbfcode{\sphinxupquote{KNOWNFAILURE\_STATUS}}\sphinxbfcode{\sphinxupquote{ = 'KF'}}}
+\end{fulllineitems}
+
+\index{KOSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.KOSYS}}\pysigline{\sphinxbfcode{\sphinxupquote{KOSYS}}\sphinxbfcode{\sphinxupquote{ = 1}}}
+\end{fulllineitems}
+
+\index{KO\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.KO_STATUS}}\pysigline{\sphinxbfcode{\sphinxupquote{KO\_STATUS}}\sphinxbfcode{\sphinxupquote{ = 'KO'}}}
+\end{fulllineitems}
+
+\index{NASYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.NASYS}}\pysigline{\sphinxbfcode{\sphinxupquote{NASYS}}\sphinxbfcode{\sphinxupquote{ = 2}}}
+\end{fulllineitems}
+
+\index{NA\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.NA_STATUS}}\pysigline{\sphinxbfcode{\sphinxupquote{NA\_STATUS}}\sphinxbfcode{\sphinxupquote{ = 'NA'}}}
+\end{fulllineitems}
+
+\index{NDSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.NDSYS}}\pysigline{\sphinxbfcode{\sphinxupquote{NDSYS}}\sphinxbfcode{\sphinxupquote{ = 3}}}
+\end{fulllineitems}
+
+\index{OKSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.OKSYS}}\pysigline{\sphinxbfcode{\sphinxupquote{OKSYS}}\sphinxbfcode{\sphinxupquote{ = 0}}}
+\end{fulllineitems}
+
+\index{OK\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.OK_STATUS}}\pysigline{\sphinxbfcode{\sphinxupquote{OK\_STATUS}}\sphinxbfcode{\sphinxupquote{ = 'OK'}}}
+\end{fulllineitems}
+
+\index{TIMEOUT\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.TIMEOUT_STATUS}}\pysigline{\sphinxbfcode{\sphinxupquote{TIMEOUT\_STATUS}}\sphinxbfcode{\sphinxupquote{ = 'TIMEOUT'}}}
+\end{fulllineitems}
+
+\index{TOSYS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.TOSYS}}\pysigline{\sphinxbfcode{\sphinxupquote{TOSYS}}\sphinxbfcode{\sphinxupquote{ = 5}}}
+\end{fulllineitems}
+
+\index{UNKNOWN\_STATUS (src.returnCode.ReturnCode attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.UNKNOWN_STATUS}}\pysigline{\sphinxbfcode{\sphinxupquote{UNKNOWN\_STATUS}}\sphinxbfcode{\sphinxupquote{ = 'ND'}}}
+\end{fulllineitems}
+
+\index{getValue() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.getValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getValue}}}{}{}
+\end{fulllineitems}
+
+\index{getWhy() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.getWhy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getWhy}}}{}{}
+return why as str or list if sum or some ReturnCode
+
+\end{fulllineitems}
+
+\index{indent() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.indent}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{indent}}}{\emph{text}, \emph{amount=5}, \emph{ch=' '}}{}
+indent multi lines message
+
+\end{fulllineitems}
+
+\index{isOk() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.isOk}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isOk}}}{}{}
+return True if ok
+
+\end{fulllineitems}
+
+\index{raiseIfKo() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.raiseIfKo}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{raiseIfKo}}}{}{}
+raise an exception with message why if not ok
+
+\end{fulllineitems}
+
+\index{setStatus() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.setStatus}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setStatus}}}{\emph{status}, \emph{why=None}, \emph{value=None}}{}
+\end{fulllineitems}
+
+\index{setValue() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.setValue}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setValue}}}{\emph{value}}{}
+\end{fulllineitems}
+
+\index{setWhy() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.setWhy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{setWhy}}}{\emph{why}}{}
+\end{fulllineitems}
+
+\index{toSys() (src.returnCode.ReturnCode method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.returnCode.ReturnCode.toSys}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{toSys}}}{}{}
+return system return code as bash or bat
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.salomeTools module}
+\label{\detokenize{apidoc_src/src:src-salometools-module}}\label{\detokenize{apidoc_src/src:module-src.salomeTools}}\index{src.salomeTools (module)}
+This file is the main entry file to salomeTools
+NO \_\_main\_\_ entry allowed, use ‘sat’ (in parent directory)
+\index{Sat (class in src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{Sat}}}{\emph{logger}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+The main class that stores all the commands of salomeTools
+(usually known as ‘runner’ argument in Command classes)
+\index{assumeAsList() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.assumeAsList}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{assumeAsList}}}{\emph{strOrList}}{}
+\end{fulllineitems}
+
+\index{execute\_cli() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.execute_cli}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{execute\_cli}}}{\emph{cli\_arguments}}{}
+select first argument as a command in directory ‘commands’, and launch on arguments
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{cli\_arguments}} \textendash{} (str or list) The sat cli arguments (as sys.argv)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{getColoredVersion() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getColoredVersion}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getColoredVersion}}}{}{}
+get colored salomeTools version message
+
+\end{fulllineitems}
+
+\index{getCommandAndAppli() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getCommandAndAppli}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getCommandAndAppli}}}{\emph{arguments}}{}
+\end{fulllineitems}
+
+\index{getCommandInstance() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getCommandInstance}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getCommandInstance}}}{\emph{name}}{}
+returns inherited instance of Command(\_BaseCmd) for command ‘name’
+if module not loaded yet, load it.
+
+\end{fulllineitems}
+
+\index{getConfig() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getConfig}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getConfig}}}{}{}
+\end{fulllineitems}
+
+\index{getConfigManager() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getConfigManager}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getConfigManager}}}{}{}
+\end{fulllineitems}
+
+\index{getLogger() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getLogger}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getLogger}}}{}{}
+\end{fulllineitems}
+
+\index{getModule() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.getModule}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getModule}}}{\emph{name}}{}
+returns only-one-time loaded module Command ‘name’
+assume load if not done yet
+
+\end{fulllineitems}
+
+\index{get\_help() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.get_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_help}}}{}{}
+get general help colored string
+
+\end{fulllineitems}
+
+\index{parseArguments() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.parseArguments}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseArguments}}}{\emph{arguments}}{}
+\end{fulllineitems}
+
+\index{print\_help() (src.salomeTools.Sat method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.Sat.print_help}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{print\_help}}}{}{}
+prints salomeTools general help
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{assumeAsList() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.assumeAsList}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{assumeAsList}}}{\emph{strOrList}}{}
+return a list as sys.argv if string
+
+\end{fulllineitems}
+
+\index{find\_command\_list() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.find_command_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{find\_command\_list}}}{\emph{dirPath}}{}
+Parse files in dirPath that end with ‘.py’ : it gives commands list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{dirPath}} \textendash{} (str) The directory path where to search the commands
+
+\item[{Returns}] \leavevmode
+(list) the list containing the commands name
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{getCommandsList() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.getCommandsList}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{getCommandsList}}}{}{}
+Gives commands list (as basename of files .py in directory commands
+
+\end{fulllineitems}
+
+\index{getVersion() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.getVersion}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{getVersion}}}{}{}
+get version number as string
+
+\end{fulllineitems}
+
+\index{launchSat() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.launchSat}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{launchSat}}}{\emph{command}}{}
+launch sat as subprocess.Popen
+command as string (‘sat \textendash{}help’ for example)
+used for unittest, or else…
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(stdout, stderr) tuple of subprocess.Popen output
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{setLocale() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.setLocale}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{setLocale}}}{}{}
+reset initial locale at any moment 
+‘fr’ or else (TODO) from initial environment var ‘\$LANG’
+‘i18n’ as ‘internationalization’
+
+\end{fulllineitems}
+
+\index{setNotLocale() (in module src.salomeTools)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.salomeTools.setNotLocale}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.salomeTools.}}\sphinxbfcode{\sphinxupquote{setNotLocale}}}{}{}
+force english at any moment
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.system module}
+\label{\detokenize{apidoc_src/src:src-system-module}}\label{\detokenize{apidoc_src/src:module-src.system}}\index{src.system (module)}
+All utilities method doing a system call, 
+like open a browser or an editor, or call a git command
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import src.system as SYSS
+
+\end{description}
+\index{archive\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.system.archive_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{archive\_extract}}}{\emph{from\_what}, \emph{where}, \emph{logger}}{}
+Extracts sources from an archive.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{from\_what}} \textendash{} (str) The path to the archive.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{where}} \textendash{} (str) The path where to extract.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if the extraction is successful
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{cvs\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.system.cvs_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{cvs\_extract}}}{\emph{protocol}, \emph{user}, \emph{server}, \emph{base}, \emph{tag}, \emph{product}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{}
+Extracts sources from a cvs repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{protocol}} \textendash{} (str) The cvs protocol.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{user}} \textendash{} (str) The user to be used.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{server}} \textendash{} (str) The remote cvs server.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{base}} \textendash{} (str) .
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tag}} \textendash{} (str) The tag.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product}} \textendash{} (str) The product.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{where}} \textendash{} (str) The path where to extract.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{checkout}} \textendash{} (bool) If true use checkout cvs.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environment}} \textendash{} (Environ) 
+The environment to source when extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if the extraction is successful
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{git\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.system.git_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{git\_extract}}}{\emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{environment=None}}{}
+Extracts sources from a git repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{from\_what}} \textendash{} (str) The remote git repository.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tag}} \textendash{} (str) The tag.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{where}} \textendash{} (str) The path where to extract.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environment}} \textendash{} (Environ) 
+The environment to source when extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if the extraction is successful
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{show\_in\_editor() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.system.show_in_editor}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{show\_in\_editor}}}{\emph{editor}, \emph{filePath}, \emph{logger}}{}
+open filePath using editor.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{editor}} \textendash{} (str) The editor to use.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{filePath}} \textendash{} (str) The path to the file to open.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{svn\_extract() (in module src.system)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.system.svn_extract}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.system.}}\sphinxbfcode{\sphinxupquote{svn\_extract}}}{\emph{user}, \emph{from\_what}, \emph{tag}, \emph{where}, \emph{logger}, \emph{checkout=False}, \emph{environment=None}}{}
+Extracts sources from a svn repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{user}} \textendash{} (str) The user to be used.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{from\_what}} \textendash{} (str) The remote git repository.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tag}} \textendash{} (str) The tag.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{where}} \textendash{} (str) The path where to extract.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{checkout}} \textendash{} (bool) If true use checkout svn.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environment}} \textendash{} (Environ)
+The environment to source when extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if the extraction is successful
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{src.template module}
+\label{\detokenize{apidoc_src/src:module-src.template}}\label{\detokenize{apidoc_src/src:src-template-module}}\index{src.template (module)}\index{MyTemplate (class in src.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.template.MyTemplate}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{MyTemplate}}}{\emph{template}}{}
+Bases: \sphinxcode{\sphinxupquote{string.Template}}
+\index{delimiter (src.template.MyTemplate attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.template.MyTemplate.delimiter}}\pysigline{\sphinxbfcode{\sphinxupquote{delimiter}}\sphinxbfcode{\sphinxupquote{ = '\textbackslash{}xc2\textbackslash{}xa4'}}}
+\end{fulllineitems}
+
+\index{pattern (src.template.MyTemplate attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.template.MyTemplate.pattern}}\pysigline{\sphinxbfcode{\sphinxupquote{pattern}}\sphinxbfcode{\sphinxupquote{ = \textless{}\_sre.SRE\_Pattern object at 0x412cde0\textgreater{}}}}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{substitute() (in module src.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.template.substitute}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.template.}}\sphinxbfcode{\sphinxupquote{substitute}}}{\emph{template\_file}, \emph{subst\_dic}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{src.test\_module module}
+\label{\detokenize{apidoc_src/src:module-src.test_module}}\label{\detokenize{apidoc_src/src:src-test-module-module}}\index{src.test\_module (module)}\index{Test (class in src.test\_module)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{Test}}}{\emph{config}, \emph{logger}, \emph{tmp\_working\_dir}, \emph{testbase=''}, \emph{grids=None}, \emph{sessions=None}, \emph{launcher=''}, \emph{show\_desktop=True}}{}~\index{generate\_launching\_commands() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.generate_launching_commands}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_launching\_commands}}}{}{}
+\end{fulllineitems}
+
+\index{generate\_script() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.generate_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{generate\_script}}}{\emph{listTest}, \emph{script\_path}, \emph{ignoreList}}{}
+\end{fulllineitems}
+
+\index{get\_test\_timeout() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.get_test_timeout}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_test\_timeout}}}{\emph{test\_name}, \emph{default\_value}}{}
+\end{fulllineitems}
+
+\index{get\_tmp\_dir() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.get_tmp_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_tmp\_dir}}}{}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.prepare_testbase}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase}}}{\emph{test\_base\_name}}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase\_from\_dir() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.prepare_testbase_from_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_dir}}}{\emph{testbase\_name}, \emph{testbase\_dir}}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase\_from\_git() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.prepare_testbase_from_git}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_git}}}{\emph{testbase\_name}, \emph{testbase\_base}, \emph{testbase\_tag}}{}
+\end{fulllineitems}
+
+\index{prepare\_testbase\_from\_svn() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.prepare_testbase_from_svn}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{prepare\_testbase\_from\_svn}}}{\emph{user}, \emph{testbase\_name}, \emph{testbase\_base}}{}
+\end{fulllineitems}
+
+\index{read\_results() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.read_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{read\_results}}}{\emph{listTest}, \emph{has\_timed\_out}}{}
+\end{fulllineitems}
+
+\index{run\_all\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.run_all_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_all\_tests}}}{}{}
+\end{fulllineitems}
+
+\index{run\_grid\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.run_grid_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_grid\_tests}}}{}{}
+\end{fulllineitems}
+
+\index{run\_script() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.run_script}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_script}}}{\emph{script\_name}}{}
+\end{fulllineitems}
+
+\index{run\_session\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.run_session_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_session\_tests}}}{}{}
+\end{fulllineitems}
+
+\index{run\_testbase\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.run_testbase_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_testbase\_tests}}}{}{}
+Runs test testbase
+
+\end{fulllineitems}
+
+\index{run\_tests() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.run_tests}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_tests}}}{\emph{listTest}, \emph{ignoreList}}{}
+\end{fulllineitems}
+
+\index{search\_known\_errors() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.search_known_errors}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{search\_known\_errors}}}{\emph{status}, \emph{test\_grid}, \emph{test\_session}, \emph{test}}{}
+\end{fulllineitems}
+
+\index{write\_test\_margin() (src.test\_module.Test method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.Test.write_test_margin}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_test\_margin}}}{\emph{tab}}{}
+indent with ‘\textbar{} … +’ to show test results.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{getTmpDirDEFAULT() (in module src.test\_module)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.test_module.getTmpDirDEFAULT}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.test\_module.}}\sphinxbfcode{\sphinxupquote{getTmpDirDEFAULT}}}{}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{src.utilsSat module}
+\label{\detokenize{apidoc_src/src:src-utilssat-module}}\label{\detokenize{apidoc_src/src:module-src.utilsSat}}\index{src.utilsSat (module)}
+utilities for sat
+general useful simple methods
+all-in-one import srs.utilsSat as UTS
+
+usage:
+\textgreater{}\textgreater{} import srsc.utilsSat as UTS
+\textgreater{}\textgreater{} UTS.ensure\_path\_exists(path)
+\index{Path (class in src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{Path}}}{\emph{path}}{}~\index{base() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.base}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{base}}}{}{}
+\end{fulllineitems}
+
+\index{chmod() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.chmod}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{chmod}}}{\emph{mode}}{}
+\end{fulllineitems}
+
+\index{copy() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.copy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy}}}{\emph{path}, \emph{smart=False}}{}
+\end{fulllineitems}
+
+\index{copydir() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.copydir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copydir}}}{\emph{dst}, \emph{smart=False}}{}
+\end{fulllineitems}
+
+\index{copyfile() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.copyfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copyfile}}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{copylink() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.copylink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copylink}}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{dir() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{dir}}}{}{}
+\end{fulllineitems}
+
+\index{exists() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.exists}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exists}}}{}{}
+\end{fulllineitems}
+
+\index{isdir() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.isdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isdir}}}{}{}
+\end{fulllineitems}
+
+\index{isfile() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.isfile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{isfile}}}{}{}
+\end{fulllineitems}
+
+\index{islink() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.islink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{islink}}}{}{}
+\end{fulllineitems}
+
+\index{list() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{list}}}{}{}
+\end{fulllineitems}
+
+\index{make() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.make}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{make}}}{\emph{mode=None}}{}
+\end{fulllineitems}
+
+\index{readlink() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.readlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{readlink}}}{}{}
+\end{fulllineitems}
+
+\index{rm() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.rm}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rm}}}{}{}
+\end{fulllineitems}
+
+\index{smartcopy() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.smartcopy}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{smartcopy}}}{\emph{path}}{}
+\end{fulllineitems}
+
+\index{symlink() (src.utilsSat.Path method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.Path.symlink}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{symlink}}}{\emph{path}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{black() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.black}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{black}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{blue() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.blue}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{blue}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{check\_config\_has\_application() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.check_config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{check\_config\_has\_application}}}{\emph{config}}{}
+Check that the config has the key APPLICATION. 
+Else raise an exception.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The config.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_config\_has\_profile() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.check_config_has_profile}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{check\_config\_has\_profile}}}{\emph{config}}{}
+Check that the config has the key APPLICATION.profile.
+Else, raise an exception.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The config.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_has\_key() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.check_has_key}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{check\_has\_key}}}{\emph{inConfig}, \emph{key}}{}
+Check that the in-Config node has the named key (as an attribute)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{inConfig}} \textendash{} (Config or Mapping etc) The in-Config node
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) The key to check presence in in-Config node
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(RCO.ReturnCode) ‘OK’ if presence
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{config\_has\_application() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.config_has_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{config\_has\_application}}}{\emph{config}}{}
+\end{fulllineitems}
+
+\index{critical() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.critical}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{critical}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{cyan() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.cyan}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{cyan}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{date\_to\_datetime() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.date_to_datetime}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{date\_to\_datetime}}}{\emph{date}}{}
+From a string date in format YYYYMMDD\_HHMMSS
+returns list year, mon, day, hour, minutes, seconds
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{date}} \textendash{} (str) The date in format YYYYMMDD\_HHMMSS
+
+\item[{Returns}] \leavevmode
+(tuple) as (str,str,str,str,str,str)
+The same date and time in separate variables.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{deepcopy\_list() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.deepcopy_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{deepcopy\_list}}}{\emph{input\_list}}{}
+Do a deep copy of a list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{input\_list}} \textendash{} (list) The list to copy
+
+\item[{Returns}] \leavevmode
+(list) The copy of the list
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{ensure\_path\_exists() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.ensure_path_exists}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{ensure\_path\_exists}}}{\emph{path}}{}
+Create a path if not existing
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{path}} \textendash{} (str) The path.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{error() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.error}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{error}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{find\_file\_in\_lpath() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.find_file_in_lpath}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{find\_file\_in\_lpath}}}{\emph{file\_name}, \emph{lpath}, \emph{additional\_dir=''}}{}
+Find in all the directories in lpath list the file 
+that has the same name as file\_name. 
+If it is found, return the full path of the file, else, return False. 
+The additional\_dir (optional) is the name of the directory 
+to add to all paths in lpath.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_name}} \textendash{} (str) The file name to search
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{lpath}} \textendash{} (list) The list of directories where to search
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{additional\_dir}} \textendash{} (str) The name of the additional directory
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The full path of the file or False if not found
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{formatTuples() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.formatTuples}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{formatTuples}}}{\emph{tuples}}{}
+Format ‘label = value’ the tuples in a tabulated way.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{tuples}} \textendash{} (list) The list of tuples to format
+
+\item[{Returns}] \leavevmode
+(str) The tabulated text. (as mutiples lines)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{formatValue() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.formatValue}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{formatValue}}}{\emph{label}, \emph{value}, \emph{suffix=''}}{}
+format ‘label = value’ with the info color
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{label}} \textendash{} (int) the label to print.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to print.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{suffix}} \textendash{} (str) the optionnal suffix to add at the end.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_base\_path() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_base_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_base\_path}}}{\emph{config}}{}
+Returns the path of the products base.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global Config instance.
+
+\item[{Returns}] \leavevmode
+(str) The path of the products base.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_cfg\_param() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_cfg_param}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_cfg\_param}}}{\emph{config}, \emph{param\_name}, \emph{default}}{}
+Search for param\_name value in config.
+If param\_name is not in config, then return default,
+else, return the found value
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The config.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{param\_name}} \textendash{} (str) the name of the parameter to get the value
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{default}} \textendash{} (str) The value to return if param\_name is not in config
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) see initial description of the function
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_launcher\_name() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_launcher_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_launcher\_name}}}{\emph{config}}{}
+Returns the name of application file launcher, ‘salome’ by default.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global Config instance.
+
+\item[{Returns}] \leavevmode
+(str) The name of salome launcher.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_log\_path() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_log_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_log\_path}}}{\emph{config}}{}
+Returns the path of the logs.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global Config instance.
+
+\item[{Returns}] \leavevmode
+(str) The path of the logs.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_property\_in\_product\_cfg() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_property_in_product_cfg}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_property\_in\_product\_cfg}}}{\emph{product\_cfg}, \emph{pprty}}{}
+\end{fulllineitems}
+
+\index{get\_salome\_version() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_salome_version}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_salome\_version}}}{\emph{config}}{}
+\end{fulllineitems}
+
+\index{get\_tmp\_filename() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.get_tmp_filename}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{get\_tmp\_filename}}}{\emph{config}, \emph{name}}{}
+\end{fulllineitems}
+
+\index{green() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.green}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{green}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{handleRemoveReadonly() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.handleRemoveReadonly}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{handleRemoveReadonly}}}{\emph{func}, \emph{path}, \emph{exc}}{}
+\end{fulllineitems}
+
+\index{header() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.header}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{header}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{info() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{info}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{label() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.label}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{label}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{list\_log\_file() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.list_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{list\_log\_file}}}{\emph{dirPath}, \emph{expression}}{}
+Find all files corresponding to expression in dirPath
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{dirPath}} \textendash{} (str) the directory where to search the files
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{expression}} \textendash{} (str) the regular expression of files to find
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) the list of files path and informations about it
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{log\_res\_step() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.log_res_step}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{log\_res\_step}}}{\emph{logger}, \emph{res}}{}
+\end{fulllineitems}
+
+\index{log\_step() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.log_step}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{log\_step}}}{\emph{logger}, \emph{header}, \emph{step}}{}
+\end{fulllineitems}
+
+\index{logger\_info\_tuples() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.logger_info_tuples}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{logger\_info\_tuples}}}{\emph{logger}, \emph{tuples}}{}
+For convenience
+format as formatTuples() and call logger.info()
+
+\end{fulllineitems}
+
+\index{magenta() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.magenta}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{magenta}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{merge\_dicts() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.merge_dicts}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{merge\_dicts}}}{\emph{*dict\_args}}{}
+Given any number of dicts, shallow copy and merge into a new dict,
+precedence goes to key value pairs in latter dicts.
+
+\end{fulllineitems}
+
+\index{normal() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.normal}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{normal}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{only\_numbers() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.only_numbers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{only\_numbers}}}{\emph{str\_num}}{}
+\end{fulllineitems}
+
+\index{parse\_date() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.parse_date}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{parse\_date}}}{\emph{date}}{}
+Transform YYYYMMDD\_hhmmss into YYYY-MM-DD hh:mm:ss.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{date}} \textendash{} (str) The date to transform
+
+\item[{Returns}] \leavevmode
+(str) The date in the new format
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{read\_config\_from\_a\_file() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.read_config_from_a_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{read\_config\_from\_a\_file}}}{\emph{filePath}}{}
+\end{fulllineitems}
+
+\index{red() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.red}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{red}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{remove\_item\_from\_list() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.remove_item_from_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{remove\_item\_from\_list}}}{\emph{input\_list}, \emph{item}}{}
+Remove all occurences of item from input\_list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{input\_list}} \textendash{} (list) The list to modify
+
+\item[{Returns}] \leavevmode
+(list) The without any item
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{replace\_in\_file() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.replace_in_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{replace\_in\_file}}}{\emph{file\_in}, \emph{str\_in}, \emph{str\_out}}{}
+Replace \textless{}str\_in\textgreater{} by \textless{}str\_out\textgreater{} in file \textless{}file\_in\textgreater{}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_in}} \textendash{} (str) The file name
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{str\_in}} \textendash{} (str) The string to search
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{str\_out}} \textendash{} (str) The string to replace.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{reset() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.reset}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{reset}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{show\_command\_log() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.show_command_log}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{show\_command\_log}}}{\emph{logFilePath}, \emph{cmd}, \emph{application}, \emph{notShownCommands}}{}
+Used in updateHatXml. 
+Determine if the log xml file logFilePath 
+has to be shown or not in the hat log.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logFilePath}} \textendash{} (str) the path to the command xml log file
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cmd}} \textendash{} (str) the command of the log file
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{application}} \textendash{} (str) 
+The application passed as parameter to the salomeTools command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{notShownCommands}} \textendash{} (list) 
+The list of commands that are not shown by default
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(RCO.ReturnCode)
+OK if cmd is not in notShownCommands and the application 
+in the log file corresponds to application
+ReturnCode value is tuple (appliLog, launched\_cmd)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{success() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.success}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{success}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{timedelta\_total\_seconds() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.timedelta_total_seconds}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{timedelta\_total\_seconds}}}{\emph{timedelta}}{}
+Replace total\_seconds from datetime module 
+in order to be compatible with old python versions
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{timedelta}} \textendash{} (datetime.timedelta) 
+The delta between two dates
+
+\item[{Returns}] \leavevmode
+(float) 
+The number of seconds corresponding to timedelta.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{update\_hat\_xml() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.update_hat_xml}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{update\_hat\_xml}}}{\emph{logDir}, \emph{application=None}, \emph{notShownCommands={[}{]}}}{}
+Create the xml file in logDir that contain all the xml file 
+and have a name like YYYYMMDD\_HHMMSS\_namecmd.xml
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logDir}} \textendash{} (str) the directory to parse
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{application}} \textendash{} (str) the name of the application if there is any
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{warning() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.warning}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{warning}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{white() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.white}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{white}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+\index{yellow() (in module src.utilsSat)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.utilsSat.yellow}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.utilsSat.}}\sphinxbfcode{\sphinxupquote{yellow}}}{\emph{msg}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{src.xmlManager module}
+\label{\detokenize{apidoc_src/src:src-xmlmanager-module}}\label{\detokenize{apidoc_src/src:module-src.xmlManager}}\index{src.xmlManager (module)}
+Utilities to read xml logging files
+\begin{description}
+\item[{usage:}] \leavevmode
+\textgreater{}\textgreater{} import src.xmlManager as XMLMGR
+
+\end{description}
+\index{ReadXmlFile (class in src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.ReadXmlFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{ReadXmlFile}}}{\emph{filePath}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage reading of an xml log file
+\index{getRootAttrib() (src.xmlManager.ReadXmlFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.ReadXmlFile.getRootAttrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getRootAttrib}}}{}{}
+Get the attibutes of the self.xmlroot
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(dict) The attributes of the root node
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_attrib() (src.xmlManager.ReadXmlFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.ReadXmlFile.get_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_attrib}}}{\emph{node\_name}}{}
+Get the attibutes of the node node\_name in self.xmlroot
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{node\_name}} \textendash{} (str) the name of the node
+
+\item[{Returns}] \leavevmode
+(dict) the attibutes of the node node\_name in self.xmlroot
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_node\_text() (src.xmlManager.ReadXmlFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.ReadXmlFile.get_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_node\_text}}}{\emph{node}}{}
+Get the text of the first node that has name 
+that corresponds to the parameter node
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{node}} \textendash{} (str) the name of the node from which get the text
+
+\item[{Returns}] \leavevmode
+(str) 
+The text of the first node that has name 
+that corresponds to the parameter node
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{XmlLogFile (class in src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.XmlLogFile}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{XmlLogFile}}}{\emph{filePath}, \emph{rootname}, \emph{attrib=\{\}}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage writing in salomeTools xml log file
+\index{add\_simple\_node() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.XmlLogFile.add_simple_node}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
+Add a node with some attibutes and text to the root node.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{node\_name}} \textendash{} (str) the name of the node to add
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the text of the node
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{attrib}} \textendash{} (dict)
+The dictionary containing the attribute of the new node
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_node\_attrib() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.XmlLogFile.append_node_attrib}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{node\_name}, \emph{attrib}}{}
+Append a new attributes to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{node\_name}} \textendash{} (str) The name of the node on which append text
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{attrib}} \textendash{} (dict) The attrib to append
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_node\_text() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.XmlLogFile.append_node_text}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{append\_node\_text}}}{\emph{node\_name}, \emph{text}}{}
+Append a new text to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{node\_name}} \textendash{} (str) The name of the node on which append text
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) The text to append
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_tree() (src.xmlManager.XmlLogFile method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.XmlLogFile.write_tree}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_tree}}}{\emph{stylesheet=None}, \emph{file\_path=None}}{}
+Write the xml tree in the log file path. Add the stylesheet if asked.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{stylesheet}} \textendash{} (str) The stylesheet to apply to the xml file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{add\_simple\_node() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.add_simple_node}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{add\_simple\_node}}}{\emph{root\_node}, \emph{node\_name}, \emph{text=None}, \emph{attrib=\{\}}}{}
+Add a node with some attibutes and text to the root node.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{root\_node}} \textendash{} (etree.Element) 
+the Etree element where to add the new node
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{node\_name}} \textendash{} (str) the name of the node to add
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) the text of the node
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{attrib}} \textendash{} (dict) 
+the dictionary containing the attribute(s) of the new node
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{append\_node\_attrib() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.append_node_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{append\_node\_attrib}}}{\emph{root\_node}, \emph{attrib}}{}
+Append a new attributes to the node that has node\_name as name
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{root\_node}} \textendash{} (etree.Element)
+the Etree element where to append the new attibutes
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{attrib}} \textendash{} (dict) The attrib to append
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_node\_by\_attrib() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.find_node_by_attrib}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{find\_node\_by\_attrib}}}{\emph{xmlroot}, \emph{name\_node}, \emph{key}, \emph{value}}{}
+Find the first node from xmlroot that has name name\_node 
+and that has in its attributes \{key : value\}. 
+Return the node
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{xmlroot}} \textendash{} (etree.Element) 
+the Etree element where to search
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{name\_node}} \textendash{} (str) the name of node to search
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) the key to search
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) the value to search
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(etree.Element) the found node
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_report() (in module src.xmlManager)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_src/src:src.xmlManager.write_report}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{src.xmlManager.}}\sphinxbfcode{\sphinxupquote{write\_report}}}{\emph{filename}, \emph{xmlroot}, \emph{stylesheet}}{}
+Writes a report file from a XML tree.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{filename}} \textendash{} (str) The path to the file to create
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{xmlroot}} \textendash{} (etree.Element) the Etree element to write to the file
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{stylesheet}} \textendash{} (str) The stylesheet to add to the begin of the file
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{Module contents}
+\label{\detokenize{apidoc_src/src:module-src}}\label{\detokenize{apidoc_src/src:module-contents}}\index{src (module)}
+
+\section{commands}
+\label{\detokenize{apidoc_commands/modules:commands}}\label{\detokenize{apidoc_commands/modules::doc}}
+
+\subsection{commands package}
+\label{\detokenize{apidoc_commands/commands::doc}}\label{\detokenize{apidoc_commands/commands:commands-package}}
+
+\subsubsection{Submodules}
+\label{\detokenize{apidoc_commands/commands:submodules}}
+
+\subsubsection{commands.application module}
+\label{\detokenize{apidoc_commands/commands:module-commands.application}}\label{\detokenize{apidoc_commands/commands:commands-application-module}}\index{commands.application (module)}
+Is a salomeTools command module
+see Command class docstring, also used for help
+\index{Command (class in commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The application command creates a SALOME application.
+
+\begin{DUlineblock}{0em}
+\item[] Warning:
+\item[]
+\begin{DUlineblock}{\DUlineblockindent}
+\item[] It works only for SALOME 6.
+\item[] Use the ‘launcher’ command for newer versions of SALOME
+\item[] 
+\end{DUlineblock}
+\item[] Examples:
+\item[] \textgreater{}\textgreater{} sat application SALOME-6.6.0
+\end{DUlineblock}
+\index{getParser() (commands.application.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat application \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.application.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'application'}}}
+\end{fulllineitems}
+
+\index{run() (commands.application.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat application \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{add\_module\_to\_appli() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.add_module_to_appli}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{add\_module\_to\_appli}}}{\emph{out}, \emph{module}, \emph{has\_gui}, \emph{module\_path}, \emph{logger}, \emph{flagline}}{}
+add the definition of a module to out stream.
+
+\end{fulllineitems}
+
+\index{create\_application() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.create_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{create\_application}}}{\emph{config}, \emph{appli\_dir}, \emph{catalog}, \emph{logger}, \emph{display=True}}{}
+\end{fulllineitems}
+
+\index{create\_config\_file() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.create_config_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{create\_config\_file}}}{\emph{config}, \emph{modules}, \emph{env\_file}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{customize\_app() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.customize_app}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{customize\_app}}}{\emph{config}, \emph{appli\_dir}, \emph{logger}}{}
+Customizes the application by editing SalomeApp.xml.
+
+\end{fulllineitems}
+
+\index{generate\_application() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.generate_application}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{generate\_application}}}{\emph{config}, \emph{appli\_dir}, \emph{config\_file}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{generate\_catalog() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.generate_catalog}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{generate\_catalog}}}{\emph{machines}, \emph{config}, \emph{logger}}{}
+Generates the catalog from a list of machines.
+
+\end{fulllineitems}
+
+\index{generate\_launch\_file() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.generate_launch_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{generate\_launch\_file}}}{\emph{config}, \emph{appli\_dir}, \emph{catalog}, \emph{logger}, \emph{l\_SALOME\_modules}}{}
+Obsolescent way of creating the application.
+This method will use appli\_gen to create the application directory.
+
+\end{fulllineitems}
+
+\index{get\_SALOME\_modules() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.get_SALOME_modules}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{get\_SALOME\_modules}}}{\emph{config}}{}
+\end{fulllineitems}
+
+\index{get\_step() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.get_step}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{get\_step}}}{\emph{logger}, \emph{message}, \emph{pad=50}}{}
+returns ‘message …….. ‘ with pad 50 by default
+avoid colors ‘\textless{}color\textgreater{}’ for now in message
+
+\end{fulllineitems}
+
+\index{make\_alias() (in module commands.application)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.application.make_alias}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.application.}}\sphinxbfcode{\sphinxupquote{make\_alias}}}{\emph{appli\_path}, \emph{alias\_path}, \emph{force=False}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.check module}
+\label{\detokenize{apidoc_commands/commands:module-commands.check}}\label{\detokenize{apidoc_commands/commands:commands-check-module}}\index{commands.check (module)}\index{Command (class in commands.check)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.check.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The check command executes the ‘check’ command in the build directory of 
+all the products of the application.
+It is possible to reduce the list of products to check
+by using the \textendash{}products option
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat check SALOME \textendash{}products KERNEL,GUI,GEOM
+\end{DUlineblock}
+\index{getParser() (commands.check.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the check command ‘sat check \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.check.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'check'}}}
+\end{fulllineitems}
+
+\index{run() (commands.check.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat check \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{check\_all\_products() (in module commands.check)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.check_all_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.check.}}\sphinxbfcode{\sphinxupquote{check\_all\_products}}}{\emph{config}, \emph{products\_infos}, \emph{logger}}{}
+Execute the proper configuration commands 
+in each product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) the number of failing commands.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_product() (in module commands.check)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.check_product}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.check.}}\sphinxbfcode{\sphinxupquote{check\_product}}}{\emph{p\_name\_info}, \emph{config}, \emph{logger}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) 
+(str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module commands.check)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.check.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.check.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{options}, \emph{cfg}, \emph{logger}}{}
+method that gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) The Options instance that stores 
+the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cfg}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use 
+for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.clean module}
+\label{\detokenize{apidoc_commands/commands:commands-clean-module}}\label{\detokenize{apidoc_commands/commands:module-commands.clean}}\index{commands.clean (module)}\index{Command (class in commands.clean)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.clean.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The clean command suppresses the source, build, or install directories 
+of the application products.
+Use the options to define what directories you want to suppress and 
+to reduce the list of products
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat clean SALOME \textendash{}build \textendash{}install \textendash{}properties is\_salome\_module:yes
+\end{DUlineblock}
+\index{getParser() (commands.clean.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the command ‘sat clean \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.clean.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'clean'}}}
+\end{fulllineitems}
+
+\index{run() (commands.clean.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat clean \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_build\_directories() (in module commands.clean)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.get_build_directories}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.clean.}}\sphinxbfcode{\sphinxupquote{get\_build\_directories}}}{\emph{products\_infos}}{}
+Returns the list of directory build paths corresponding to the list of 
+product information given as input.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{products\_infos}} \textendash{} (list)
+The list of (name, config) corresponding to one product.
+
+\item[{Returns}] \leavevmode
+(list) the list of build paths.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_install\_directories() (in module commands.clean)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.get_install_directories}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.clean.}}\sphinxbfcode{\sphinxupquote{get\_install\_directories}}}{\emph{products\_infos}}{}
+Returns the list of directory install paths corresponding to the list of 
+product information given as input.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{products\_infos}} \textendash{} (list) 
+The list of (name, config) corresponding to one product.
+
+\item[{Returns}] \leavevmode
+(list) the list of install paths.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_source\_directories() (in module commands.clean)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.get_source_directories}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.clean.}}\sphinxbfcode{\sphinxupquote{get\_source\_directories}}}{\emph{products\_infos}, \emph{without\_dev}}{}
+Returns the list of directory source paths corresponding to the list of 
+product information given as input. If without\_dev (bool), then
+the dev products are ignored.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_infos}} \textendash{} (list) 
+The list of (name, config) corresponding to one product.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{without\_dev}} \textendash{} (boolean) If True, then ignore the dev products.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) the list of source paths.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_has\_dir() (in module commands.clean)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.product_has_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.clean.}}\sphinxbfcode{\sphinxupquote{product\_has\_dir}}}{\emph{product\_info}, \emph{without\_dev=False}}{}
+Returns a boolean at True if there is a source, build and install
+directory corresponding to the product described by product\_info.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (Config) 
+The config corresponding to the product.
+
+\item[{Returns}] \leavevmode
+(bool)
+True if there is a source, build and install
+directory corresponding to the product described by product\_info.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{suppress\_directories() (in module commands.clean)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.clean.suppress_directories}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.clean.}}\sphinxbfcode{\sphinxupquote{suppress\_directories}}}{\emph{l\_paths}, \emph{logger}}{}
+Suppress the paths given in the list in l\_paths.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_paths}} \textendash{} (list) The list of Path to be suppressed
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.compile module}
+\label{\detokenize{apidoc_commands/commands:commands-compile-module}}\label{\detokenize{apidoc_commands/commands:module-commands.compile}}\index{commands.compile (module)}\index{Command (class in commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The compile command constructs the products of the application
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat compile SALOME \textendash{}products KERNEL,GUI,MEDCOUPLING \textendash{}clean\_all
+\end{DUlineblock}
+\index{getParser() (commands.compile.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the command ‘sat compile \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.compile.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'compile'}}}
+\end{fulllineitems}
+
+\index{run() (commands.compile.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat compile \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{add\_compile\_config\_file() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.add_compile_config_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{add\_compile\_config\_file}}}{\emph{p\_info}, \emph{config}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_info}} \textendash{} (Config) The specific config of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_dependencies() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.check_dependencies}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{check\_dependencies}}}{\emph{config}, \emph{p\_name\_p\_info}}{}
+\end{fulllineitems}
+
+\index{compile\_all\_products() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.compile_all_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{compile\_all\_products}}}{\emph{sat}, \emph{config}, \emph{options}, \emph{products\_infos}, \emph{logger}}{}
+Execute the proper configuration commands 
+in each product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (list)
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) the number of failing commands.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{compile\_product() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.compile_product}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{compile\_product}}}{\emph{sat}, \emph{p\_name\_info}, \emph{config}, \emph{options}, \emph{logger}, \emph{header}, \emph{len\_end}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{header}} \textendash{} (str) the header to display when logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{len\_end}} \textendash{} (int) the lenght of the the end of line (used in display)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{compile\_product\_cmake\_autotools() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.compile_product_cmake_autotools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{compile\_product\_cmake\_autotools}}}{\emph{sat}, \emph{p\_name\_info}, \emph{config}, \emph{options}, \emph{logger}, \emph{header}, \emph{len\_end}}{}
+Execute the proper build procedure for autotools or cmake
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) 
+(str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{header}} \textendash{} (str) the header to display when logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{len\_end}} \textendash{} (int) the length of the the end of line (used in display)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{compile\_product\_script() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.compile_product_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{compile\_product\_script}}}{\emph{sat}, \emph{p\_name\_info}, \emph{config}, \emph{options}, \emph{logger}, \emph{header}, \emph{len\_end}}{}
+Execute the script build procedure in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) 
+(str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{header}} \textendash{} (str) the header to display when logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{len\_end}} \textendash{} (int) the lenght of the the end of line (used in display)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{extend\_with\_children() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.extend_with_children}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{extend\_with\_children}}}{\emph{config}, \emph{p\_infos}}{}
+\end{fulllineitems}
+
+\index{extend\_with\_fathers() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.extend_with_fathers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{extend\_with\_fathers}}}{\emph{config}, \emph{p\_infos}}{}
+\end{fulllineitems}
+
+\index{get\_children() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.get_children}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{get\_children}}}{\emph{config}, \emph{p\_name\_p\_info}}{}
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{options}, \emph{cfg}, \emph{logger}}{}
+method that gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The Options instance that stores the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cfg}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_recursive\_children() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.get_recursive_children}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{get\_recursive\_children}}}{\emph{config}, \emph{p\_name\_p\_info}, \emph{without\_native\_fixed=False}}{}
+Get the recursive list of the product that depend on 
+the product defined by prod\_info
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prod\_info}} \textendash{} (Config) The specific config of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{without\_native\_fixed}} \textendash{} (bool) 
+If true, do not include the fixed or native products in the result
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of product\_informations.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_recursive\_fathers() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.get_recursive_fathers}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{get\_recursive\_fathers}}}{\emph{config}, \emph{p\_name\_p\_info}, \emph{without\_native\_fixed=False}}{}
+Get the recursive list of the dependencies of the product defined 
+by prod\_info
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prod\_info}} \textendash{} (Config) The specific config of the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{without\_native\_fixed}} \textendash{} (bool) 
+If true, do not include the fixed or native products in the result
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of product\_informations.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{sort\_products() (in module commands.compile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.compile.sort_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.compile.}}\sphinxbfcode{\sphinxupquote{sort\_products}}}{\emph{config}, \emph{p\_infos}}{}
+Sort the p\_infos regarding the dependencies between the products
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_infos}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.config module}
+\label{\detokenize{apidoc_commands/commands:commands-config-module}}\label{\detokenize{apidoc_commands/commands:module-commands.config}}\index{commands.config (module)}\index{Command (class in commands.config)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.config.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.config.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The config command allows manipulation and operation on config ‘.pyconf’ files.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat config \textendash{}list
+\item[] \textgreater{}\textgreater{} sat config SALOME \textendash{}edit
+\item[] \textgreater{}\textgreater{} sat config SALOME \textendash{}copy SALOME-new
+\item[] \textgreater{}\textgreater{} sat config SALOME \textendash{}value VARS
+\item[] \textgreater{}\textgreater{} sat config SALOME \textendash{}debug VARS
+\item[] \textgreater{}\textgreater{} sat config SALOME \textendash{}info ParaView
+\item[] \textgreater{}\textgreater{} sat config SALOME \textendash{}show\_patchs
+\end{DUlineblock}
+\index{getParser() (commands.config.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.config.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat config \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.config.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.config.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'config'}}}
+\end{fulllineitems}
+
+\index{run() (commands.config.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.config.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat config \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.configure module}
+\label{\detokenize{apidoc_commands/commands:module-commands.configure}}\label{\detokenize{apidoc_commands/commands:commands-configure-module}}\index{commands.configure (module)}\index{Command (class in commands.configure)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.configure.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The configure command executes in the build directory commands
+corresponding to the compilation mode of the application products.
+The possible compilation modes are ‘cmake’, ‘autotools’, or ‘script’.
+
+\begin{DUlineblock}{0em}
+\item[] Here are the commands to be run:
+\item[]
+\begin{DUlineblock}{\DUlineblockindent}
+\item[] autotools: \textgreater{}\textgreater{} build\_configure and configure
+\item[] cmake:     \textgreater{}\textgreater{} cmake
+\item[] script:    (do nothing)
+\item[] 
+\end{DUlineblock}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat configure SALOME \textendash{}products KERNEL,GUI,PARAVIS
+\end{DUlineblock}
+\index{getParser() (commands.configure.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat configure \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.configure.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'configure'}}}
+\end{fulllineitems}
+
+\index{run() (commands.configure.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat configure \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{configure\_all\_products() (in module commands.configure)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.configure_all_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.configure.}}\sphinxbfcode{\sphinxupquote{configure\_all\_products}}}{\emph{config}, \emph{products\_infos}, \emph{conf\_option}, \emph{logger}}{}
+Execute the proper configuration commands 
+in each product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{conf\_option}} \textendash{} (str) The options to add to the command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) the number of failing commands.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{configure\_product() (in module commands.configure)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.configure_product}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.configure.}}\sphinxbfcode{\sphinxupquote{configure\_product}}}{\emph{p\_name\_info}, \emph{conf\_option}, \emph{config}, \emph{logger}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) 
+(str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{conf\_option}} \textendash{} (str) The options to add to the command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module commands.configure)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.configure.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.configure.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{options}, \emph{cfg}, \emph{logger}}{}
+method that gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The Options instance that stores the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cfg}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.environ module}
+\label{\detokenize{apidoc_commands/commands:commands-environ-module}}\label{\detokenize{apidoc_commands/commands:module-commands.environ}}\index{commands.environ (module)}\index{Command (class in commands.environ)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.environ.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.environ.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The environ command generates the environment files of your application.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat environ SALOME
+\end{DUlineblock}
+\index{getParser() (commands.environ.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.environ.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat environ \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.environ.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.environ.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'environ'}}}
+\end{fulllineitems}
+
+\index{run() (commands.environ.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.environ.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat environ \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{write\_all\_source\_files() (in module commands.environ)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.environ.write_all_source_files}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.environ.}}\sphinxbfcode{\sphinxupquote{write\_all\_source\_files}}}{\emph{config, logger, out\_dir=None, src\_root=None, silent=False, shells={[}'bash'{]}, prefix='env', env\_info=None}}{}
+Generates the environment files.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger)
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{out\_dir}} \textendash{} (str) 
+The path to the directory where the files will be put
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{src\_root}} \textendash{} (str) 
+The path to the directory where the sources are
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{silent}} \textendash{} (bool) 
+If True, do not print anything in the terminal
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{shells}} \textendash{} (list) The list of shells to generate
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prefix}} \textendash{} (str) The prefix to add to the file names.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{env\_info}} \textendash{} (str) The list of products to add in the files.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of the generated files.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.find\_duplicates module}
+\label{\detokenize{apidoc_commands/commands:module-commands.find_duplicates}}\label{\detokenize{apidoc_commands/commands:commands-find-duplicates-module}}\index{commands.find\_duplicates (module)}\index{Command (class in commands.find\_duplicates)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.find\_duplicates.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The find\_duplicates command search recursively for all duplicates files
+in INSTALL directory (or the optionally given directory) and 
+prints the found files to the terminal.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat find\_duplicates \textendash{}path /tmp
+\end{DUlineblock}
+\index{getParser() (commands.find\_duplicates.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat find\_duplicates \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.find\_duplicates.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'find\_duplicates'}}}
+\end{fulllineitems}
+
+\index{run() (commands.find\_duplicates.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat find\_duplicates \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Progress\_bar (class in commands.find\_duplicates)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.Progress_bar}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.find\_duplicates.}}\sphinxbfcode{\sphinxupquote{Progress\_bar}}}{\emph{name}, \emph{valMin}, \emph{valMax}, \emph{logger}, \emph{length=50}}{}
+Create a progress bar in the terminal
+\index{display\_value\_progression() (commands.find\_duplicates.Progress\_bar method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.Progress_bar.display_value_progression}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{display\_value\_progression}}}{\emph{val}}{}
+Display the progress bar.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{val}} \textendash{} (float) val must be between valMin and valMax.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{format\_list\_of\_str() (in module commands.find\_duplicates)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.format_list_of_str}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.find\_duplicates.}}\sphinxbfcode{\sphinxupquote{format\_list\_of\_str}}}{\emph{l\_str}}{}
+Make a list from a string
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{l\_str}} \textendash{} (list or str) The variable to format
+
+\item[{Returns}] \leavevmode
+(list) the formatted variable
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{list\_directory() (in module commands.find\_duplicates)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.find_duplicates.list_directory}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.find\_duplicates.}}\sphinxbfcode{\sphinxupquote{list\_directory}}}{\emph{lpath}, \emph{extension\_ignored}, \emph{files\_ignored}, \emph{directories\_ignored}}{}
+Make the list of all files and paths that are not filtered
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{lpath}} \textendash{} (list) 
+The list of path to of the directories where to  search for duplicates
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{extension\_ignored}} \textendash{} (list) The list of extensions to ignore
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{files\_ignored}} \textendash{} (list) The list of files to ignore
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{directories\_ignored}} \textendash{} (list) 
+The list of directory paths to ignore
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list, list) 
+files\_arb\_out is the list of {[}file, path{]} 
+and files\_out is is the list of files
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.generate module}
+\label{\detokenize{apidoc_commands/commands:module-commands.generate}}\label{\detokenize{apidoc_commands/commands:commands-generate-module}}\index{commands.generate (module)}\index{Command (class in commands.generate)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.generate.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The generate command generates SALOME modules from ‘pure cpp’ products.
+
+\begin{DUlineblock}{0em}
+\item[] warning: this command NEEDS YACSGEN to run.
+\item[] 
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat generate SALOME \textendash{}products FLICACPP
+\end{DUlineblock}
+\index{getParser() (commands.generate.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat generate \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.generate.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'generate'}}}
+\end{fulllineitems}
+
+\index{run() (commands.generate.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat generate \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{build\_context() (in module commands.generate)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.build_context}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.generate.}}\sphinxbfcode{\sphinxupquote{build\_context}}}{\emph{config}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{check\_module\_generator() (in module commands.generate)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.check_module_generator}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.generate.}}\sphinxbfcode{\sphinxupquote{check\_module\_generator}}}{\emph{directory=None}}{}
+Check if module\_generator is available.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{directory}} \textendash{} (str) The directory of YACSGEN.
+
+\item[{Returns}] \leavevmode
+(str) 
+The YACSGEN path if the module\_generator is available, else None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{check\_yacsgen() (in module commands.generate)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.check_yacsgen}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.generate.}}\sphinxbfcode{\sphinxupquote{check\_yacsgen}}}{\emph{config}, \emph{directory}, \emph{logger}}{}
+Check if YACSGEN is available.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{directory}} \textendash{} (str) The directory given by option \textendash{}yacsgen
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(RCO.ReturnCode) 
+with value The path to yacsgen directory if ok
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{generate\_component() (in module commands.generate)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.generate_component}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.generate.}}\sphinxbfcode{\sphinxupquote{generate\_component}}}{\emph{config}, \emph{compo}, \emph{product\_info}, \emph{context}, \emph{header}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{generate\_component\_list() (in module commands.generate)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.generate.generate_component_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.generate.}}\sphinxbfcode{\sphinxupquote{generate\_component\_list}}}{\emph{config}, \emph{product\_info}, \emph{context}, \emph{logger}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.init module}
+\label{\detokenize{apidoc_commands/commands:module-commands.init}}\label{\detokenize{apidoc_commands/commands:commands-init-module}}\index{commands.init (module)}\index{Command (class in commands.init)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.init.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The init command Changes the local settings of SAT
+\index{getParser() (commands.init.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat init \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.init.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'init'}}}
+\end{fulllineitems}
+
+\index{run() (commands.init.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat init \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{check\_path() (in module commands.init)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.check_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.init.}}\sphinxbfcode{\sphinxupquote{check\_path}}}{\emph{path\_to\_check}, \emph{logger}}{}
+Verify that the given path is not a file and can be created.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{path\_to\_check}} \textendash{} (str) The path to check.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{display\_local\_values() (in module commands.init)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.display_local_values}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.init.}}\sphinxbfcode{\sphinxupquote{display\_local\_values}}}{\emph{config}, \emph{logger}}{}
+Display the base path
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) The key from which to change the value.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{set\_local\_value() (in module commands.init)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.init.set_local_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.init.}}\sphinxbfcode{\sphinxupquote{set\_local\_value}}}{\emph{config}, \emph{key}, \emph{value}, \emph{logger}}{}
+Edit the site.pyconf file and change a value.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{key}} \textendash{} (str) The key from which to change the value.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) The path to change.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logger instance.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 0 if all is OK, else 1
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.job module}
+\label{\detokenize{apidoc_commands/commands:commands-job-module}}\label{\detokenize{apidoc_commands/commands:module-commands.job}}\index{commands.job (module)}\index{Command (class in commands.job)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.job.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.job.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The job command executes the commands of the job defined
+in the jobs configuration file  
+\textbar{} examples:
+\textbar{} \textgreater{}\textgreater{} sat job \textendash{}jobs\_config my\_jobs \textendash{}name my\_job”
+\index{getParser() (commands.job.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.job.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat job \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.job.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.job.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'job'}}}
+\end{fulllineitems}
+
+\index{run() (commands.job.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.job.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat job \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.jobs module}
+\label{\detokenize{apidoc_commands/commands:commands-jobs-module}}\label{\detokenize{apidoc_commands/commands:module-commands.jobs}}\index{commands.jobs (module)}\index{Command (class in commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The jobs command command launches maintenances that are described in 
+the dedicated jobs configuration file.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat jobs \textendash{}name my\_jobs \textendash{}publish
+\end{DUlineblock}
+\index{getParser() (commands.jobs.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat jobs \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.jobs.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'jobs'}}}
+\end{fulllineitems}
+
+\index{run() (commands.jobs.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat jobs \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Gui (class in commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{Gui}}}{\emph{xml\_dir\_path}, \emph{l\_jobs}, \emph{l\_jobs\_not\_today}, \emph{prefix}, \emph{logger}, \emph{file\_boards=''}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage the the xml data that can be displayed in a browser 
+to see the jobs states
+\index{add\_xml\_board() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.add_xml_board}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{add\_xml\_board}}}{\emph{name}}{}
+Add a board to the board list
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{name}} \textendash{} (str) the board name
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_history() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.find_history}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find\_history}}}{\emph{l\_jobs}, \emph{l\_jobs\_not\_today}}{}
+find, for each job, in the existent xml boards the results for the job.
+Store the results in the dictionary 
+self.history = \{name\_job : list of (date, status, list links)\}
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs}} \textendash{} (list) 
+the list of jobs to run today
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs\_not\_today}} \textendash{} (list) 
+the list of jobs that do not run today
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_test\_log() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.find_test_log}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find\_test\_log}}}{\emph{l\_remote\_log\_files}}{}
+Find if there is a test log (board) in the remote log files and 
+the path to it. There can be several test command, 
+so the result is a list.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{l\_remote\_log\_files}} \textendash{} (list) the list of all remote log files
+
+\item[{Returns}] \leavevmode
+(list) 
+the list of tuples (test log files path, res of the command)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{initialize\_boards() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.initialize_boards}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{initialize\_boards}}}{\emph{l\_jobs}, \emph{l\_jobs\_not\_today}}{}
+Get all the first information needed for each file and write the 
+first version of the files
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs}} \textendash{} (list) the list of jobs that run today
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs\_not\_today}} \textendash{} (list) the list of jobs that do not run today
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{last\_update() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.last_update}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{last\_update}}}{\emph{finish\_status='finished'}}{}
+update information about the jobs for the file xml\_file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs}} \textendash{} (list) the list of jobs that run today
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{xml\_file}} \textendash{} (xmlManager.XmlLogFile) the xml instance to update
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{parse\_csv\_boards() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.parse_csv_boards}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parse\_csv\_boards}}}{\emph{today}}{}
+Parse the csv file that describes the boards to produce and fill 
+the dict d\_input\_boards that contain the csv file contain
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{today}} \textendash{} (int) the current day of the week
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{put\_jobs\_not\_today() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.put_jobs_not_today}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_jobs\_not\_today}}}{\emph{l\_jobs\_not\_today}, \emph{xml\_node\_jobs}}{}
+Get all the first information needed for each file and write the 
+first version of the files
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{xml\_node\_jobs}} \textendash{} (etree.Element) 
+the node corresponding to a job
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs\_not\_today}} \textendash{} (list) 
+the list of jobs that do not run today
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{update\_xml\_file() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.update_xml_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{update\_xml\_file}}}{\emph{l\_jobs}, \emph{xml\_file}}{}
+update information about the jobs for the file xml\_file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs}} \textendash{} (list) the list of jobs that run today
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{xml\_file}} \textendash{} (xmlManager.XmlLogFile) 
+the xml instance to update
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{update\_xml\_files() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.update_xml_files}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{update\_xml\_files}}}{\emph{l\_jobs}}{}
+Write all the xml files with updated information about the jobs
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{l\_jobs}} \textendash{} (list) the list of jobs that run today
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_xml\_file() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.write_xml_file}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_xml\_file}}}{\emph{xml\_file}, \emph{stylesheet}}{}
+Write one xml file and the same file with prefix
+
+\end{fulllineitems}
+
+\index{write\_xml\_files() (commands.jobs.Gui method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Gui.write_xml_files}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_xml\_files}}}{}{}
+Write the xml files
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Job (class in commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{Job}}}{\emph{name}, \emph{machine}, \emph{application}, \emph{board}, \emph{commands}, \emph{timeout}, \emph{config}, \emph{job\_file\_path}, \emph{logger}, \emph{after=None}, \emph{prefix=None}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage one job
+\index{cancel() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.cancel}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cancel}}}{}{}
+In case of a failing job, one has to cancel every job that depend on it.
+This method put the job as failed and will not be executed.
+
+\end{fulllineitems}
+
+\index{check\_time() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.check_time}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check\_time}}}{}{}
+Verify that the job has not exceeded its timeout.
+If it has, kill the remote command and consider the job as finished.
+
+\end{fulllineitems}
+
+\index{get\_log\_files() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.get_log_files}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_log\_files}}}{}{}
+Get the log files produced by the command launched 
+on the remote machine, and put it in the log directory of the user,
+so they can be accessible from
+
+\end{fulllineitems}
+
+\index{get\_pids() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.get_pids}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_pids}}}{}{}
+Get the pid(s) corresponding to the command that have been launched
+On the remote machine
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(list) The list of integers corresponding to the found pids
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_status() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.get_status}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_status}}}{}{}
+Get the status of the job (used by the Gui for xml display)
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str) The current status of the job
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{has\_begun() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.has_begun}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{has\_begun}}}{}{}
+Returns True if the job has already begun
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(bool) True if the job has already begun
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{has\_failed() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.has_failed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{has\_failed}}}{}{}
+Returns True if the job has failed. 
+A job is considered as failed if the machine could not be reached,
+if the remote command failed, 
+or if the job finished with a time out.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(bool) True if the job has failed
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{has\_finished() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.has_finished}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{has\_finished}}}{}{}
+Returns True if the job has already finished 
+(i.e. all the commands have been executed)
+If it is finished, the outputs are stored in the fields out and err.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(bool) True if the job has already finished
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_running() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.is_running}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_running}}}{}{}
+Returns True if the job commands are running
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(bool) True if the job is running
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_timeout() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.is_timeout}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_timeout}}}{}{}
+Returns True if the job commands has finished with timeout
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(bool) True if the job has finished with timeout
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{kill\_remote\_process() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.kill_remote_process}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{kill\_remote\_process}}}{\emph{wait=1}}{}
+Kills the process on the remote machine.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(str, str) the output of the kill, the error of the kill
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{}{}
+Launch the job by executing the remote command.
+
+\end{fulllineitems}
+
+\index{time\_elapsed() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.time_elapsed}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{time\_elapsed}}}{}{}
+Get the time elapsed since the job launching
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+The number of seconds
+
+\item[{Return type}] \leavevmode
+int
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{total\_duration() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.total_duration}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{total\_duration}}}{}{}
+Gives the total duration of the job
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+(int) the total duration of the job in seconds
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_results() (commands.jobs.Job method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Job.write_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_results}}}{}{}
+Display on the terminal all the job’s information
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Jobs (class in commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{Jobs}}}{\emph{runner}, \emph{logger}, \emph{job\_file\_path}, \emph{config\_jobs}, \emph{lenght\_columns=20}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Class to manage the jobs to be run
+\index{cancel\_dependencies\_of\_failing\_jobs() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.cancel_dependencies_of_failing_jobs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cancel\_dependencies\_of\_failing\_jobs}}}{}{}
+Cancels all the jobs that depend on a failing one.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{define\_job() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.define_job}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{define\_job}}}{\emph{job\_def}, \emph{machine}}{}
+Takes a pyconf job definition and a machine (from class machine)
+and returns the job instance corresponding to the definition.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{job\_def}} \textendash{} (Mapping a job definition
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{machine}} \textendash{} (Machine) the machine on which the job will run
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(Job) The corresponding job in a job class instance
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{determine\_jobs\_and\_machines() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.determine_jobs_and_machines}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{determine\_jobs\_and\_machines}}}{}{}
+Reads the pyconf jobs definition and instantiates all
+the machines and jobs to be done today.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{display\_status() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.display_status}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{display\_status}}}{\emph{len\_col}}{}
+Takes a lenght and construct the display of the current status 
+of the jobs in an array that has a column for each host.
+It displays the job that is currently running on the host of the column.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{len\_col}} \textendash{} (int) the size of the column
+
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_job\_that\_has\_name() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.find_job_that_has_name}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{find\_job\_that\_has\_name}}}{\emph{name}}{}
+Returns the job by its name.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{name}} \textendash{} (str) a job name
+
+\item[{Returns}] \leavevmode
+(Job) the job that has the name.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{is\_occupied() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.is_occupied}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{is\_occupied}}}{\emph{hostname}}{}
+Returns True if a job is running on 
+the machine defined by its host and its port.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{hostname}} \textendash{} (str, int) the pair (host, port)
+
+\item[{Returns}] \leavevmode
+(Job or bool) 
+the job that is running on the host, 
+or false if there is no job running on the host.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_jobs() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.run_jobs}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run\_jobs}}}{}{}
+The main method. Runs all the jobs on every host. 
+For each host, at a given time, only one job can be running.
+The jobs that have the field after (that contain the job that has
+to be run before it) are run after the previous job.
+This method stops when all the jobs are finished.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{ssh\_connection\_all\_machines() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.ssh_connection_all_machines}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{ssh\_connection\_all\_machines}}}{\emph{pad=50}}{}
+Do the ssh connection to every machine to be used today.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{str\_of\_length() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.str_of_length}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{str\_of\_length}}}{\emph{text}, \emph{length}}{}
+Takes a string text of any length and returns 
+the most close string of length “length”.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{text}} \textendash{} (str) any string
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{length}} \textendash{} (int) a length for the returned string
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) the most close string of length “length”
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{update\_jobs\_states\_list() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.update_jobs_states_list}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{update\_jobs\_states\_list}}}{}{}
+Updates the lists that store the currently
+running jobs and the jobs that have already finished.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_all\_results() (commands.jobs.Jobs method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Jobs.write_all_results}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_all\_results}}}{}{}
+Display all the jobs outputs.
+\begin{quote}\begin{description}
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{Machine (class in commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{Machine}}}{\emph{name}, \emph{host}, \emph{user}, \emph{port=22}, \emph{passwd=None}, \emph{sat\_path='salomeTools'}}{}
+Bases: \sphinxcode{\sphinxupquote{object}}
+
+Manage a ssh connection on a machine
+\index{close() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.close}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{close}}}{}{}
+Close the ssh connection
+
+\end{fulllineitems}
+
+\index{connect() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.connect}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{connect}}}{\emph{logger}}{}
+Initiate the ssh connection to the remote machine
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} The logger instance
+
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{copy\_sat() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.copy_sat}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{copy\_sat}}}{\emph{sat\_local\_path}, \emph{job\_file}}{}
+Copy salomeTools to the remote machine in self.sat\_path
+
+\end{fulllineitems}
+
+\index{exec\_command() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.exec_command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{exec\_command}}}{\emph{command}, \emph{logger}}{}
+Execute the command on the remote machine
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{command}} \textendash{} (str) The command to be run
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} The logger instance
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(paramiko.channel.ChannelFile, etc) 
+the stdin, stdout, and stderr of the executing command,
+as a 3-tuple
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{mkdir() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.mkdir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{mkdir}}}{\emph{path}, \emph{mode=511}, \emph{ignore\_existing=False}}{}
+As mkdir by adding an option to not fail if the folder exists
+
+\end{fulllineitems}
+
+\index{put\_dir() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.put_dir}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{put\_dir}}}{\emph{source}, \emph{target}, \emph{filters={[}{]}}}{}
+Uploads the contents of the source directory to the target path.
+The target directory needs to exists. 
+All sub-directories in source are created under target.
+
+\end{fulllineitems}
+
+\index{successfully\_connected() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.successfully_connected}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{successfully\_connected}}}{\emph{logger}}{}
+Verify if the connection to the remote machine has succeed
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} The logger instance
+
+\item[{Returns}] \leavevmode
+(bool) True if the connection has succeed, False if not
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{write\_info() (commands.jobs.Machine method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.Machine.write_info}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{write\_info}}}{\emph{logger}}{}
+Prints the informations relative to the machine in the logger 
+(terminal traces and log file)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} The logger instance
+
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{develop\_factorized\_jobs() (in module commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.develop_factorized_jobs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{develop\_factorized\_jobs}}}{\emph{config\_jobs}}{}
+update information about the jobs for the file xml\_file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{config\_jobs}} \textendash{} (Config) 
+the config corresponding to the jos description
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{getParamiko() (in module commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.getParamiko}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{getParamiko}}}{\emph{logger=None}}{}
+\end{fulllineitems}
+
+\index{get\_config\_file\_path() (in module commands.jobs)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.jobs.get_config_file_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.jobs.}}\sphinxbfcode{\sphinxupquote{get\_config\_file\_path}}}{\emph{job\_config\_name}, \emph{l\_cfg\_dir}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.launcher module}
+\label{\detokenize{apidoc_commands/commands:commands-launcher-module}}\label{\detokenize{apidoc_commands/commands:module-commands.launcher}}\index{commands.launcher (module)}\index{Command (class in commands.launcher)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.launcher.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The launcher command generates a SALOME launcher.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat launcher SALOME 
+\end{DUlineblock}
+\index{getParser() (commands.launcher.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all possible options for command ‘sat launcher \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.launcher.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'launcher'}}}
+\end{fulllineitems}
+
+\index{run() (commands.launcher.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat launcher \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{copy\_catalog() (in module commands.launcher)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.copy_catalog}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.launcher.}}\sphinxbfcode{\sphinxupquote{copy\_catalog}}}{\emph{config}, \emph{catalog\_path}}{}
+Copy the xml catalog file into the right location
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{catalog\_path}} \textendash{} (str) the catalog file path
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(dict) 
+The environment dictionary corresponding to the file path.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{generate\_catalog() (in module commands.launcher)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.generate_catalog}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.launcher.}}\sphinxbfcode{\sphinxupquote{generate\_catalog}}}{\emph{machines}, \emph{config}, \emph{logger}}{}
+Generates an xml catalog file from a list of machines.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{machines}} \textendash{} (list) The list of machines to add in the catalog
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The catalog file path.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{generate\_launch\_file() (in module commands.launcher)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.launcher.generate_launch_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.launcher.}}\sphinxbfcode{\sphinxupquote{generate\_launch\_file}}}{\emph{config}, \emph{logger}, \emph{launcher\_name}, \emph{pathlauncher}, \emph{display=True}, \emph{additional\_env=\{\}}}{}
+Generates the launcher file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{launcher\_name}} \textendash{} (str) The name of the launcher to generate
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{pathlauncher}} \textendash{} (str) The path to the launcher to generate
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{display}} \textendash{} (bool) If False, do not print anything in the terminal
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{additional\_env}} \textendash{} (dict) 
+The dict giving additional environment variables
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The launcher file path.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.log module}
+\label{\detokenize{apidoc_commands/commands:commands-log-module}}\label{\detokenize{apidoc_commands/commands:module-commands.log}}\index{commands.log (module)}\index{Command (class in commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The log command gives access to the logs produced by the salomeTools commands.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat log
+\end{DUlineblock}
+\index{getParser() (commands.log.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat log \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.log.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'log'}}}
+\end{fulllineitems}
+
+\index{run() (commands.log.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat log \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ask\_value() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.ask_value}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{ask\_value}}}{\emph{nb}}{}
+Ask for an int n. 0\textless{}n\textless{}nb
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{nb}} \textendash{} (int) The maximum value of the value to be returned by the user.
+
+\item[{Returns}] \leavevmode
+(int) 
+the value entered by the user. Return -1 if it is not as expected
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{getMaxFormat() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.getMaxFormat}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{getMaxFormat}}}{\emph{aListOfStr}, \emph{offset=1}}{}
+returns format for columns width as ‘\%-30s”’ for example
+
+\end{fulllineitems}
+
+\index{get\_last\_log\_file() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.get_last_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{get\_last\_log\_file}}}{\emph{logDir}, \emph{notShownCommands}}{}
+Used in case of last option. 
+Get the last log command file path.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logDir}} \textendash{} (str) The directory where to search the log files
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{notShownCommands}} \textendash{} (list) the list of commands to ignore
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) the path to the last log file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{print\_log\_command\_in\_terminal() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.print_log_command_in_terminal}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{print\_log\_command\_in\_terminal}}}{\emph{filePath}, \emph{logger}}{}
+Print the contain of filePath. It contains a command log in xml format.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{filePath}} \textendash{} The command xml file from which extract the commands context and traces
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance to use in order to print.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{remove\_log\_file() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.remove_log_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{remove\_log\_file}}}{\emph{filePath}, \emph{logger}}{}
+if it exists, print a warning and remove the input file
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{filePath}} \textendash{} the path of the file to delete
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logger instance to use for the print
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{show\_last\_logs() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.show_last_logs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{show\_last\_logs}}}{\emph{logger}, \emph{config}, \emph{log\_dirs}}{}
+Show last compilation logs
+
+\end{fulllineitems}
+
+\index{show\_product\_last\_logs() (in module commands.log)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.log.show_product_last_logs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.log.}}\sphinxbfcode{\sphinxupquote{show\_product\_last\_logs}}}{\emph{logger}, \emph{config}, \emph{product\_log\_dir}}{}
+Show last compilation logs of a product
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.make module}
+\label{\detokenize{apidoc_commands/commands:module-commands.make}}\label{\detokenize{apidoc_commands/commands:commands-make-module}}\index{commands.make (module)}\index{Command (class in commands.make)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.make.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The make command executes the ‘make’ command in the build directory.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat make SALOME \textendash{}products Python,KERNEL,GUI
+\end{DUlineblock}
+\index{getParser() (commands.make.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the command ‘sat make \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.make.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'make'}}}
+\end{fulllineitems}
+
+\index{run() (commands.make.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat make \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_nb\_proc() (in module commands.make)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.get_nb_proc}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.make.}}\sphinxbfcode{\sphinxupquote{get\_nb\_proc}}}{\emph{product\_info}, \emph{config}, \emph{make\_option}}{}
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module commands.make)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.make.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{options}, \emph{cfg}, \emph{logger}}{}
+method that gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The Options instance that stores the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cfg}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of tuples (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{make\_all\_products() (in module commands.make)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.make_all_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.make.}}\sphinxbfcode{\sphinxupquote{make\_all\_products}}}{\emph{config}, \emph{products\_infos}, \emph{make\_option}, \emph{logger}}{}
+Execute the proper configuration commands 
+in each product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{make\_option}} \textendash{} (str) The options to add to the command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) the number of failing commands.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{make\_product() (in module commands.make)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.make.make_product}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.make.}}\sphinxbfcode{\sphinxupquote{make\_product}}}{\emph{p\_name\_info}, \emph{make\_option}, \emph{config}, \emph{logger}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{make\_option}} \textendash{} (str) The options to add to the command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.makeinstall module}
+\label{\detokenize{apidoc_commands/commands:commands-makeinstall-module}}\label{\detokenize{apidoc_commands/commands:module-commands.makeinstall}}\index{commands.makeinstall (module)}\index{Command (class in commands.makeinstall)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.makeinstall.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The makeinstall command executes the ‘make install’ command in the build directory.
+In case of product constructed using a script (build\_source : ‘script’), 
+then the makeinstall command do nothing.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat makeinstall SALOME \textendash{}products KERNEL,GUI
+\end{DUlineblock}
+\index{getParser() (commands.makeinstall.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the command ‘sat makeinstall \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.makeinstall.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'makeinstall'}}}
+\end{fulllineitems}
+
+\index{run() (commands.makeinstall.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat makeinstall \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module commands.makeinstall)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.makeinstall.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{options}, \emph{cfg}, \emph{logger}}{}
+method that gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The Options instance that stores the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cfg}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{makeinstall\_all\_products() (in module commands.makeinstall)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.makeinstall_all_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.makeinstall.}}\sphinxbfcode{\sphinxupquote{makeinstall\_all\_products}}}{\emph{config}, \emph{products\_infos}, \emph{logger}}{}
+Execute the proper configuration commands 
+in each product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) the number of failing commands.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{makeinstall\_product() (in module commands.makeinstall)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.makeinstall.makeinstall_product}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.makeinstall.}}\sphinxbfcode{\sphinxupquote{makeinstall\_product}}}{\emph{p\_name\_info}, \emph{config}, \emph{logger}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) 
+(str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.package module}
+\label{\detokenize{apidoc_commands/commands:commands-package-module}}\label{\detokenize{apidoc_commands/commands:module-commands.package}}\index{commands.package (module)}\index{Command (class in commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The package command creates an archive.
+
+\begin{DUlineblock}{0em}
+\item[] There are 4 kinds of archive, which can be mixed:
+\item[] 1- The binary archive. It contains all the product installation directories and a launcher.
+\item[] 2- The sources archive. It contains the products archives, a project corresponding to the application and salomeTools.
+\item[] 3- The project archive. It contains a project (give the project file path as argument).
+\item[] 4- The salomeTools archive. It contains salomeTools.
+\item[] 
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat package SALOME \textendash{}binaries \textendash{}sources
+\end{DUlineblock}
+\index{getParser() (commands.package.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat package \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.package.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'package'}}}
+\end{fulllineitems}
+
+\index{run() (commands.package.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat package \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{add\_files() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.add_files}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{add\_files}}}{\emph{tar}, \emph{name\_archive}, \emph{d\_content}, \emph{logger}, \emph{f\_exclude=None}}{}
+Create an archive containing all directories and files that are given 
+in the d\_content argument.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tar}} \textendash{} (tarfile) The tarfile instance used to make the archive.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{name\_archive}} \textendash{} (str) The name of the archive to make.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{d\_content}} \textendash{} (dict) 
+The dictionary that contain all directories and files to add in the archive.
+d\_content{[}label{]} = (path\_on\_local\_machine, path\_in\_archive)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{f\_exclude}} \textendash{} (function) the function that filters
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 0 if success, 1 if not.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{add\_readme() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.add_readme}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{add\_readme}}}{\emph{config}, \emph{options}, \emph{where}}{}
+\end{fulllineitems}
+
+\index{add\_salomeTools() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.add_salomeTools}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{add\_salomeTools}}}{\emph{config}, \emph{tmp\_working\_dir}}{}
+Prepare a version of salomeTools that has a specific local.pyconf file 
+configured for a source package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tmp\_working\_dir}} \textendash{} (str) 
+The temporary local directory containing some specific directories
+or files needed in the source package
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) 
+The path to the local salomeTools directory to add in the package
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{binary\_package() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.binary_package}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{binary\_package}}}{\emph{config}, \emph{logger}, \emph{options}, \emph{tmp\_working\_dir}}{}
+Prepare a dictionary that stores all the needed directories and files 
+to add in a binary package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (OptResult) the options of the launched command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tmp\_working\_dir}} \textendash{} (str) 
+The temporary local directory containing some specific directories
+or files needed in the binary package
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(dict) 
+The dictionary that stores all the needed directories and files 
+to add in a binary package.
+\{label : (path\_on\_local\_machine, path\_in\_archive)\}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{create\_project\_for\_src\_package() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.create_project_for_src_package}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{create\_project\_for\_src\_package}}}{\emph{config}, \emph{tmp\_working\_dir}, \emph{with\_vcs}}{}
+Create a specific project for a source package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tmp\_working\_dir}} \textendash{} (str)
+The temporary local directory containing some specific directories
+or files needed in the source package
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{with\_vcs}} \textendash{} (bool) 
+True if the package is with vcs products 
+(not transformed into archive products)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(dict)
+The dictionary 
+\{“project” : (produced project, project path in the archive)\}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{exclude\_VCS\_and\_extensions() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.exclude_VCS_and_extensions}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{exclude\_VCS\_and\_extensions}}}{\emph{filename}}{}
+The function that is used to exclude from package the link to the 
+VCS repositories (like .git)
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{filename}} \textendash{} (str) The filname to exclude (or not).
+
+\item[{Returns}] \leavevmode
+(bool) True if the file has to be exclude
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_application\_pyconf() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.find_application_pyconf}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{find\_application\_pyconf}}}{\emph{config}, \emph{application\_tmp\_dir}}{}
+Find the application pyconf file and put it in the specific temporary 
+directory containing the specific project of a source package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} ‘Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{application\_tmp\_dir}} \textendash{} (str) 
+The path to the temporary application scripts directory of the project.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_product\_scripts\_and\_pyconf() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.find_product_scripts_and_pyconf}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{find\_product\_scripts\_and\_pyconf}}}{\emph{p\_name}, \emph{p\_info}, \emph{config}, \emph{with\_vcs}, \emph{compil\_scripts\_tmp\_dir}, \emph{env\_scripts\_tmp\_dir}, \emph{patches\_tmp\_dir}, \emph{products\_pyconf\_tmp\_dir}}{}
+Create a specific pyconf file for a given product. 
+Get its environment script, its compilation script 
+and patches and put it in the temporary working directory. 
+This method is used in the source package in order to
+construct the specific project.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name}} \textendash{} (str) The name of the product.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_info}} \textendash{} (Config) The specific configuration corresponding to the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{with\_vcs}} \textendash{} (bool) 
+True if the package is with vcs products 
+(not transformed into archive products)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{compil\_scripts\_tmp\_dir}} \textendash{} (str) 
+The path to the temporary compilation scripts directory of the project.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{env\_scripts\_tmp\_dir}} \textendash{} (str) 
+The path to the temporary environment script directory of the project.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{patches\_tmp\_dir}} \textendash{} (str) 
+The path to the temporary patch scripts directory of the project.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_pyconf\_tmp\_dir}} \textendash{} (str) 
+The path to the temporary product scripts directory of the project.
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_archives() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.get_archives}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{get\_archives}}}{\emph{config}, \emph{logger}}{}
+Find all the products from an archive and all the products
+from a VCS (git, cvs, svn) repository.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logging instance
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(Dict, List)
+The dictionary 
+\{name\_product : (local path of its archive, path in the package of its archive )\}
+and the list of specific configuration corresponding to the vcs products
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_archives\_vcs() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.get_archives_vcs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{get\_archives\_vcs}}}{\emph{l\_pinfo\_vcs}, \emph{sat}, \emph{config}, \emph{logger}, \emph{tmp\_working\_dir}}{}
+For sources package that require that all products from an archive, 
+one has to create some archive for the vcs products.
+So this method calls the clean and source command of sat 
+and then create the archives.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_pinfo\_vcs}} \textendash{} (list) 
+The list of specific configuration corresponding to each vcs product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{sat}} \textendash{} (Sat) 
+The Sat instance that can be called to clean and source the products
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) The logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tmp\_working\_dir}} \textendash{} (str) 
+The temporary local directory containing some specific directories
+or files needed in the source package
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(dict) 
+The dictionary that stores all the archives to add in the sourcepackage.
+\{label : (path\_on\_local\_machine, path\_in\_archive)\}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{hack\_for\_distene\_licence() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.hack_for_distene_licence}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{hack\_for\_distene\_licence}}}{\emph{filepath}}{}
+Replace the distene licence env variable by a call to a file.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{filepath}} \textendash{} (str) The path to the launcher to modify.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{make\_archive() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.make_archive}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{make\_archive}}}{\emph{prod\_name}, \emph{prod\_info}, \emph{where}}{}
+Create an archive of a product by searching its source directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prod\_name}} \textendash{} (str) The name of the product.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prod\_info}} \textendash{} (Config)
+The specific configuration corresponding to the product
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{where}} \textendash{} (str) 
+The path of the repository where to put the resulting archive
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The path of the resulting archive
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{produce\_install\_bin\_file() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.produce_install_bin_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{produce\_install\_bin\_file}}}{\emph{config}, \emph{logger}, \emph{file\_dir}, \emph{d\_sub}, \emph{file\_name}}{}
+Create a bash shell script which do substitutions in BIRARIES dir 
+in order to use it for extra compilations.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_dir}} \textendash{} (str) the directory where to put the files
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{d\_sub}} \textendash{} (dict) 
+the dictionnary that contains the substitutions to be done
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_name}} \textendash{} (str) the name of the install script file
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) the produced file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{produce\_relative\_env\_files() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.produce_relative_env_files}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{produce\_relative\_env\_files}}}{\emph{config}, \emph{logger}, \emph{file\_dir}, \emph{binaries\_dir\_name}}{}
+Create some specific environment files for the binary package.
+These files use relative paths.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_dir}} \textendash{} (str) the directory where to put the files
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{binaries\_dir\_name}} \textendash{} (str) 
+The name of the repository where the binaries are, in the archive.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of path of the produced environment files
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{produce\_relative\_launcher() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.produce_relative_launcher}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{produce\_relative\_launcher}}}{\emph{config}, \emph{logger}, \emph{file\_dir}, \emph{file\_name}, \emph{binaries\_dir\_name}, \emph{with\_commercial=True}}{}
+Create a specific SALOME launcher for the binary package.
+This launcher uses relative paths.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_dir}} \textendash{} (str) the directory where to put the launcher
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_name}} \textendash{} (str) The launcher name
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{binaries\_dir\_name}} \textendash{} (str) 
+the name of the repository where the binaries are, in the archive.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) the path of the produced launcher
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{product\_appli\_creation\_script() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.product_appli_creation_script}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{product\_appli\_creation\_script}}}{\emph{config}, \emph{logger}, \emph{file\_dir}, \emph{binaries\_dir\_name}}{}
+Create a script that can produce an application (EDF style) 
+in the binary package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{file\_dir}} \textendash{} (str) the directory where to put the file
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{binaries\_dir\_name}} \textendash{} (str) 
+The name of the repository where the binaries are, in the archive.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The path of the produced script file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{project\_package() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.project_package}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{project\_package}}}{\emph{project\_file\_path}, \emph{tmp\_working\_dir}}{}
+Prepare a dictionary that stores all the needed directories and files 
+to add in a project package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{project\_file\_path}} \textendash{} (str) The path to the local project.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tmp\_working\_dir}} \textendash{} (str) 
+The temporary local directory containing some specific directories
+or files needed in the project package
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(dict)
+The dictionary that stores all the needed directories and files
+to add in a project package.
+\{label : (path\_on\_local\_machine, path\_in\_archive)\}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{source\_package() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.source_package}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{source\_package}}}{\emph{sat}, \emph{config}, \emph{logger}, \emph{options}, \emph{tmp\_working\_dir}}{}
+Prepare a dictionary that stores all the needed directories and files 
+to add in a source package.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) the logging instance
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (OptResult) the options of the launched command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{tmp\_working\_dir}} \textendash{} (str)
+The temporary local directory containing some specific directories
+or files needed in the binary package
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(dict)
+the dictionary that stores all the needed directories and files
+to add in a source package.
+\{label : (path\_on\_local\_machine, path\_in\_archive)\}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{update\_config() (in module commands.package)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.package.update_config}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.package.}}\sphinxbfcode{\sphinxupquote{update\_config}}}{\emph{config}, \emph{prop}, \emph{value}}{}
+Remove from config.APPLICATION.products the products 
+that have the property given as input.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global config.
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{prop}} \textendash{} (str) The property to filter
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{value}} \textendash{} (str) The value of the property to filter
+
+\end{itemize}
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.patch module}
+\label{\detokenize{apidoc_commands/commands:module-commands.patch}}\label{\detokenize{apidoc_commands/commands:commands-patch-module}}\index{commands.patch (module)}\index{Command (class in commands.patch)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.patch.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.patch.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The patch command apply the patches on the sources of the application products
+if there is any.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat patch SALOME \textendash{}products qt,boost
+\end{DUlineblock}
+\index{getParser() (commands.patch.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.patch.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat patch \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.patch.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.patch.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'patch'}}}
+\end{fulllineitems}
+
+\index{run() (commands.patch.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.patch.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat patch \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{apply\_patch() (in module commands.patch)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.patch.apply_patch}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.patch.}}\sphinxbfcode{\sphinxupquote{apply\_patch}}}{\emph{config}, \emph{product\_info}, \emph{max\_product\_name\_len}, \emph{logger}}{}
+The method called to apply patches on a product
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product to be patched
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger: 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(RCO.ReturnCode)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.prepare module}
+\label{\detokenize{apidoc_commands/commands:commands-prepare-module}}\label{\detokenize{apidoc_commands/commands:module-commands.prepare}}\index{commands.prepare (module)}\index{Command (class in commands.prepare)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.prepare.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The prepare command gets the sources of the application products 
+and apply the patches if there is any.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat prepare SALOME \textendash{}products KERNEL,GUI
+\end{DUlineblock}
+\index{getParser() (commands.prepare.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat prepare \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.prepare.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'prepare'}}}
+\end{fulllineitems}
+
+\index{run() (commands.prepare.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat prepare \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{find\_products\_already\_getted() (in module commands.prepare)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.find_products_already_getted}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.prepare.}}\sphinxbfcode{\sphinxupquote{find\_products\_already\_getted}}}{\emph{l\_products}}{}
+Returns the list of products that have an existing source directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{l\_products}} \textendash{} (list) The list of products to check
+
+\item[{Returns}] \leavevmode
+(list) 
+The list of product configurations 
+that have an existing source directory.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{find\_products\_with\_patchs() (in module commands.prepare)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.find_products_with_patchs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.prepare.}}\sphinxbfcode{\sphinxupquote{find\_products\_with\_patchs}}}{\emph{l\_products}}{}
+Returns the list of products that have one or more patches.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{l\_products}} \textendash{} (list) The list of products to check
+
+\item[{Returns}] \leavevmode
+(list) 
+The list of product configurations 
+that have one or more patches.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{remove\_products() (in module commands.prepare)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.prepare.remove_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.prepare.}}\sphinxbfcode{\sphinxupquote{remove\_products}}}{\emph{arguments}, \emph{l\_products\_info}, \emph{logger}}{}
+Removes the products in l\_products\_info from arguments list.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{arguments}} \textendash{} (str) The arguments from which to remove products
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{l\_products\_info}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) The updated arguments.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.profile module}
+\label{\detokenize{apidoc_commands/commands:commands-profile-module}}\label{\detokenize{apidoc_commands/commands:module-commands.profile}}\index{commands.profile (module)}\index{Command (class in commands.profile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.profile.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The profile command creates default profile.
+
+\begin{DUlineblock}{0em}
+\item[] examples: 
+\item[] \textgreater{}\textgreater{} sat profile {[}PRODUCT{]} 
+\item[] \textgreater{}\textgreater{} sat profile \textendash{}prefix (string)
+\item[] \textgreater{}\textgreater{} sat profile \textendash{}name (string)
+\item[] \textgreater{}\textgreater{} sat profile \textendash{}force
+\item[] \textgreater{}\textgreater{} sat profile \textendash{}version (string) 
+\item[] \textgreater{}\textgreater{} sat profile \textendash{}slogan (string) 
+\end{DUlineblock}
+\index{getParser() (commands.profile.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat profile \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.profile.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'profile'}}}
+\end{fulllineitems}
+
+\index{run() (commands.profile.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat profile \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{generate\_profile\_sources() (in module commands.profile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.generate_profile_sources}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.profile.}}\sphinxbfcode{\sphinxupquote{generate\_profile\_sources}}}{\emph{config}, \emph{options}, \emph{logger}}{}
+Generates the sources of the profile
+
+\end{fulllineitems}
+
+\index{get\_profile\_name() (in module commands.profile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.get_profile_name}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.profile.}}\sphinxbfcode{\sphinxupquote{get\_profile\_name}}}{\emph{options}, \emph{config}}{}
+\end{fulllineitems}
+
+\index{profileConfigReader (class in commands.profile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.profileConfigReader}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.profile.}}\sphinxbfcode{\sphinxupquote{profileConfigReader}}}{\emph{config}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.ConfigReader}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.ConfigReader}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.ConfigReader}})
+\index{parseMapping() (commands.profile.profileConfigReader method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.profileConfigReader.parseMapping}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parseMapping}}}{\emph{parent}, \emph{suffix}}{}
+Parse a mapping.
+
+@param parent: The container to which the mapping will be added.
+@type parent: A L\{Container\} instance.
+@param suffix: The suffix for the value.
+@type suffix: str
+@return: a L\{Mapping\} instance representing the mapping.
+@rtype: L\{Mapping\}
+@raise ConfigFormatError: if a syntax error is found.
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{profileReference (class in commands.profile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.profileReference}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.profile.}}\sphinxbfcode{\sphinxupquote{profileReference}}}{\emph{config}, \emph{type}, \emph{ident}}{}
+Bases: {\hyperref[\detokenize{apidoc_src/src:src.pyconf.Reference}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{src.pyconf.Reference}}}}} (\autopageref*{\detokenize{apidoc_src/src:src.pyconf.Reference}})
+
+\end{fulllineitems}
+
+\index{update\_pyconf() (in module commands.profile)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.profile.update_pyconf}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.profile.}}\sphinxbfcode{\sphinxupquote{update\_pyconf}}}{\emph{config}, \emph{options}, \emph{logger}}{}
+Updates the pyconf
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.run module}
+\label{\detokenize{apidoc_commands/commands:commands-run-module}}\label{\detokenize{apidoc_commands/commands:module-commands.run}}\index{commands.run (module)}\index{Command (class in commands.run)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.run.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.run.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The run command runs the application launcher with the given arguments.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat run SALOME
+\end{DUlineblock}
+\index{getParser() (commands.run.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.run.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat run \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.run.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.run.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'run'}}}
+\end{fulllineitems}
+
+\index{run() (commands.run.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.run.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat run \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.script module}
+\label{\detokenize{apidoc_commands/commands:module-commands.script}}\label{\detokenize{apidoc_commands/commands:commands-script-module}}\index{commands.script (module)}\index{Command (class in commands.script)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.script.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The script command executes the script(s) of the the given products in the build directory.
+This is done only for the products that are constructed using a script (build\_source : ‘script’).
+Otherwise, nothing is done.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[]
+\begin{DUlineblock}{\DUlineblockindent}
+\item[] \textgreater{}\textgreater{} sat script SALOME \textendash{}products Python,numpy
+\end{DUlineblock}
+\end{DUlineblock}
+\index{getParser() (commands.script.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the command ‘sat script \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.script.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'script'}}}
+\end{fulllineitems}
+
+\index{run() (commands.script.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat script \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_products\_list() (in module commands.script)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.get_products_list}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.script.}}\sphinxbfcode{\sphinxupquote{get\_products\_list}}}{\emph{options}, \emph{cfg}, \emph{logger}}{}
+Gives the product list with their informations from 
+configuration regarding the passed options.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) 
+The Options instance that stores the commands arguments
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{cfg}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(list) The list of (product name, product\_informations).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_script\_all\_products() (in module commands.script)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.run_script_all_products}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.script.}}\sphinxbfcode{\sphinxupquote{run\_script\_all\_products}}}{\emph{config}, \emph{products\_infos}, \emph{nb\_proc}, \emph{logger}}{}
+Execute the script in each product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products\_info}} \textendash{} (list) 
+List of (str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{nb\_proc}} \textendash{} (int) The number of processors to use
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) The number of failing commands.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{run\_script\_of\_product() (in module commands.script)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.script.run_script_of_product}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.script.}}\sphinxbfcode{\sphinxupquote{run\_script\_of\_product}}}{\emph{p\_name\_info}, \emph{nb\_proc}, \emph{config}, \emph{logger}}{}
+Execute the proper configuration command(s) 
+in the product build directory.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{p\_name\_info}} \textendash{} (tuple) 
+(str, Config) =\textgreater{} (product\_name, product\_info)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{nb\_proc}} \textendash{} (int) The number of processors to use
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int) 1 if it fails, else 0.
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.shell module}
+\label{\detokenize{apidoc_commands/commands:module-commands.shell}}\label{\detokenize{apidoc_commands/commands:commands-shell-module}}\index{commands.shell (module)}\index{Command (class in commands.shell)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.shell.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.shell.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The shell command executes the shell command passed as argument.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat shell \textendash{}command ‘ls -lt /tmp’
+\end{DUlineblock}
+\index{getParser() (commands.shell.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.shell.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for the command ‘sat shell \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.shell.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.shell.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'shell'}}}
+\end{fulllineitems}
+
+\index{run() (commands.shell.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.shell.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat shell \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.source module}
+\label{\detokenize{apidoc_commands/commands:module-commands.source}}\label{\detokenize{apidoc_commands/commands:commands-source-module}}\index{commands.source (module)}\index{Command (class in commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The source command gets the sources of the application products
+from cvs, git or an archive.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat source SALOME \textendash{}products KERNEL,GUI
+\end{DUlineblock}
+\index{getParser() (commands.source.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat source \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.source.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'source'}}}
+\end{fulllineitems}
+
+\index{run() (commands.source.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat source \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{check\_sources() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.check_sources}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{check\_sources}}}{\emph{product\_info}, \emph{logger}}{}
+Check that the sources are correctly get, 
+using the files to be tested in product information
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to be used for the logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) 
+True if the files exists (or no files to test is provided).
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_all\_product\_sources() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_all_product_sources}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_all\_product\_sources}}}{\emph{config}, \emph{products}, \emph{logger}}{}
+Get all the product sources.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{products}} \textendash{} (list) 
+The list of tuples (product name, product informations)
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to be used for the logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(int,dict) 
+The tuple (number of success, dictionary product\_name/success\_fail)
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_product\_sources() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_product_sources}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_product\_sources}}}{\emph{config}, \emph{product\_info}, \emph{is\_dev}, \emph{source\_dir}, \emph{logger}, \emph{pad}, \emph{checkout=False}}{}
+Get the product sources.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{is\_dev}} \textendash{} (bool) True if the product is in development mode
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{source\_dir}} \textendash{} (Path) 
+The Path instance corresponding to the directory 
+where to put the sources
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{pad}} \textendash{} (int) The gap to apply for the terminal display
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{checkout}} \textendash{} (bool) If True, get the source in checkout mode
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if it succeed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_source\_for\_dev() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_source_for_dev}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_source\_for\_dev}}}{\emph{config}, \emph{product\_info}, \emph{source\_dir}, \emph{logger}, \emph{pad}}{}
+Called if the product is in development mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{source\_dir}} \textendash{} (Path)
+The Path instance corresponding to the directory where to put the sources
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger)
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{pad}} \textendash{} (int) The gap to apply for the terminal display
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if it succeed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_source\_from\_archive() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_source_from_archive}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_source\_from\_archive}}}{\emph{product\_info}, \emph{source\_dir}, \emph{logger}}{}
+The method called if the product is to be get in archive mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to 
+the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{source\_dir}} \textendash{} (Path)
+The Path instance corresponding to the directory
+where to put the sources
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if it succeed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_source\_from\_cvs() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_source_from_cvs}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_source\_from\_cvs}}}{\emph{user}, \emph{product\_info}, \emph{source\_dir}, \emph{checkout}, \emph{logger}, \emph{pad}, \emph{environ=None}}{}
+The method called if the product is to be get in cvs mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{user}} \textendash{} (str) The user to use in for the cvs command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{source\_dir}} \textendash{} (Path) 
+The Path instance corresponding to the directory 
+where to put the sources
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{checkout}} \textendash{} (bool) If True, get the source in checkout mode
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{pad}} \textendash{} (int) The gap to apply for the terminal display
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environ}} \textendash{} (src.environment.Environ) 
+The environment to source when extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if it succeed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_source\_from\_dir() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_source_from_dir}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_source\_from\_dir}}}{\emph{product\_info}, \emph{source\_dir}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{get\_source\_from\_git() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_source_from_git}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_source\_from\_git}}}{\emph{product\_info}, \emph{source\_dir}, \emph{logger}, \emph{pad}, \emph{is\_dev=False}, \emph{environ=None}}{}
+Called if the product is to be get in git mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config) 
+The configuration specific to the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{source\_dir}} \textendash{} (Path)
+The Path instance corresponding to the
+directory where to put the sources
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{Logger}} (\sphinxstyleliteralemphasis{\sphinxupquote{logger}}) \textendash{} (Logger) 
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{pad}} \textendash{} (int) The gap to apply for the terminal display
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{is\_dev}} \textendash{} (bool) True if the product is in development mode
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environ}} \textendash{} (src.environment.Environ)
+The environment to source when extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if it succeed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{get\_source\_from\_svn() (in module commands.source)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.source.get_source_from_svn}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.source.}}\sphinxbfcode{\sphinxupquote{get\_source\_from\_svn}}}{\emph{user}, \emph{product\_info}, \emph{source\_dir}, \emph{checkout}, \emph{logger}, \emph{environ=None}}{}
+The method called if the product is to be get in svn mode
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{user}} \textendash{} (str) The user to use in for the svn command
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{product\_info}} \textendash{} (Config)
+The configuration specific to the product to be prepared
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{source\_dir}} \textendash{} (Path)
+The Path instance corresponding to the directory 
+where to put the sources
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{checkout}} \textendash{} (boolean) 
+If True, get the source in checkout mode
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{logger}} \textendash{} (Logger)
+The logger instance to use for the display and logging
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{environ}} \textendash{} (src.environment.Environ)
+The environment to source when extracting.
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(bool) True if it succeed, else False
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.template module}
+\label{\detokenize{apidoc_commands/commands:module-commands.template}}\label{\detokenize{apidoc_commands/commands:commands-template-module}}\index{commands.template (module)}\index{Command (class in commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The template command creates the sources for a SALOME module from a template.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat template \textendash{}name my\_product\_name \textendash{}template PythonComponent \textendash{}target /tmp
+\end{DUlineblock}
+\index{getParser() (commands.template.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat template \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.template.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'template'}}}
+\end{fulllineitems}
+
+\index{run() (commands.template.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat template \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{TParam (class in commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TParam}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{TParam}}}{\emph{param\_def}, \emph{compo\_name}, \emph{dico=None}}{}~\index{check\_value() (commands.template.TParam method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TParam.check_value}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check\_value}}}{\emph{val}}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{TemplateSettings (class in commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TemplateSettings}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{TemplateSettings}}}{\emph{compo\_name}, \emph{settings\_file}, \emph{target}}{}~\index{check\_file\_for\_substitution() (commands.template.TemplateSettings method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TemplateSettings.check_file_for_substitution}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check\_file\_for\_substitution}}}{\emph{file\_}}{}
+\end{fulllineitems}
+
+\index{check\_user\_values() (commands.template.TemplateSettings method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TemplateSettings.check_user_values}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check\_user\_values}}}{\emph{values}}{}
+\end{fulllineitems}
+
+\index{get\_parameters() (commands.template.TemplateSettings method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TemplateSettings.get_parameters}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_parameters}}}{\emph{conf\_values=None}}{}
+\end{fulllineitems}
+
+\index{get\_pyconf\_parameters() (commands.template.TemplateSettings method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TemplateSettings.get_pyconf_parameters}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_pyconf\_parameters}}}{}{}
+\end{fulllineitems}
+
+\index{has\_pyconf() (commands.template.TemplateSettings method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.TemplateSettings.has_pyconf}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{has\_pyconf}}}{}{}
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{get\_dico\_param() (in module commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.get_dico_param}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{get\_dico\_param}}}{\emph{dico}, \emph{key}, \emph{default}}{}
+\end{fulllineitems}
+
+\index{get\_template\_info() (in module commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.get_template_info}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{get\_template\_info}}}{\emph{config}, \emph{template\_name}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{prepare\_from\_template() (in module commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.prepare_from_template}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{prepare\_from\_template}}}{\emph{config}, \emph{name}, \emph{template}, \emph{target\_dir}, \emph{conf\_values}, \emph{logger}}{}
+Prepares a module from a template.
+
+\end{fulllineitems}
+
+\index{search\_template() (in module commands.template)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.template.search_template}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.template.}}\sphinxbfcode{\sphinxupquote{search\_template}}}{\emph{config}, \emph{template}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{commands.test module}
+\label{\detokenize{apidoc_commands/commands:commands-test-module}}\label{\detokenize{apidoc_commands/commands:module-commands.test}}\index{commands.test (module)}\index{Command (class in commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.Command}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class }}\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{Command}}}{\emph{runner}}{}
+Bases: \sphinxcode{\sphinxupquote{src.salomeTools.\_BaseCommand}}
+
+The test command runs a test base on a SALOME installation.
+
+\begin{DUlineblock}{0em}
+\item[] examples:
+\item[] \textgreater{}\textgreater{} sat test SALOME \textendash{}grid GEOM \textendash{}session light
+\end{DUlineblock}
+\index{check\_option() (commands.test.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.Command.check_option}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{check\_option}}}{\emph{options}}{}
+Check the options
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode
+\sphinxstyleliteralstrong{\sphinxupquote{options}} \textendash{} (Options) The options
+
+\item[{Returns}] \leavevmode
+None
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{getParser() (commands.test.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.Command.getParser}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{getParser}}}{}{}
+Define all options for command ‘sat test \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+\index{name (commands.test.Command attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.Command.name}}\pysigline{\sphinxbfcode{\sphinxupquote{name}}\sphinxbfcode{\sphinxupquote{ = 'test'}}}
+\end{fulllineitems}
+
+\index{run() (commands.test.Command method)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.Command.run}}\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{run}}}{\emph{cmd\_arguments}}{}
+method called for command ‘sat test \textless{}options\textgreater{}’
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+\index{ask\_a\_path() (in module commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.ask_a_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{ask\_a\_path}}}{}{}
+interactive as using ‘raw\_input’
+
+\end{fulllineitems}
+
+\index{check\_remote\_machine() (in module commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.check_remote_machine}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{check\_remote\_machine}}}{\emph{machine\_name}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{create\_test\_report() (in module commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.create_test_report}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{create\_test\_report}}}{\emph{config}, \emph{xml\_history\_path}, \emph{dest\_path}, \emph{retcode}, \emph{xmlname=''}}{}
+Creates the XML report for a product.
+
+\end{fulllineitems}
+
+\index{generate\_history\_xml\_path() (in module commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.generate_history_xml_path}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{generate\_history\_xml\_path}}}{\emph{config}, \emph{test\_base}}{}
+Generate the name of the xml file that contain the history of the tests
+on the machine with the current APPLICATION and the current test base.
+\begin{quote}\begin{description}
+\item[{Parameters}] \leavevmode\begin{itemize}
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{config}} \textendash{} (Config) The global configuration
+
+\item {} 
+\sphinxstyleliteralstrong{\sphinxupquote{test\_base}} \textendash{} (str) The test base name (or path)
+
+\end{itemize}
+
+\item[{Returns}] \leavevmode
+(str) the full path of the history xml file
+
+\end{description}\end{quote}
+
+\end{fulllineitems}
+
+\index{move\_test\_results() (in module commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.move_test_results}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{move\_test\_results}}}{\emph{in\_dir}, \emph{what}, \emph{out\_dir}, \emph{logger}}{}
+\end{fulllineitems}
+
+\index{save\_file() (in module commands.test)}
+
+\begin{fulllineitems}
+\phantomsection\label{\detokenize{apidoc_commands/commands:commands.test.save_file}}\pysiglinewithargsret{\sphinxcode{\sphinxupquote{commands.test.}}\sphinxbfcode{\sphinxupquote{save\_file}}}{\emph{filename}, \emph{base}}{}
+\end{fulllineitems}
+
+
+
+\subsubsection{Module contents}
+\label{\detokenize{apidoc_commands/commands:module-commands}}\label{\detokenize{apidoc_commands/commands:module-contents}}\index{commands (module)}
+
+\chapter{Release Notes}
+\label{\detokenize{index:release-notes}}
+
+\section{Release notes}
+\label{\detokenize{release_notes/release_notes_5.0.0:release-notes}}\label{\detokenize{release_notes/release_notes_5.0.0::doc}}
+In construction.
+
+
+\renewcommand{\indexname}{Python Module Index}
+\begin{sphinxtheindex}
+\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
+\bigletter{c}
+\item {\sphinxstyleindexentry{commands}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands}}
+\item {\sphinxstyleindexentry{commands.application}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.application}}
+\item {\sphinxstyleindexentry{commands.check}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.check}}
+\item {\sphinxstyleindexentry{commands.clean}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.clean}}
+\item {\sphinxstyleindexentry{commands.compile}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.compile}}
+\item {\sphinxstyleindexentry{commands.config}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.config}}
+\item {\sphinxstyleindexentry{commands.configure}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.configure}}
+\item {\sphinxstyleindexentry{commands.environ}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.environ}}
+\item {\sphinxstyleindexentry{commands.find\_duplicates}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.find_duplicates}}
+\item {\sphinxstyleindexentry{commands.generate}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.generate}}
+\item {\sphinxstyleindexentry{commands.init}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.init}}
+\item {\sphinxstyleindexentry{commands.job}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.job}}
+\item {\sphinxstyleindexentry{commands.jobs}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.jobs}}
+\item {\sphinxstyleindexentry{commands.launcher}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.launcher}}
+\item {\sphinxstyleindexentry{commands.log}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.log}}
+\item {\sphinxstyleindexentry{commands.make}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.make}}
+\item {\sphinxstyleindexentry{commands.makeinstall}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.makeinstall}}
+\item {\sphinxstyleindexentry{commands.package}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.package}}
+\item {\sphinxstyleindexentry{commands.patch}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.patch}}
+\item {\sphinxstyleindexentry{commands.prepare}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.prepare}}
+\item {\sphinxstyleindexentry{commands.profile}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.profile}}
+\item {\sphinxstyleindexentry{commands.run}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.run}}
+\item {\sphinxstyleindexentry{commands.script}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.script}}
+\item {\sphinxstyleindexentry{commands.shell}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.shell}}
+\item {\sphinxstyleindexentry{commands.source}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.source}}
+\item {\sphinxstyleindexentry{commands.template}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.template}}
+\item {\sphinxstyleindexentry{commands.test}}\sphinxstyleindexpageref{apidoc_commands/commands:\detokenize{module-commands.test}}
+\indexspace
+\bigletter{s}
+\item {\sphinxstyleindexentry{src}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src}}
+\item {\sphinxstyleindexentry{src.architecture}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.architecture}}
+\item {\sphinxstyleindexentry{src.catchAll}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.catchAll}}
+\item {\sphinxstyleindexentry{src.colorama}}\sphinxstyleindexpageref{apidoc_src/src.colorama:\detokenize{module-src.colorama}}
+\item {\sphinxstyleindexentry{src.colorama.ansi}}\sphinxstyleindexpageref{apidoc_src/src.colorama:\detokenize{module-src.colorama.ansi}}
+\item {\sphinxstyleindexentry{src.colorama.ansitowin32}}\sphinxstyleindexpageref{apidoc_src/src.colorama:\detokenize{module-src.colorama.ansitowin32}}
+\item {\sphinxstyleindexentry{src.colorama.initialise}}\sphinxstyleindexpageref{apidoc_src/src.colorama:\detokenize{module-src.colorama.initialise}}
+\item {\sphinxstyleindexentry{src.colorama.win32}}\sphinxstyleindexpageref{apidoc_src/src.colorama:\detokenize{module-src.colorama.win32}}
+\item {\sphinxstyleindexentry{src.colorama.winterm}}\sphinxstyleindexpageref{apidoc_src/src.colorama:\detokenize{module-src.colorama.winterm}}
+\item {\sphinxstyleindexentry{src.coloringSat}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.coloringSat}}
+\item {\sphinxstyleindexentry{src.compilation}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.compilation}}
+\item {\sphinxstyleindexentry{src.configManager}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.configManager}}
+\item {\sphinxstyleindexentry{src.debug}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.debug}}
+\item {\sphinxstyleindexentry{src.ElementTree}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.ElementTree}}
+\item {\sphinxstyleindexentry{src.environment}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.environment}}
+\item {\sphinxstyleindexentry{src.environs}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.environs}}
+\item {\sphinxstyleindexentry{src.example}}\sphinxstyleindexpageref{apidoc_src/src.example:\detokenize{module-src.example}}
+\item {\sphinxstyleindexentry{src.example.essai\_logging\_1}}\sphinxstyleindexpageref{apidoc_src/src.example:\detokenize{module-src.example.essai_logging_1}}
+\item {\sphinxstyleindexentry{src.example.essai\_logging\_2}}\sphinxstyleindexpageref{apidoc_src/src.example:\detokenize{module-src.example.essai_logging_2}}
+\item {\sphinxstyleindexentry{src.exceptionSat}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.exceptionSat}}
+\item {\sphinxstyleindexentry{src.fileEnviron}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.fileEnviron}}
+\item {\sphinxstyleindexentry{src.fork}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.fork}}
+\item {\sphinxstyleindexentry{src.loggingSat}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.loggingSat}}
+\item {\sphinxstyleindexentry{src.options}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.options}}
+\item {\sphinxstyleindexentry{src.product}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.product}}
+\item {\sphinxstyleindexentry{src.pyconf}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.pyconf}}
+\item {\sphinxstyleindexentry{src.returnCode}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.returnCode}}
+\item {\sphinxstyleindexentry{src.salomeTools}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.salomeTools}}
+\item {\sphinxstyleindexentry{src.system}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.system}}
+\item {\sphinxstyleindexentry{src.template}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.template}}
+\item {\sphinxstyleindexentry{src.test\_module}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.test_module}}
+\item {\sphinxstyleindexentry{src.utilsSat}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.utilsSat}}
+\item {\sphinxstyleindexentry{src.xmlManager}}\sphinxstyleindexpageref{apidoc_src/src:\detokenize{module-src.xmlManager}}
+\end{sphinxtheindex}
+
+\renewcommand{\indexname}{Index}
+\printindex
+\end{document}
\ No newline at end of file
diff --git a/doc/build/latex/salomeTools.toc b/doc/build/latex/salomeTools.toc
new file mode 100644
index 0000000..8054d93
--- /dev/null
+++ b/doc/build/latex/salomeTools.toc
@@ -0,0 +1,148 @@
+\babel@toc {english}{}
+\contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}
+\contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}
+\contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}
+\contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}
+\contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}
+\contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}
+\contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}
+\contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}
+\contentsline {subsubsection}{USER section}{4}{subsubsection*.6}
+\contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{5}{section.1.3}
+\contentsline {subsection}{\numberline {1.3.1}Usage}{5}{subsection.1.3.1}
+\contentsline {subsubsection}{Options of sat}{5}{subsubsection*.7}
+\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}help or -h}}{5}{paragraph*.8}
+\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}debug or -g}}{5}{paragraph*.9}
+\contentsline {paragraph}{\sphinxstyleemphasis {\textendash {}verbose or -v}}{5}{paragraph*.10}
+\contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}
+\contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}
+\contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}
+\contentsline {subsubsection}{Compile SALOME}{6}{subsubsection*.13}
+\contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}
+\contentsline {section}{\numberline {2.1}Command config}{8}{section.2.1}
+\contentsline {subsection}{\numberline {2.1.1}Description}{8}{subsection.2.1.1}
+\contentsline {subsection}{\numberline {2.1.2}Usage}{8}{subsection.2.1.2}
+\contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{9}{subsection.2.1.3}
+\contentsline {section}{\numberline {2.2}Command prepare}{10}{section.2.2}
+\contentsline {subsection}{\numberline {2.2.1}Description}{10}{subsection.2.2.1}
+\contentsline {subsection}{\numberline {2.2.2}Remarks}{10}{subsection.2.2.2}
+\contentsline {subsubsection}{VCS bases (git, svn, cvs)}{10}{subsubsection*.14}
+\contentsline {subsubsection}{Dev mode}{10}{subsubsection*.15}
+\contentsline {subsection}{\numberline {2.2.3}Usage}{10}{subsection.2.2.3}
+\contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{11}{subsection.2.2.4}
+\contentsline {section}{\numberline {2.3}Command compile}{12}{section.2.3}
+\contentsline {subsection}{\numberline {2.3.1}Description}{12}{subsection.2.3.1}
+\contentsline {subsection}{\numberline {2.3.2}Usage}{12}{subsection.2.3.2}
+\contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{13}{subsection.2.3.3}
+\contentsline {section}{\numberline {2.4}Command launcher}{14}{section.2.4}
+\contentsline {subsection}{\numberline {2.4.1}Description}{14}{subsection.2.4.1}
+\contentsline {subsection}{\numberline {2.4.2}Usage}{14}{subsection.2.4.2}
+\contentsline {subsection}{\numberline {2.4.3}Configuration}{14}{subsection.2.4.3}
+\contentsline {section}{\numberline {2.5}Command application}{15}{section.2.5}
+\contentsline {subsection}{\numberline {2.5.1}Description}{15}{subsection.2.5.1}
+\contentsline {subsection}{\numberline {2.5.2}Usage}{15}{subsection.2.5.2}
+\contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{15}{subsection.2.5.3}
+\contentsline {section}{\numberline {2.6}Command log}{16}{section.2.6}
+\contentsline {subsection}{\numberline {2.6.1}Description}{16}{subsection.2.6.1}
+\contentsline {subsection}{\numberline {2.6.2}Usage}{16}{subsection.2.6.2}
+\contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{16}{subsection.2.6.3}
+\contentsline {section}{\numberline {2.7}Command environ}{17}{section.2.7}
+\contentsline {subsection}{\numberline {2.7.1}Description}{17}{subsection.2.7.1}
+\contentsline {subsection}{\numberline {2.7.2}Usage}{17}{subsection.2.7.2}
+\contentsline {subsection}{\numberline {2.7.3}Configuration}{17}{subsection.2.7.3}
+\contentsline {section}{\numberline {2.8}Command clean}{20}{section.2.8}
+\contentsline {subsection}{\numberline {2.8.1}Description}{20}{subsection.2.8.1}
+\contentsline {subsection}{\numberline {2.8.2}Usage}{20}{subsection.2.8.2}
+\contentsline {subsection}{\numberline {2.8.3}Availables options}{20}{subsection.2.8.3}
+\contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{20}{subsection.2.8.4}
+\contentsline {section}{\numberline {2.9}Command package}{21}{section.2.9}
+\contentsline {subsection}{\numberline {2.9.1}Description}{21}{subsection.2.9.1}
+\contentsline {subsection}{\numberline {2.9.2}Usage}{21}{subsection.2.9.2}
+\contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{22}{subsection.2.9.3}
+\contentsline {section}{\numberline {2.10}Command generate}{23}{section.2.10}
+\contentsline {subsection}{\numberline {2.10.1}Description}{23}{subsection.2.10.1}
+\contentsline {subsection}{\numberline {2.10.2}Remarks}{23}{subsection.2.10.2}
+\contentsline {subsection}{\numberline {2.10.3}Usage}{23}{subsection.2.10.3}
+\contentsline {chapter}{\numberline {3}Developer documentation}{25}{chapter.3}
+\contentsline {section}{\numberline {3.1}Add a user custom command}{26}{section.3.1}
+\contentsline {subsection}{\numberline {3.1.1}Introduction}{26}{subsection.3.1.1}
+\contentsline {subsection}{\numberline {3.1.2}Basic requirements}{26}{subsection.3.1.2}
+\contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{27}{subsection.3.1.3}
+\contentsline {subsection}{\numberline {3.1.4}HowTo logger}{27}{subsection.3.1.4}
+\contentsline {subsection}{\numberline {3.1.5}HELLO example}{27}{subsection.3.1.5}
+\contentsline {chapter}{\numberline {4}Code documentation}{29}{chapter.4}
+\contentsline {section}{\numberline {4.1}src}{29}{section.4.1}
+\contentsline {subsection}{\numberline {4.1.1}src package}{29}{subsection.4.1.1}
+\contentsline {subsubsection}{Subpackages}{29}{subsubsection*.16}
+\contentsline {paragraph}{src.colorama package}{29}{paragraph*.17}
+\contentsline {subparagraph}{Submodules}{29}{subparagraph*.18}
+\contentsline {subparagraph}{src.colorama.ansi module}{29}{subparagraph*.19}
+\contentsline {subparagraph}{src.colorama.ansitowin32 module}{31}{subparagraph*.72}
+\contentsline {subparagraph}{src.colorama.initialise module}{31}{subparagraph*.90}
+\contentsline {subparagraph}{src.colorama.win32 module}{32}{subparagraph*.97}
+\contentsline {subparagraph}{src.colorama.winterm module}{32}{subparagraph*.100}
+\contentsline {subparagraph}{Module contents}{33}{subparagraph*.128}
+\contentsline {paragraph}{src.example package}{33}{paragraph*.129}
+\contentsline {subparagraph}{Submodules}{33}{subparagraph*.130}
+\contentsline {subparagraph}{src.example.essai\_logging\_1 module}{33}{subparagraph*.131}
+\contentsline {subparagraph}{src.example.essai\_logging\_2 module}{33}{subparagraph*.135}
+\contentsline {subparagraph}{Module contents}{34}{subparagraph*.141}
+\contentsline {subsubsection}{Submodules}{34}{subsubsection*.142}
+\contentsline {subsubsection}{src.ElementTree module}{34}{subsubsection*.143}
+\contentsline {subsubsection}{src.architecture module}{35}{subsubsection*.175}
+\contentsline {subsubsection}{src.catchAll module}{35}{subsubsection*.182}
+\contentsline {subsubsection}{src.coloringSat module}{36}{subsubsection*.188}
+\contentsline {subsubsection}{src.compilation module}{36}{subsubsection*.198}
+\contentsline {subsubsection}{src.configManager module}{37}{subsubsection*.217}
+\contentsline {subsubsection}{src.debug module}{39}{subsubsection*.234}
+\contentsline {subsubsection}{src.environment module}{40}{subsubsection*.250}
+\contentsline {subsubsection}{src.environs module}{44}{subsubsection*.288}
+\contentsline {subsubsection}{src.exceptionSat module}{44}{subsubsection*.292}
+\contentsline {subsubsection}{src.fileEnviron module}{44}{subsubsection*.294}
+\contentsline {subsubsection}{src.fork module}{49}{subsubsection*.359}
+\contentsline {subsubsection}{src.loggingSat module}{50}{subsubsection*.365}
+\contentsline {subsubsection}{src.options module}{51}{subsubsection*.385}
+\contentsline {subsubsection}{src.product module}{52}{subsubsection*.394}
+\contentsline {subsubsection}{src.pyconf module}{55}{subsubsection*.424}
+\contentsline {subsubsection}{src.returnCode module}{63}{subsubsection*.496}
+\contentsline {subsubsection}{src.salomeTools module}{64}{subsubsection*.519}
+\contentsline {subsubsection}{src.system module}{65}{subsubsection*.540}
+\contentsline {subsubsection}{src.template module}{66}{subsubsection*.546}
+\contentsline {subsubsection}{src.test\_module module}{66}{subsubsection*.551}
+\contentsline {subsubsection}{src.utilsSat module}{67}{subsubsection*.571}
+\contentsline {subsubsection}{src.xmlManager module}{70}{subsubsection*.638}
+\contentsline {subsubsection}{Module contents}{72}{subsubsection*.652}
+\contentsline {section}{\numberline {4.2}commands}{72}{section.4.2}
+\contentsline {subsection}{\numberline {4.2.1}commands package}{72}{subsection.4.2.1}
+\contentsline {subsubsection}{Submodules}{72}{subsubsection*.653}
+\contentsline {subsubsection}{commands.application module}{72}{subsubsection*.654}
+\contentsline {subsubsection}{commands.check module}{73}{subsubsection*.669}
+\contentsline {subsubsection}{commands.clean module}{74}{subsubsection*.677}
+\contentsline {subsubsection}{commands.compile module}{75}{subsubsection*.687}
+\contentsline {subsubsection}{commands.config module}{77}{subsubsection*.705}
+\contentsline {subsubsection}{commands.configure module}{77}{subsubsection*.710}
+\contentsline {subsubsection}{commands.environ module}{78}{subsubsection*.718}
+\contentsline {subsubsection}{commands.find\_duplicates module}{79}{subsubsection*.724}
+\contentsline {subsubsection}{commands.generate module}{80}{subsubsection*.733}
+\contentsline {subsubsection}{commands.init module}{81}{subsubsection*.743}
+\contentsline {subsubsection}{commands.job module}{81}{subsubsection*.751}
+\contentsline {subsubsection}{commands.jobs module}{82}{subsubsection*.756}
+\contentsline {subsubsection}{commands.launcher module}{86}{subsubsection*.813}
+\contentsline {subsubsection}{commands.log module}{87}{subsubsection*.821}
+\contentsline {subsubsection}{commands.make module}{88}{subsubsection*.833}
+\contentsline {subsubsection}{commands.makeinstall module}{89}{subsubsection*.842}
+\contentsline {subsubsection}{commands.package module}{90}{subsubsection*.850}
+\contentsline {subsubsection}{commands.patch module}{94}{subsubsection*.874}
+\contentsline {subsubsection}{commands.prepare module}{95}{subsubsection*.880}
+\contentsline {subsubsection}{commands.profile module}{95}{subsubsection*.888}
+\contentsline {subsubsection}{commands.run module}{96}{subsubsection*.899}
+\contentsline {subsubsection}{commands.script module}{96}{subsubsection*.904}
+\contentsline {subsubsection}{commands.shell module}{97}{subsubsection*.912}
+\contentsline {subsubsection}{commands.source module}{98}{subsubsection*.917}
+\contentsline {subsubsection}{commands.template module}{100}{subsubsection*.931}
+\contentsline {subsubsection}{commands.test module}{101}{subsubsection*.948}
+\contentsline {subsubsection}{Module contents}{101}{subsubsection*.960}
+\contentsline {chapter}{\numberline {5}Release Notes}{103}{chapter.5}
+\contentsline {section}{\numberline {5.1}Release notes}{103}{section.5.1}
+\contentsline {chapter}{Python Module Index}{105}{section*.961}
+\contentsline {chapter}{Index}{107}{section*.962}
diff --git a/doc/build/latex/sat_about.png b/doc/build/latex/sat_about.png
new file mode 100644
index 0000000..600d3d8
Binary files /dev/null and b/doc/build/latex/sat_about.png differ
diff --git a/doc/build/latex/sphinx.sty b/doc/build/latex/sphinx.sty
new file mode 100644
index 0000000..e323b2a
--- /dev/null
+++ b/doc/build/latex/sphinx.sty
@@ -0,0 +1,1648 @@
+%
+% sphinx.sty
+%
+% Adapted from the old python.sty, mostly written by Fred Drake,
+% by Georg Brandl.
+%
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesPackage{sphinx}[2018/03/11 v1.7.2 LaTeX package (Sphinx markup)]
+
+% provides \ltx@ifundefined
+% (many packages load ltxcmds: graphicx does for pdftex and lualatex but
+% not xelatex, and anyhow kvoptions does, but it may be needed in future to
+% use \sphinxdeprecationwarning earlier, and it needs \ltx@ifundefined)
+\RequirePackage{ltxcmds}
+
+%% for deprecation warnings
+\newcommand\sphinxdeprecationwarning[4]{% #1 the deprecated macro or name,
+% #2 = when deprecated, #3 = when removed, #4 = additional info
+  \edef\spx@tempa{\detokenize{#1}}%
+  \ltx@ifundefined{sphinx_depr_\spx@tempa}{%
+     \global\expandafter\let\csname sphinx_depr_\spx@tempa\endcsname\spx@tempa
+     \expandafter\AtEndDocument\expandafter{\expandafter\let\expandafter
+         \sphinxdeprecatedmacro\csname sphinx_depr_\spx@tempa\endcsname
+         \PackageWarningNoLine{sphinx}{^^J**** SPHINX DEPRECATION WARNING:^^J
+         \sphinxdeprecatedmacro^^J
+         \@spaces- is deprecated at Sphinx #2^^J
+         \@spaces- and removed at Sphinx #3.^^J
+         #4^^J****}}%
+  }{% warning already emitted (at end of latex log), don't repeat
+  }}
+
+
+%% PACKAGES
+%
+% we delay handling of options to after having loaded packages, because
+% of the need to use \definecolor.
+\RequirePackage{graphicx}
+\@ifclassloaded{memoir}{}{\RequirePackage{fancyhdr}}
+% for \text macro and \iffirstchoice@ conditional even if amsmath not loaded
+\RequirePackage{amstext}
+\RequirePackage{textcomp}% "warn" option issued from template
+\RequirePackage{titlesec}
+\@ifpackagelater{titlesec}{2016/03/15}%
+ {\@ifpackagelater{titlesec}{2016/03/21}%
+  {}%
+  {\newif\ifsphinx@ttlpatch@ok
+   \IfFileExists{etoolbox.sty}{%
+     \RequirePackage{etoolbox}%
+     \patchcmd{\ttlh@hang}{\parindent\z@}{\parindent\z@\leavevmode}%
+                                {\sphinx@ttlpatch@oktrue}{}%
+     \ifsphinx@ttlpatch@ok
+     \patchcmd{\ttlh@hang}{\noindent}{}{}{\sphinx@ttlpatch@okfalse}%
+     \fi
+   }{}%
+   \ifsphinx@ttlpatch@ok
+     \typeout{^^J Package Sphinx Info: ^^J
+              **** titlesec 2.10.1 successfully patched for bugfix ****^^J}%
+   \else
+     \AtEndDocument{\PackageWarningNoLine{sphinx}{^^J%
+******** titlesec 2.10.1 has a bug, (section numbers disappear) ......|^^J%
+******** and Sphinx could not patch it, perhaps because your local ...|^^J%
+******** copy is already fixed without a changed release date. .......|^^J%
+******** If not, you must update titlesec! ...........................|}}%
+   \fi
+  }%
+ }{}
+\RequirePackage{tabulary}
+% tabulary has a bug with its re-definition of \multicolumn in its first pass
+% which is not \long. But now Sphinx does not use LaTeX's \multicolumn but its
+% own macro. Hence we don't even need to patch tabulary. See sphinxmulticell.sty
+% X or S (Sphinx) may have meanings if some table package is loaded hence
+% \X was chosen to avoid possibility of conflict
+\newcolumntype{\X}[2]{p{\dimexpr
+      (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}}
+\newcolumntype{\Y}[1]{p{\dimexpr
+      #1\dimexpr\linewidth-\arrayrulewidth\relax-\tw@\tabcolsep-\arrayrulewidth\relax}}
+% using here T (for Tabulary) feels less of a problem than the X could be
+\newcolumntype{T}{J}%
+% For tables allowing pagebreaks
+\RequirePackage{longtable}
+% User interface to set-up whitespace before and after tables:
+\newcommand*\sphinxtablepre {0pt}%
+\newcommand*\sphinxtablepost{\medskipamount}%
+\newcommand*\sphinxbelowcaptionspace{.5\sphinxbaselineskip}%
+% as one can not use \baselineskip from inside longtable (it is zero there)
+% we need \sphinxbaselineskip, which defaults to \baselineskip
+\def\sphinxbaselineskip{\baselineskip}%
+% These commands are inserted by the table templates
+\def\sphinxatlongtablestart
+   {\par
+    \vskip\parskip
+    \vskip\dimexpr\sphinxtablepre\relax % adjust vertical position
+    \vbox{}% get correct baseline from above
+    \LTpre\z@skip\LTpost\z@skip % set to zero longtable's own skips
+    \edef\sphinxbaselineskip{\dimexpr\the\dimexpr\baselineskip\relax\relax}%
+   }%
+\def\sphinxatlongtableend{\prevdepth\z@\vskip\sphinxtablepost\relax}%
+\def\sphinxlongtablecapskipadjust
+   {\dimexpr-\dp\strutbox-\sphinxbaselineskip+\sphinxbelowcaptionspace\relax}%
+% Now for tables not using longtable
+\def\sphinxattablestart
+   {\par
+    \vskip\dimexpr\sphinxtablepre\relax
+   }%
+\let\sphinxattableend\sphinxatlongtableend
+% longtable's wraps captions to a maximal width of \LTcapwidth
+% so we do the same for all tables
+\newcommand*\sphinxcapstartof[1]{%
+   \vskip\parskip
+   \vbox{}% force baselineskip for good positioning by capstart of hyperanchor
+   \def\@captype{#1}%
+   \capstart
+% move back vertically to compensate space inserted by next paragraph
+   \vskip-\baselineskip\vskip-\parskip
+}%
+% use \LTcapwidth (default is 4in) to wrap caption (if line width is bigger)
+\newcommand\sphinxcaption[2][\LTcapwidth]{%
+   \noindent\hb@xt@\linewidth{\hss
+      \vtop{\@tempdima\dimexpr#1\relax
+% don't exceed linewidth for the caption width
+            \ifdim\@tempdima>\linewidth\hsize\linewidth\else\hsize\@tempdima\fi
+% longtable ignores \abovecaptionskip/\belowcaptionskip, so add hooks here
+% to uniformize control of caption distance to tables
+            \abovecaptionskip\sphinxabovecaptionskip
+            \belowcaptionskip\sphinxbelowcaptionskip
+            \caption[{#2}]%
+               {\strut\ignorespaces#2\ifhmode\unskip\@finalstrut\strutbox\fi}%
+           }\hss}%
+   \par\prevdepth\dp\strutbox
+}%
+\def\spx@abovecaptionskip{\abovecaptionskip}
+\newcommand*\sphinxabovecaptionskip{\z@skip}
+\newcommand*\sphinxbelowcaptionskip{\z@skip}
+
+\newcommand\sphinxaftercaption
+{% this default definition serves with a caption *above* a table, to make sure
+ % its last baseline is \sphinxbelowcaptionspace above table top
+ \nobreak
+   \vskip\dimexpr\sphinxbelowcaptionspace\relax
+   \vskip-\baselineskip\vskip-\parskip
+}%
+% varwidth is crucial for our handling of general contents in merged cells
+\RequirePackage{varwidth}
+% but addition of a compatibility patch with hyperref is needed
+% (tested with varwidth v 0.92  Mar 2009)
+\AtBeginDocument {%
+    \let\@@vwid@Hy@raisedlink\Hy@raisedlink
+    \long\def\@vwid@Hy@raisedlink#1{\@vwid@wrap{\@@vwid@Hy@raisedlink{#1}}}%
+    \edef\@vwid@setup{%
+      \let\noexpand\Hy@raisedlink\noexpand\@vwid@Hy@raisedlink % HYPERREF !
+      \unexpanded\expandafter{\@vwid@setup}}%
+}%
+% Homemade package to handle merged cells
+\RequirePackage{sphinxmulticell}
+\RequirePackage{makeidx}
+% For framing code-blocks and warning type notices, and shadowing topics
+\RequirePackage{framed}
+% The xcolor package draws better fcolorboxes around verbatim code
+\IfFileExists{xcolor.sty}{
+    \RequirePackage{xcolor}
+}{
+    \RequirePackage{color}
+}
+% For highlighted code.
+\RequirePackage{fancyvrb}
+\fvset{fontsize=\small}
+\define@key{FV}{hllines}{\def\sphinx@verbatim@checkifhl##1{\in@{, ##1,}{#1}}}
+% For hyperlinked footnotes in tables; also for gathering footnotes from
+% topic and warning blocks. Also to allow code-blocks in footnotes.
+\RequirePackage{footnotehyper-sphinx}
+% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code
+% for allowing figures in tables.
+\RequirePackage{float}
+% For floating figures in the text. Better to load after float.
+\RequirePackage{wrapfig}
+% Separate paragraphs by space by default.
+\RequirePackage{parskip}
+% For parsed-literal blocks.
+\RequirePackage{alltt}
+% Display "real" single quotes in literal blocks.
+\RequirePackage{upquote}
+% control caption around literal-block
+\RequirePackage{capt-of}
+\RequirePackage{needspace}
+\RequirePackage{remreset}% provides \@removefromreset
+% to make pdf with correct encoded bookmarks in Japanese
+% this should precede the hyperref package
+\ifx\kanjiskip\@undefined
+% for non-Japanese: make sure bookmarks are ok also with lualatex
+  \PassOptionsToPackage{pdfencoding=unicode}{hyperref}
+\else
+  \RequirePackage{atbegshi}
+  \ifx\ucs\@undefined
+    \ifnum 42146=\euc"A4A2
+      \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}
+    \else
+      \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}
+    \fi
+  \else
+    \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}
+  \fi
+\fi
+
+\ifx\@jsc@uplatextrue\@undefined\else
+  \PassOptionsToPackage{setpagesize=false}{hyperref}
+\fi
+
+% These options can be overriden inside  'hyperref' key
+% or by later use of \hypersetup.
+\PassOptionsToPackage{colorlinks,breaklinks,%
+ linkcolor=InnerLinkColor,filecolor=OuterLinkColor,%
+ menucolor=OuterLinkColor,urlcolor=OuterLinkColor,%
+ citecolor=InnerLinkColor}{hyperref}
+
+% stylesheet for highlighting with pygments
+\RequirePackage{sphinxhighlight}
+% fix baseline increase from Pygments latex formatter in case of error tokens
+% and keep \fboxsep's scope local via added braces
+\def\PYG@tok@err{%
+    \def\PYG@bc##1{{\setlength{\fboxsep}{-\fboxrule}%
+                    \fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}%
+}
+\def\PYG@tok@cs{%
+    \def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}%
+    \def\PYG@bc##1{{\setlength{\fboxsep}{0pt}%
+                    \colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}%
+}%
+
+
+%% OPTIONS
+%
+% Handle options via "kvoptions" (later loaded by hyperref anyhow)
+\RequirePackage{kvoptions}
+\SetupKeyvalOptions{prefix=spx@opt@} % use \spx@opt@ prefix
+
+% Sphinx legacy text layout: 1in margins on all four sides
+\ifx\@jsc@uplatextrue\@undefined
+\DeclareStringOption[1in]{hmargin}
+\DeclareStringOption[1in]{vmargin}
+\DeclareStringOption[.5in]{marginpar}
+\else
+% Japanese standard document classes handle \mag in a special way
+\DeclareStringOption[\inv@mag in]{hmargin}
+\DeclareStringOption[\inv@mag in]{vmargin}
+\DeclareStringOption[.5\dimexpr\inv@mag in\relax]{marginpar}
+\fi
+
+\DeclareStringOption[0]{maxlistdepth}% \newcommand*\spx@opt@maxlistdepth{0}
+\DeclareStringOption[-1]{numfigreset}
+\DeclareBoolOption[false]{nonumfigreset}
+\DeclareBoolOption[false]{mathnumfig}
+% \DeclareBoolOption[false]{usespart}% not used
+% dimensions, we declare the \dimen registers here.
+\newdimen\sphinxverbatimsep
+\newdimen\sphinxverbatimborder
+\newdimen\sphinxshadowsep
+\newdimen\sphinxshadowsize
+\newdimen\sphinxshadowrule
+% \DeclareStringOption is not convenient for the handling of these dimensions
+% because we want to assign the values to the corresponding registers. Even if
+% we added the code to the key handler it would be too late for the initial
+% set-up and we would need to do initial assignments explicitely. We end up
+% using \define@key directly.
+% verbatim
+\sphinxverbatimsep=\fboxsep
+  \define@key{sphinx}{verbatimsep}{\sphinxverbatimsep\dimexpr #1\relax}
+\sphinxverbatimborder=\fboxrule
+  \define@key{sphinx}{verbatimborder}{\sphinxverbatimborder\dimexpr #1\relax}
+% topic boxes
+\sphinxshadowsep =5pt
+  \define@key{sphinx}{shadowsep}{\sphinxshadowsep\dimexpr #1\relax}
+\sphinxshadowsize=4pt
+  \define@key{sphinx}{shadowsize}{\sphinxshadowsize\dimexpr #1\relax}
+\sphinxshadowrule=\fboxrule
+  \define@key{sphinx}{shadowrule}{\sphinxshadowrule\dimexpr #1\relax}
+% verbatim
+\DeclareBoolOption[true]{verbatimwithframe}
+\DeclareBoolOption[true]{verbatimwrapslines}
+\DeclareBoolOption[true]{verbatimhintsturnover}
+\DeclareBoolOption[true]{inlineliteralwraps}
+\DeclareStringOption[t]{literalblockcappos}
+\DeclareStringOption[r]{verbatimcontinuedalign}
+\DeclareStringOption[r]{verbatimcontinuesalign}
+% parsed literal
+\DeclareBoolOption[true]{parsedliteralwraps}
+% \textvisiblespace for compatibility with fontspec+XeTeX/LuaTeX
+\DeclareStringOption[\textcolor{red}{\textvisiblespace}]{verbatimvisiblespace}
+\DeclareStringOption % must use braces to hide the brackets
+  [{\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\m@th\hookrightarrow$}}}]%
+  {verbatimcontinued}
+% notices/admonitions
+% the dimensions for notices/admonitions are kept as macros and assigned to
+% \spx@notice@border at time of use, hence \DeclareStringOption is ok for this
+\newdimen\spx@notice@border
+\DeclareStringOption[0.5pt]{noteborder}
+\DeclareStringOption[0.5pt]{hintborder}
+\DeclareStringOption[0.5pt]{importantborder}
+\DeclareStringOption[0.5pt]{tipborder}
+\DeclareStringOption[1pt]{warningborder}
+\DeclareStringOption[1pt]{cautionborder}
+\DeclareStringOption[1pt]{attentionborder}
+\DeclareStringOption[1pt]{dangerborder}
+\DeclareStringOption[1pt]{errorborder}
+% footnotes
+\DeclareStringOption[\mbox{ }]{AtStartFootnote}
+% we need a public macro name for direct use in latex file
+\newcommand*{\sphinxAtStartFootnote}{\spx@opt@AtStartFootnote}
+% no such need for this one, as it is used inside other macros
+\DeclareStringOption[\leavevmode\unskip]{BeforeFootnote}
+% some font styling.
+\DeclareStringOption[\sffamily\bfseries]{HeaderFamily}
+% colours
+% same problems as for dimensions: we want the key handler to use \definecolor.
+% first, some colours with no prefix, for backwards compatibility
+\newcommand*{\sphinxDeclareColorOption}[2]{%
+   \definecolor{#1}#2%
+   \define@key{sphinx}{#1}{\definecolor{#1}##1}%
+}%
+\sphinxDeclareColorOption{TitleColor}{{rgb}{0.126,0.263,0.361}}
+\sphinxDeclareColorOption{InnerLinkColor}{{rgb}{0.208,0.374,0.486}}
+\sphinxDeclareColorOption{OuterLinkColor}{{rgb}{0.216,0.439,0.388}}
+\sphinxDeclareColorOption{VerbatimColor}{{rgb}{1,1,1}}
+\sphinxDeclareColorOption{VerbatimBorderColor}{{rgb}{0,0,0}}
+% now the colours defined with "sphinx" prefix in their names
+\newcommand*{\sphinxDeclareSphinxColorOption}[2]{%
+   % set the initial default
+   \definecolor{sphinx#1}#2%
+   % set the key handler. The "value" ##1 must be acceptable by \definecolor.
+   \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}%
+}%
+% Default color chosen to be as in minted.sty LaTeX package!
+\sphinxDeclareSphinxColorOption{VerbatimHighlightColor}{{rgb}{0.878,1,1}}
+% admonition boxes, "light" style
+\sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}}
+% admonition boxes, "heavy" style
+\sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}}
+
+\DeclareDefaultOption{\@unknownoptionerror}
+\ProcessKeyvalOptions*
+% don't allow use of maxlistdepth via \sphinxsetup.
+\DisableKeyvalOption{sphinx}{maxlistdepth}
+\DisableKeyvalOption{sphinx}{numfigreset}
+\DisableKeyvalOption{sphinx}{nonumfigreset}
+\DisableKeyvalOption{sphinx}{mathnumfig}
+% user interface: options can be changed midway in a document!
+\newcommand\sphinxsetup[1]{\setkeys{sphinx}{#1}}
+
+
+%% MAXLISTDEPTH
+%
+% remove LaTeX's cap on nesting depth if 'maxlistdepth' key used.
+% This is a hack, which works with the standard classes: it assumes \@toodeep
+% is always used in "true" branches: "\if ... \@toodeep \else .. \fi."
+
+% will force use the "false" branch (if there is one)
+\def\spx@toodeep@hack{\fi\iffalse}
+
+% do nothing if 'maxlistdepth' key not used or if package enumitem loaded.
+\ifnum\spx@opt@maxlistdepth=\z@\expandafter\@gobbletwo\fi
+\AtBeginDocument{%
+\@ifpackageloaded{enumitem}{\remove@to@nnil}{}%
+  \let\spx@toodeepORI\@toodeep
+  \def\@toodeep{%
+    \ifnum\@listdepth<\spx@opt@maxlistdepth\relax
+      \expandafter\spx@toodeep@hack
+    \else
+      \expandafter\spx@toodeepORI
+    \fi}%
+% define all missing \@list... macros
+  \count@\@ne
+  \loop
+     \ltx@ifundefined{@list\romannumeral\the\count@}
+       {\iffalse}{\iftrue\advance\count@\@ne}%
+  \repeat
+  \loop
+     \ifnum\count@>\spx@opt@maxlistdepth\relax\else
+       \expandafter\let
+         \csname @list\romannumeral\the\count@\expandafter\endcsname
+         \csname @list\romannumeral\the\numexpr\count@-\@ne\endcsname
+       % workaround 2.6--3.2d babel-french issue (fixed in 3.2e; no change needed)
+       \ltx@ifundefined{leftmargin\romannumeral\the\count@}
+       {\expandafter\let
+         \csname leftmargin\romannumeral\the\count@\expandafter\endcsname
+         \csname leftmargin\romannumeral\the\numexpr\count@-\@ne\endcsname}{}%
+     \advance\count@\@ne
+  \repeat
+% define all missing enum... counters and \labelenum... macros and \p@enum..
+  \count@\@ne
+  \loop
+     \ltx@ifundefined{c@enum\romannumeral\the\count@}
+       {\iffalse}{\iftrue\advance\count@\@ne}%
+  \repeat
+  \loop
+     \ifnum\count@>\spx@opt@maxlistdepth\relax\else
+       \newcounter{enum\romannumeral\the\count@}%
+       \expandafter\def
+         \csname labelenum\romannumeral\the\count@\expandafter\endcsname
+         \expandafter
+         {\csname theenum\romannumeral\the\numexpr\count@\endcsname.}%
+       \expandafter\def
+         \csname p@enum\romannumeral\the\count@\expandafter\endcsname
+         \expandafter
+         {\csname p@enum\romannumeral\the\numexpr\count@-\@ne\expandafter
+          \endcsname\csname theenum\romannumeral\the\numexpr\count@-\@ne\endcsname.}%
+     \advance\count@\@ne
+  \repeat
+% define all missing labelitem... macros
+  \count@\@ne
+  \loop
+     \ltx@ifundefined{labelitem\romannumeral\the\count@}
+     {\iffalse}{\iftrue\advance\count@\@ne}%
+  \repeat
+  \loop
+     \ifnum\count@>\spx@opt@maxlistdepth\relax\else
+       \expandafter\let
+         \csname labelitem\romannumeral\the\count@\expandafter\endcsname
+         \csname labelitem\romannumeral\the\numexpr\count@-\@ne\endcsname
+     \advance\count@\@ne
+  \repeat
+  \PackageInfo{sphinx}{maximal list depth extended to \spx@opt@maxlistdepth}%
+\@gobble\@nnil
+}
+
+
+%% INDEX, BIBLIOGRAPHY, APPENDIX, TABLE OF CONTENTS
+%
+% fix the double index and bibliography on the table of contents
+% in jsclasses (Japanese standard document classes)
+\ifx\@jsc@uplatextrue\@undefined\else
+  \renewenvironment{sphinxtheindex}
+    {\cleardoublepage\phantomsection
+     \begin{theindex}}
+    {\end{theindex}}
+
+  \renewenvironment{sphinxthebibliography}[1]
+    {\cleardoublepage% \phantomsection % not needed here since TeXLive 2010's hyperref
+     \begin{thebibliography}{1}}
+    {\end{thebibliography}}
+\fi
+
+% disable \@chappos in Appendix in pTeX
+\ifx\kanjiskip\@undefined\else
+  \let\py@OldAppendix=\appendix
+  \renewcommand{\appendix}{
+    \py@OldAppendix
+    \gdef\@chappos{}
+  }
+\fi
+
+% make commands known to non-Sphinx document classes
+\providecommand*{\sphinxtableofcontents}{\tableofcontents}
+\ltx@ifundefined{sphinxthebibliography}
+ {\newenvironment
+  {sphinxthebibliography}{\begin{thebibliography}}{\end{thebibliography}}%
+ }
+ {}% else clause of \ltx@ifundefined
+\ltx@ifundefined{sphinxtheindex}
+ {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}%
+ {}% else clause of \ltx@ifundefined
+
+
+%% COLOR (general)
+%
+% FIXME: \normalcolor should probably be used in place of \py@NormalColor
+% elsewhere, and \py@NormalColor should never be defined. \normalcolor
+% switches to the colour from last \color call in preamble.
+\def\py@NormalColor{\color{black}}
+% FIXME: it is probably better to use \color{TitleColor}, as TitleColor
+% can be customized from 'sphinxsetup', and drop usage of \py@TitleColor
+\def\py@TitleColor{\color{TitleColor}}
+% FIXME: this line should be dropped, as "9" is default anyhow.
+\ifdefined\pdfcompresslevel\pdfcompresslevel = 9 \fi
+
+
+%% PAGE STYLING
+%
+% Style parameters and macros used by most documents here
+\raggedbottom
+\sloppy
+\hbadness = 5000                % don't print trivial gripes
+
+\pagestyle{empty}               % start this way
+
+% Redefine the 'normal' header/footer style when using "fancyhdr" package:
+% Note: this presupposes "twoside". If "oneside" class option, there will be warnings.
+\ltx@ifundefined{fancyhf}{}{
+  % Use \pagestyle{normal} as the primary pagestyle for text.
+  \fancypagestyle{normal}{
+    \fancyhf{}
+% (for \py@HeaderFamily cf "TITLES")
+    \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
+    \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
+    \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
+    \fancyhead[LE,RO]{{\py@HeaderFamily \@title\sphinxheadercomma\py@release}}
+    \renewcommand{\headrulewidth}{0.4pt}
+    \renewcommand{\footrulewidth}{0.4pt}
+    % define chaptermark with \@chappos when \@chappos is available for Japanese
+    \ltx@ifundefined{@chappos}{}
+      {\def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}}
+  }
+  % Update the plain style so we get the page number & footer line,
+  % but not a chapter or section title.  This is to keep the first
+  % page of a chapter and the blank page between chapters `clean.'
+  \fancypagestyle{plain}{
+    \fancyhf{}
+    \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
+    \renewcommand{\headrulewidth}{0pt}
+    \renewcommand{\footrulewidth}{0.4pt}
+  }
+}
+
+% geometry
+\ifx\kanjiskip\@undefined
+  \PassOptionsToPackage{%
+     hmargin={\unexpanded{\spx@opt@hmargin}},%
+     vmargin={\unexpanded{\spx@opt@vmargin}},%
+     marginpar=\unexpanded{\spx@opt@marginpar}}
+  {geometry}
+\else
+ % set text width for Japanese documents to be integer multiple of 1zw
+ % and text height to be integer multiple of \baselineskip
+ % the execution is delayed to \sphinxsetup then geometry.sty
+ \normalsize\normalfont
+ \newcommand*\sphinxtextwidthja[1]{%
+    \if@twocolumn\tw@\fi
+    \dimexpr
+       \numexpr\dimexpr\paperwidth-\tw@\dimexpr#1\relax\relax/
+               \dimexpr\if@twocolumn\tw@\else\@ne\fi zw\relax
+    zw\relax}%
+ \newcommand*\sphinxmarginparwidthja[1]{%
+    \dimexpr\numexpr\dimexpr#1\relax/\dimexpr1zw\relax zw\relax}%
+ \newcommand*\sphinxtextlinesja[1]{%
+    \numexpr\@ne+\dimexpr\paperheight-\topskip-\tw@\dimexpr#1\relax\relax/
+                 \baselineskip\relax}%
+ \ifx\@jsc@uplatextrue\@undefined\else
+ % the way we found in order for the papersize special written by
+ % geometry in the dvi file to be correct in case of jsbook class
+   \ifnum\mag=\@m\else % do nothing special if nomag class option or 10pt
+     \PassOptionsToPackage{truedimen}{geometry}%
+   \fi
+ \fi
+ \PassOptionsToPackage{%
+    hmarginratio={1:1},%
+    textwidth=\unexpanded{\sphinxtextwidthja{\spx@opt@hmargin}},%
+    vmarginratio={1:1},%
+    lines=\unexpanded{\sphinxtextlinesja{\spx@opt@vmargin}},%
+    marginpar=\unexpanded{\sphinxmarginparwidthja{\spx@opt@marginpar}},%
+    footskip=2\baselineskip,%
+  }{geometry}%
+ \AtBeginDocument
+ {% update a dimension used by the jsclasses
+  \ifx\@jsc@uplatextrue\@undefined\else\fullwidth\textwidth\fi
+  % for some reason, jreport normalizes all dimensions with \@settopoint
+  \@ifclassloaded{jreport}
+    {\@settopoint\textwidth\@settopoint\textheight\@settopoint\marginparwidth}
+    {}% <-- "false" clause of \@ifclassloaded
+  }%
+\fi
+
+% fix fncychap's bug which uses prematurely the \textwidth value
+\@ifpackagewith{fncychap}{Bjornstrup}
+ {\AtBeginDocument{\mylen\textwidth\advance\mylen-2\myhi}}%
+ {}% <-- "false" clause of \@ifpackagewith
+
+
+%% TITLES
+%
+% Since Sphinx 1.5, users should use HeaderFamily key to 'sphinxsetup' rather
+% than defining their own \py@HeaderFamily command (which is still possible).
+% Memo: \py@HeaderFamily is also used by \maketitle as defined in
+% sphinxmanual.cls/sphinxhowto.cls
+\newcommand{\py@HeaderFamily}{\spx@opt@HeaderFamily}
+
+% This sets up the fancy chapter headings that make the documents look
+% at least a little better than the usual LaTeX output.
+\@ifpackagewith{fncychap}{Bjarne}{
+  \ChNameVar {\raggedleft\normalsize \py@HeaderFamily}
+  \ChNumVar  {\raggedleft\Large      \py@HeaderFamily}
+  \ChTitleVar{\raggedleft\Large      \py@HeaderFamily}
+  % This creates (numbered) chapter heads without the leading \vspace*{}:
+  \def\@makechapterhead#1{%
+    {\parindent \z@ \raggedright \normalfont
+      \ifnum \c@secnumdepth >\m@ne
+        \if@mainmatter
+          \DOCH
+        \fi
+      \fi
+      \interlinepenalty\@M
+      \if@mainmatter
+        \DOTI{#1}%
+      \else%
+        \DOTIS{#1}%
+      \fi
+    }}
+}{}% <-- "false" clause of \@ifpackagewith
+
+% Augment the sectioning commands used to get our own font family in place,
+% and reset some internal data items (\titleformat from titlesec package)
+\titleformat{\section}{\Large\py@HeaderFamily}%
+            {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsection}{\large\py@HeaderFamily}%
+            {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsubsection}{\py@HeaderFamily}%
+            {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+% By default paragraphs (and subsubsections) will not be numbered because
+% sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2
+\titleformat{\paragraph}{\py@HeaderFamily}%
+            {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subparagraph}{\py@HeaderFamily}%
+            {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
+
+
+%% GRAPHICS
+%
+% \sphinxincludegraphics defined to resize images larger than the line width,
+% except if height or width option present.
+%
+% If scale is present, rescale before fitting to line width. (since 1.5)
+\newbox\spx@image@box
+\newcommand*{\sphinxincludegraphics}[2][]{%
+  \in@{height}{#1}\ifin@\else\in@{width}{#1}\fi
+  \ifin@ % height or width present
+    \includegraphics[#1]{#2}%
+  \else % no height nor width (but #1 may be "scale=...")
+    \setbox\spx@image@box\hbox{\includegraphics[#1,draft]{#2}}%
+    \ifdim \wd\spx@image@box>\linewidth
+      \setbox\spx@image@box\box\voidb@x % clear memory
+      \includegraphics[#1,width=\linewidth]{#2}%
+    \else
+      \includegraphics[#1]{#2}%
+    \fi
+  \fi
+}
+
+
+%% FIGURE IN TABLE
+%
+\newenvironment{sphinxfigure-in-table}[1][\linewidth]{%
+  \def\@captype{figure}%
+  \sphinxsetvskipsforfigintablecaption
+  \begin{minipage}{#1}%
+}{\end{minipage}}
+% store original \caption macro for use with figures in longtable and tabulary
+\AtBeginDocument{\let\spx@originalcaption\caption}
+\newcommand*\sphinxfigcaption
+  {\ifx\equation$%$% this is trick to identify tabulary first pass
+       \firstchoice@false\else\firstchoice@true\fi
+   \spx@originalcaption }
+\newcommand*\sphinxsetvskipsforfigintablecaption
+  {\abovecaptionskip\smallskipamount
+   \belowcaptionskip\smallskipamount}
+
+
+%% FOOTNOTES
+%
+% Support large numbered footnotes in minipage
+% But now obsolete due to systematic use of \savenotes/\spewnotes
+% when minipages are in use in the various macro definitions next.
+\def\thempfootnote{\arabic{mpfootnote}}
+
+
+%% NUMBERING OF FIGURES, TABLES, AND LITERAL BLOCKS
+\ltx@ifundefined{c@chapter}
+   {\newcounter{literalblock}}%
+   {\newcounter{literalblock}[chapter]%
+    \def\theliteralblock{\ifnum\c@chapter>\z@\arabic{chapter}.\fi
+                         \arabic{literalblock}}%
+    }%
+\ifspx@opt@nonumfigreset
+    \ltx@ifundefined{c@chapter}{}{%
+      \@removefromreset{figure}{chapter}%
+      \@removefromreset{table}{chapter}%
+      \@removefromreset{literalblock}{chapter}%
+      \ifspx@opt@mathnumfig
+        \@removefromreset{equation}{chapter}%
+      \fi
+    }%
+    \def\thefigure{\arabic{figure}}%
+    \def\thetable {\arabic{table}}%
+    \def\theliteralblock{\arabic{literalblock}}%
+    \ifspx@opt@mathnumfig
+      \def\theequation{\arabic{equation}}%
+    \fi
+\else
+\let\spx@preAthefigure\@empty
+\let\spx@preBthefigure\@empty
+% \ifspx@opt@usespart  % <-- LaTeX writer could pass such a 'usespart' boolean
+%                      %     as sphinx.sty package option
+% If document uses \part, (triggered in Sphinx by latex_toplevel_sectioning)
+% LaTeX core per default does not reset chapter or section
+% counters at each part.
+% But if we modify this, we need to redefine \thechapter, \thesection to
+% include the part number and this will cause problems in table of contents
+% because of too wide numbering. Simplest is to do nothing.
+% \fi
+\ifnum\spx@opt@numfigreset>0
+    \ltx@ifundefined{c@chapter}
+      {}
+      {\g@addto@macro\spx@preAthefigure{\ifnum\c@chapter>\z@\arabic{chapter}.}%
+       \g@addto@macro\spx@preBthefigure{\fi}}%
+\fi
+\ifnum\spx@opt@numfigreset>1
+    \@addtoreset{figure}{section}%
+    \@addtoreset{table}{section}%
+    \@addtoreset{literalblock}{section}%
+    \ifspx@opt@mathnumfig
+      \@addtoreset{equation}{section}%
+    \fi
+    \g@addto@macro\spx@preAthefigure{\ifnum\c@section>\z@\arabic{section}.}%
+    \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>2
+    \@addtoreset{figure}{subsection}%
+    \@addtoreset{table}{subsection}%
+    \@addtoreset{literalblock}{subsection}%
+    \ifspx@opt@mathnumfig
+      \@addtoreset{equation}{subsection}%
+    \fi
+    \g@addto@macro\spx@preAthefigure{\ifnum\c@subsection>\z@\arabic{subsection}.}%
+    \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>3
+    \@addtoreset{figure}{subsubsection}%
+    \@addtoreset{table}{subsubsection}%
+    \@addtoreset{literalblock}{subsubsection}%
+    \ifspx@opt@mathnumfig
+      \@addtoreset{equation}{subsubsection}%
+    \fi
+    \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubsection>\z@\arabic{subsubsection}.}%
+    \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>4
+    \@addtoreset{figure}{paragraph}%
+    \@addtoreset{table}{paragraph}%
+    \@addtoreset{literalblock}{paragraph}%
+    \ifspx@opt@mathnumfig
+      \@addtoreset{equation}{paragraph}%
+    \fi
+    \g@addto@macro\spx@preAthefigure{\ifnum\c@subparagraph>\z@\arabic{subparagraph}.}%
+    \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>5
+    \@addtoreset{figure}{subparagraph}%
+    \@addtoreset{table}{subparagraph}%
+    \@addtoreset{literalblock}{subparagraph}%
+    \ifspx@opt@mathnumfig
+      \@addtoreset{equation}{subparagraph}%
+    \fi
+    \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubparagraph>\z@\arabic{subsubparagraph}.}%
+    \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\expandafter\g@addto@macro
+\expandafter\spx@preAthefigure\expandafter{\spx@preBthefigure}%
+\let\thefigure\spx@preAthefigure
+\let\thetable\spx@preAthefigure
+\let\theliteralblock\spx@preAthefigure
+\g@addto@macro\thefigure{\arabic{figure}}%
+\g@addto@macro\thetable{\arabic{table}}%
+\g@addto@macro\theliteralblock{\arabic{literalblock}}%
+  \ifspx@opt@mathnumfig
+    \let\theequation\spx@preAthefigure
+    \g@addto@macro\theequation{\arabic{equation}}%
+  \fi
+\fi
+
+
+%% LITERAL BLOCKS
+%
+% Based on use of "fancyvrb.sty"'s Verbatim.
+% - with framing allowing page breaks ("framed.sty")
+% - with breaking of long lines (exploits Pygments mark-up),
+% - with possibly of a top caption, non-separable by pagebreak.
+% - and usable inside tables or footnotes ("footnotehyper-sphinx").
+
+% For extensions which use \OriginalVerbatim and compatibility with Sphinx <
+% 1.5, we define and use these when (unmodified) Verbatim will be needed. But
+% Sphinx >= 1.5 does not modify the \Verbatim macro anymore.
+\let\OriginalVerbatim   \Verbatim
+\let\endOriginalVerbatim\endVerbatim
+
+% for captions of literal blocks
+% at start of caption title
+\newcommand*{\fnum@literalblock}{\literalblockname\nobreakspace\theliteralblock}
+% this will be overwritten in document preamble by Babel translation
+\newcommand*{\literalblockname}{Listing }
+% file extension needed for \caption's good functioning, the file is created
+% only if a \listof{literalblock}{foo} command is encountered, which is
+% analogous to \listoffigures, but for the code listings (foo = chosen title.)
+\newcommand*{\ext@literalblock}{lol}
+
+\newif\ifspx@inframed % flag set if we are already in a framed environment
+% if forced use of minipage encapsulation is needed (e.g. table cells)
+\newif\ifsphinxverbatimwithminipage   \sphinxverbatimwithminipagefalse
+
+% Framing macro for use with framed.sty's \FrameCommand
+%  - it obeys current indentation,
+%  - frame is \fboxsep separated from the contents,
+%  - the contents use the full available text width,
+%  - #1 = color of frame, #2 = color of background,
+%  - #3 = above frame, #4 = below frame, #5 = within frame,
+%  - #3 and #4 must be already typeset boxes; they must issue \normalcolor
+%    or similar, else, they are under scope of color #1
+\long\def\spx@fcolorbox #1#2#3#4#5{%
+  \hskip\@totalleftmargin
+  \hskip-\fboxsep\hskip-\fboxrule
+  % use of \color@b@x here is compatible with both xcolor.sty and color.sty
+  \color@b@x {\color{#1}\spx@CustomFBox{#3}{#4}}{\color{#2}}{#5}%
+  \hskip-\fboxsep\hskip-\fboxrule
+  \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth
+}%
+% #1 = for material above frame, such as a caption or a "continued" hint
+% #2 = for material below frame, such as a caption or "continues on next page"
+% #3 = actual contents, which will be typeset with a background color
+\long\def\spx@CustomFBox#1#2#3{%
+  \begingroup
+  \setbox\@tempboxa\hbox{{#3}}% inner braces to avoid color leaks
+  \vbox{#1% above frame
+            % draw frame border _latest_ to avoid pdf viewer issue
+            \kern\fboxrule
+            \hbox{\kern\fboxrule
+                  \copy\@tempboxa
+                  \kern-\wd\@tempboxa\kern-\fboxrule
+                  \vrule\@width\fboxrule
+                  \kern\wd\@tempboxa
+                  \vrule\@width\fboxrule}%
+            \kern-\dimexpr\ht\@tempboxa+\dp\@tempboxa+\fboxrule\relax
+            \hrule\@height\fboxrule
+            \kern\dimexpr\ht\@tempboxa+\dp\@tempboxa\relax
+            \hrule\@height\fboxrule
+        #2% below frame
+       }%
+  \endgroup
+}%
+\def\spx@fcolorbox@put@c#1{% hide width from framed.sty measuring
+    \moveright\dimexpr\fboxrule+.5\wd\@tempboxa\hb@xt@\z@{\hss#1\hss}%
+}%
+\def\spx@fcolorbox@put@r#1{% right align with contents, width hidden
+    \moveright\dimexpr\fboxrule+\wd\@tempboxa-\fboxsep\hb@xt@\z@{\hss#1}%
+}%
+\def\spx@fcolorbox@put@l#1{% left align with contents, width hidden
+    \moveright\dimexpr\fboxrule+\fboxsep\hb@xt@\z@{#1\hss}%
+}%
+%
+\def\sphinxVerbatim@Continued
+   {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuedalign\endcsname
+    {\normalcolor\sphinxstylecodecontinued\literalblockcontinuedname}}%
+\def\sphinxVerbatim@Continues
+   {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuesalign\endcsname
+    {\normalcolor\sphinxstylecodecontinues\literalblockcontinuesname}}%
+\def\sphinxVerbatim@Title
+   {\spx@fcolorbox@put@c{\unhcopy\sphinxVerbatim@TitleBox}}%
+\let\sphinxVerbatim@Before\@empty
+\let\sphinxVerbatim@After\@empty
+% Defaults are redefined in document preamble according to language
+\newcommand*\literalblockcontinuedname{continued from previous page}%
+\newcommand*\literalblockcontinuesname{continues on next page}%
+%
+\def\spx@verbatimfcolorbox{\spx@fcolorbox{VerbatimBorderColor}{VerbatimColor}}%
+\def\sphinxVerbatim@FrameCommand
+   {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@After}%
+\def\sphinxVerbatim@FirstFrameCommand
+   {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@Continues}%
+\def\sphinxVerbatim@MidFrameCommand
+   {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@Continues}%
+\def\sphinxVerbatim@LastFrameCommand
+   {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@After}%
+
+% For linebreaks inside Verbatim environment from package fancyvrb.
+\newbox\sphinxcontinuationbox
+\newbox\sphinxvisiblespacebox
+\newcommand*\sphinxafterbreak {\copy\sphinxcontinuationbox}
+
+% Take advantage of the already applied Pygments mark-up to insert
+% potential linebreaks for TeX processing.
+%        {, <, #, %, $, ' and ": go to next line.
+%        _, }, ^, &, >, - and ~: stay at end of broken line.
+% Use of \textquotesingle for straight quote.
+% FIXME: convert this to package options ?
+\newcommand*\sphinxbreaksbeforelist {%
+    \do\PYGZob\{\do\PYGZlt\<\do\PYGZsh\#\do\PYGZpc\%% {, <, #, %,
+    \do\PYGZdl\$\do\PYGZdq\"% $, "
+    \def\PYGZsq
+     {\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}% '
+}
+\newcommand*\sphinxbreaksafterlist {%
+    \do\PYGZus\_\do\PYGZcb\}\do\PYGZca\^\do\PYGZam\&% _, }, ^, &,
+    \do\PYGZgt\>\do\PYGZhy\-\do\PYGZti\~% >, -, ~
+}
+\newcommand*\sphinxbreaksatspecials {%
+  \def\do##1##2%
+     {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%
+  \sphinxbreaksbeforelist
+  \def\do##1##2%
+     {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%
+  \sphinxbreaksafterlist
+}
+
+\def\sphinx@verbatim@nolig@list {\do \`}%
+% Some characters . , ; ? ! / are not pygmentized.
+% This macro makes them "active" and they will insert potential linebreaks.
+% Not compatible with math mode (cf \sphinxunactivateextras).
+\newcommand*\sphinxbreaksbeforeactivelist {}% none
+\newcommand*\sphinxbreaksafteractivelist  {\do\.\do\,\do\;\do\?\do\!\do\/}
+\newcommand*\sphinxbreaksviaactive {%
+   \def\do##1{\lccode`\~`##1%
+    \lowercase{\def~}{\discretionary{}{\sphinxafterbreak\char`##1}{\char`##1}}%
+    \catcode`##1\active}%
+   \sphinxbreaksbeforeactivelist
+   \def\do##1{\lccode`\~`##1%
+    \lowercase{\def~}{\discretionary{\char`##1}{\sphinxafterbreak}{\char`##1}}%
+    \catcode`##1\active}%
+   \sphinxbreaksafteractivelist
+   \lccode`\~`\~
+}
+
+% If the linebreak is at a space, the latter will be displayed as visible
+% space at end of first line, and a continuation symbol starts next line.
+\def\spx@verbatim@space {%
+     \nobreak\hskip\z@skip
+     \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak}
+                   {\kern\fontdimen2\font}%
+}%
+
+% if the available space on page is less than \literalblockneedspace, insert pagebreak
+\newcommand{\sphinxliteralblockneedspace}{5\baselineskip}
+\newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip}
+% The title (caption) is specified from outside as macro \sphinxVerbatimTitle.
+% \sphinxVerbatimTitle is reset to empty after each use of Verbatim.
+\newcommand*\sphinxVerbatimTitle {}
+% This box to typeset the caption before framed.sty multiple passes for framing.
+\newbox\sphinxVerbatim@TitleBox
+% This is a workaround to a "feature" of French lists, when literal block
+% follows immediately; usable generally (does only \par then), a priori...
+\newcommand*\sphinxvspacefixafterfrenchlists{%
+   \ifvmode\ifdim\lastskip<\z@ \vskip\parskip\fi\else\par\fi
+}
+% Holder macro for labels of literal blocks. Set-up by LaTeX writer.
+\newcommand*\sphinxLiteralBlockLabel {}
+\newcommand*\sphinxSetupCaptionForVerbatim [1]
+{%
+    \sphinxvspacefixafterfrenchlists
+    \needspace{\sphinxliteralblockneedspace}%
+% insert a \label via \sphinxLiteralBlockLabel
+% reset to normal the color for the literal block caption
+    \def\sphinxVerbatimTitle
+       {\py@NormalColor\sphinxcaption{\sphinxLiteralBlockLabel #1}}%
+}
+\newcommand*\sphinxSetupCodeBlockInFootnote {%
+  \fvset{fontsize=\footnotesize}\let\caption\sphinxfigcaption
+  \sphinxverbatimwithminipagetrue % reduces vertical spaces
+  % we counteract (this is in a group) the \@normalsize from \caption
+  \let\normalsize\footnotesize\let\@parboxrestore\relax
+  \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%
+}
+% needed to create wrapper environments of fancyvrb's Verbatim
+\newcommand*{\sphinxVerbatimEnvironment}{\gdef\FV@EnvironName{sphinxVerbatim}}
+\newcommand*{\sphinxverbatimsmallskipamount}{\smallskipamount}
+% serves to implement line highlighting and line wrapping
+\newcommand\sphinxFancyVerbFormatLine[1]{%
+  \expandafter\sphinx@verbatim@checkifhl\expandafter{\the\FV@CodeLineNo}%
+  \ifin@
+     \sphinxVerbatimHighlightLine{#1}%
+  \else
+     \sphinxVerbatimFormatLine{#1}%
+  \fi
+}%
+\newcommand\sphinxVerbatimHighlightLine[1]{%
+  \edef\sphinxrestorefboxsep{\fboxsep\the\fboxsep\relax}%
+  \fboxsep0pt\relax % cf LaTeX bug graphics/4524
+  \colorbox{sphinxVerbatimHighlightColor}%
+           {\sphinxrestorefboxsep\sphinxVerbatimFormatLine{#1}}%
+  % no need to restore \fboxsep here, as this ends up in a \hbox from fancyvrb
+}%
+% \sphinxVerbatimFormatLine will be set locally to one of those two:
+\newcommand\sphinxVerbatimFormatLineWrap[1]{%
+    \hsize\linewidth
+    \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@
+          \doublehyphendemerits\z@\finalhyphendemerits\z@
+          \strut #1\strut}%
+}%
+\newcommand\sphinxVerbatimFormatLineNoWrap[1]{\hb@xt@\linewidth{\strut #1\hss}}%
+\g@addto@macro\FV@SetupFont{%
+    \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%
+    \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%
+}%
+\newenvironment{sphinxVerbatim}{%
+  % first, let's check if there is a caption
+  \ifx\sphinxVerbatimTitle\empty
+      \sphinxvspacefixafterfrenchlists
+      \parskip\z@skip
+      \vskip\sphinxverbatimsmallskipamount
+      % there was no caption. Check if nevertheless a label was set.
+      \ifx\sphinxLiteralBlockLabel\empty\else
+      % we require some space to be sure hyperlink target from \phantomsection
+      % will not be separated from upcoming verbatim by a page break
+          \needspace{\sphinxliteralblockwithoutcaptionneedspace}%
+          \phantomsection\sphinxLiteralBlockLabel
+      \fi
+  \else
+     \parskip\z@skip
+     \if t\spx@opt@literalblockcappos
+       \vskip\spx@abovecaptionskip
+       \def\sphinxVerbatim@Before
+           {\sphinxVerbatim@Title\nointerlineskip
+            \kern\dimexpr-\dp\strutbox+\sphinxbelowcaptionspace\relax}%
+     \else
+       \vskip\sphinxverbatimsmallskipamount
+       \def\sphinxVerbatim@After
+          {\nointerlineskip\kern\dp\strutbox\sphinxVerbatim@Title}%
+     \fi
+     \def\@captype{literalblock}%
+     \capstart
+     % \sphinxVerbatimTitle must reset color
+     \setbox\sphinxVerbatim@TitleBox
+            \hbox{\begin{minipage}{\linewidth}%
+                    \sphinxVerbatimTitle
+                  \end{minipage}}%
+  \fi
+  \global\let\sphinxLiteralBlockLabel\empty
+  \global\let\sphinxVerbatimTitle\empty
+  \fboxsep\sphinxverbatimsep \fboxrule\sphinxverbatimborder
+  \ifspx@opt@verbatimwithframe\else\fboxrule\z@\fi
+  \let\FrameCommand     \sphinxVerbatim@FrameCommand
+  \let\FirstFrameCommand\sphinxVerbatim@FirstFrameCommand
+  \let\MidFrameCommand  \sphinxVerbatim@MidFrameCommand
+  \let\LastFrameCommand \sphinxVerbatim@LastFrameCommand
+  \ifspx@opt@verbatimhintsturnover\else
+      \let\sphinxVerbatim@Continued\@empty
+      \let\sphinxVerbatim@Continues\@empty
+  \fi
+  \ifspx@opt@verbatimwrapslines
+  % fancyvrb's Verbatim puts each input line in (unbreakable) horizontal boxes.
+  % This customization wraps each line from the input in a \vtop, thus
+  % allowing it to wrap and display on two or more lines in the latex output.
+  %     - The codeline counter will be increased only once.
+  %     - The wrapped material will not break across pages, it is impossible
+  %       to achieve this without extensive rewrite of fancyvrb.
+  %     - The (not used in sphinx) obeytabs option to Verbatim is
+  %       broken by this change (showtabs and tabspace work).
+    \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineWrap
+    \let\FV@Space\spx@verbatim@space
+  % Allow breaks at special characters using \PYG... macros.
+    \sphinxbreaksatspecials
+  % Breaks at punctuation characters . , ; ? ! and / (needs catcode activation)
+    \fvset{codes*=\sphinxbreaksviaactive}%
+  \else % end of conditional code for wrapping long code lines
+    \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineNoWrap
+  \fi
+  \let\FancyVerbFormatLine\sphinxFancyVerbFormatLine
+  % workaround to fancyvrb's check of \@currenvir
+  \let\VerbatimEnvironment\sphinxVerbatimEnvironment
+  % workaround to fancyvrb's check of current list depth
+  \def\@toodeep {\advance\@listdepth\@ne}%
+  % The list environment is needed to control perfectly the vertical space.
+  % Note: \OuterFrameSep used by framed.sty is later set to \topsep hence 0pt.
+  % - if caption: distance from last text baseline to caption baseline is
+  %   A+(B-F)+\ht\strutbox, A = \abovecaptionskip (default 10pt), B =
+  %   \baselineskip, F is the framed.sty \FrameHeightAdjust macro, default 6pt.
+  %   Formula valid for F < 10pt.
+  % - distance of baseline of caption to top of frame is like for tables:
+  %   \sphinxbelowcaptionspace (=0.5\baselineskip)
+  % - if no caption: distance of last text baseline to code frame is S+(B-F),
+  %   with S = \sphinxverbatimtopskip (=\smallskip)
+  % - and distance from bottom of frame to next text baseline is
+  %   \baselineskip+\parskip.
+  % The \trivlist is used to avoid possible "too deeply nested" error.
+  \itemsep   \z@skip
+  \topsep    \z@skip
+  \partopsep \z@skip
+  % trivlist will set \parsep to \parskip = zero
+  % \leftmargin will be set to zero by trivlist
+  \rightmargin\z@
+  \parindent  \z@% becomes \itemindent. Default zero, but perhaps overwritten.
+  \trivlist\item\relax
+     \ifsphinxverbatimwithminipage\spx@inframedtrue\fi
+     % use a minipage if we are already inside a framed environment
+     \ifspx@inframed\noindent\begin{minipage}{\linewidth}\fi
+     \MakeFramed {% adapted over from framed.sty's snugshade environment
+        \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize\@setminipage
+        }%
+     % For grid placement from \strut's in \FancyVerbFormatLine
+     \lineskip\z@skip
+     % active comma should not be overwritten by \@noligs
+     \ifspx@opt@verbatimwrapslines
+       \let\verbatim@nolig@list \sphinx@verbatim@nolig@list
+     \fi
+     % will fetch its optional arguments if any
+     \OriginalVerbatim
+}
+{%
+  \endOriginalVerbatim
+  \par\unskip\@minipagefalse\endMakeFramed % from framed.sty snugshade
+  \ifspx@inframed\end{minipage}\fi
+  \endtrivlist
+}
+\newenvironment {sphinxVerbatimNoFrame}
+  {\spx@opt@verbatimwithframefalse
+   % needed for fancyvrb as literal code will end in \end{sphinxVerbatimNoFrame}
+   \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimNoFrame}}%
+   \begin{sphinxVerbatim}}
+  {\end{sphinxVerbatim}}
+\newenvironment {sphinxVerbatimintable}
+  {% don't use a frame if in a table cell
+   \spx@opt@verbatimwithframefalse
+   \sphinxverbatimwithminipagetrue
+   % the literal block caption uses \sphinxcaption which is wrapper of \caption,
+   % but \caption must be modified because longtable redefines it to work only
+   % for the own table caption, and tabulary has multiple passes
+   \let\caption\sphinxfigcaption
+   % reduce above caption skip
+   \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%
+   \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimintable}}%
+   \begin{sphinxVerbatim}}
+  {\end{sphinxVerbatim}}
+
+
+%% PARSED LITERALS
+% allow long lines to wrap like they do in code-blocks
+
+% this should be kept in sync with definitions in sphinx.util.texescape
+\newcommand*\sphinxbreaksattexescapedchars{%
+  \def\do##1##2% put potential break point before character
+     {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%
+  \do\{\{\do\textless\<\do\#\#\do\%\%\do\$\$% {, <, #, %, $
+  \def\do##1##2% put potential break point after character
+     {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%
+  \do\_\_\do\}\}\do\textasciicircum\^\do\&\&% _, }, ^, &,
+  \do\textgreater\>\do\textasciitilde\~% >, ~
+}
+\newcommand*\sphinxbreaksviaactiveinparsedliteral{%
+  \sphinxbreaksviaactive % by default handles . , ; ? ! /
+  \do\-% we need also the hyphen character (ends up "as is" in parsed-literal)
+  \lccode`\~`\~ %
+  % update \dospecials as it is used by \url
+  % but deactivation will already have been done hence this is unneeded:
+  %  \expandafter\def\expandafter\dospecials\expandafter{\dospecials
+  %   \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%
+}
+\newcommand*\sphinxbreaksatspaceinparsedliteral{%
+  \lccode`~32 \lowercase{\let~}\spx@verbatim@space\lccode`\~`\~
+}
+\newcommand*{\sphinxunactivateextras}{\let\do\@makeother
+      \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%
+% the \catcode13=5\relax (deactivate end of input lines) is left to callers
+\newcommand*{\sphinxunactivateextrasandspace}{\catcode32=10\relax
+      \sphinxunactivateextras}%
+% now for the modified alltt environment
+\newenvironment{sphinxalltt}
+{% at start of next line to workaround Emacs/AUCTeX issue with this file
+\begin{alltt}%
+ \ifspx@opt@parsedliteralwraps
+   \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%
+   \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%
+   \sphinxbreaksattexescapedchars
+   \sphinxbreaksviaactiveinparsedliteral
+   \sphinxbreaksatspaceinparsedliteral
+% alltt takes care of the ' as derivative ("prime") in math mode
+   \everymath\expandafter{\the\everymath\sphinxunactivateextrasandspace
+             \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%
+% not sure if displayed math (align,...) can end up in parsed-literal, anyway
+   \everydisplay\expandafter{\the\everydisplay
+             \catcode13=5 \sphinxunactivateextrasandspace
+             \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%
+ \fi }
+{\end{alltt}}
+
+% Protect \href's first argument in contexts such as sphinxalltt (or
+% \sphinxcode). Sphinx uses \#, \%, \& ... always inside \sphinxhref.
+\protected\def\sphinxhref#1#2{{%
+    \sphinxunactivateextrasandspace % never do \scantokens with active space!
+    \endlinechar\m@ne\everyeof{{#2}}% keep catcode regime for #2
+    \scantokens{\href{#1}}% normalise it for #1 during \href expansion
+}}
+% Same for \url. And also \nolinkurl for coherence.
+\protected\def\sphinxurl#1{{%
+    \sphinxunactivateextrasandspace\everyeof{}% (<- precaution for \scantokens)
+    \endlinechar\m@ne\scantokens{\url{#1}}%
+}}
+\protected\def\sphinxnolinkurl#1{{%
+    \sphinxunactivateextrasandspace\everyeof{}%
+    \endlinechar\m@ne\scantokens{\nolinkurl{#1}}%
+}}
+
+
+%% TOPIC AND CONTENTS BOXES
+%
+% Again based on use of "framed.sty", this allows breakable framed boxes.
+\long\def\spx@ShadowFBox#1{%
+  \leavevmode\begingroup
+  % first we frame the box #1
+  \setbox\@tempboxa
+   \hbox{\vrule\@width\sphinxshadowrule
+         \vbox{\hrule\@height\sphinxshadowrule
+               \kern\sphinxshadowsep
+               \hbox{\kern\sphinxshadowsep #1\kern\sphinxshadowsep}%
+               \kern\sphinxshadowsep
+               \hrule\@height\sphinxshadowrule}%
+         \vrule\@width\sphinxshadowrule}%
+  % Now we add the shadow, like \shadowbox from fancybox.sty would do
+  \dimen@\dimexpr.5\sphinxshadowrule+\sphinxshadowsize\relax
+  \hbox{\vbox{\offinterlineskip
+              \hbox{\copy\@tempboxa\kern-.5\sphinxshadowrule
+                    % add shadow on right side
+                    \lower\sphinxshadowsize
+                          \hbox{\vrule\@height\ht\@tempboxa \@width\dimen@}%
+                    }%
+              \kern-\dimen@ % shift back vertically to bottom of frame
+              % and add shadow at bottom
+              \moveright\sphinxshadowsize
+                    \vbox{\hrule\@width\wd\@tempboxa \@height\dimen@}%
+              }%
+        % move left by the size of right shadow so shadow adds no width
+        \kern-\sphinxshadowsize
+       }%
+  \endgroup
+}
+
+% use framed.sty to allow page breaks in frame+shadow
+% works well inside Lists and Quote-like environments
+% produced by ``topic'' directive (or local contents)
+% could nest if LaTeX writer authorized it
+\newenvironment{sphinxShadowBox}
+  {\def\FrameCommand {\spx@ShadowFBox }%
+   % configure framed.sty not to add extra vertical spacing
+   \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
+   % the \trivlist will add the vertical spacing on top and bottom which is
+   % typical of center environment as used in Sphinx <= 1.4.1
+   % the \noindent has the effet of an extra blank line on top, to
+   % imitate closely the layout from Sphinx <= 1.4.1; the \FrameHeightAdjust
+   % will put top part of frame on this baseline.
+   \def\FrameHeightAdjust {\baselineskip}%
+   % use package footnote to handle footnotes
+   \savenotes
+   \trivlist\item\noindent
+    % use a minipage if we are already inside a framed environment
+    \ifspx@inframed\begin{minipage}{\linewidth}\fi
+    \MakeFramed {\spx@inframedtrue
+    % framed.sty puts into "\width" the added width (=2shadowsep+2shadowrule)
+    % adjust \hsize to what the contents must use
+    \advance\hsize-\width
+    % adjust LaTeX parameters to behave properly in indented/quoted contexts
+    \FrameRestore
+    % typeset the contents as in a minipage (Sphinx <= 1.4.1 used a minipage and
+    % itemize/enumerate are therein typeset more tightly, we want to keep
+    % that). We copy-paste from LaTeX source code but don't do a real minipage.
+    \@pboxswfalse
+    \let\@listdepth\@mplistdepth \@mplistdepth\z@
+    \@minipagerestore
+    \@setminipage
+    }%
+  }%
+  {% insert the "endminipage" code
+    \par\unskip
+    \@minipagefalse
+   \endMakeFramed
+     \ifspx@inframed\end{minipage}\fi
+   \endtrivlist
+   % output the stored footnotes
+   \spewnotes
+  }
+
+
+%% NOTICES AND ADMONITIONS
+%
+% Some are quite plain
+% the spx@notice@bordercolor etc are set in the sphinxadmonition environment
+\newenvironment{sphinxlightbox}{%
+  \par\allowbreak
+  \noindent{\color{spx@notice@bordercolor}%
+            \rule{\linewidth}{\spx@notice@border}}\par\nobreak
+  {\parskip\z@skip\noindent}%
+  }
+  {%
+  % counteract previous possible negative skip (French lists!):
+  % (we can't cancel that any earlier \vskip introduced a potential pagebreak)
+  \sphinxvspacefixafterfrenchlists
+  \nobreak\vbox{\noindent\kern\@totalleftmargin
+      {\color{spx@notice@bordercolor}%
+       \rule[\dimexpr.4\baselineskip-\spx@notice@border\relax]
+             {\linewidth}{\spx@notice@border}}\hss}\allowbreak
+  }% end of sphinxlightbox environment definition
+% may be renewenvironment'd by user for complete customization
+\newenvironment{sphinxnote}[1]
+  {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+\newenvironment{sphinxhint}[1]
+  {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+\newenvironment{sphinximportant}[1]
+  {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+\newenvironment{sphinxtip}[1]
+  {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+% or just use the package options
+% these are needed for common handling by notice environment of lightbox
+% and heavybox but they are  currently not used by lightbox environment
+% and there is consequently no corresponding package option
+\definecolor{sphinxnoteBgColor}{rgb}{1,1,1}
+\definecolor{sphinxhintBgColor}{rgb}{1,1,1}
+\definecolor{sphinximportantBgColor}{rgb}{1,1,1}
+\definecolor{sphinxtipBgColor}{rgb}{1,1,1}
+
+% Others get more distinction
+% Code adapted from framed.sty's "snugshade" environment.
+% Nesting works (inner frames do not allow page breaks).
+\newenvironment{sphinxheavybox}{\par
+   \setlength{\FrameRule}{\spx@notice@border}%
+   \setlength{\FrameSep}{\dimexpr.6\baselineskip-\FrameRule\relax}
+   % configure framed.sty's parameters to obtain same vertical spacing
+   % as for "light" boxes. We need for this to manually insert parskip glue and
+   % revert a skip done by framed before the frame.
+    \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
+    \vspace{\FrameHeightAdjust}
+   % copied/adapted from framed.sty's snugshade
+   \def\FrameCommand##1{\hskip\@totalleftmargin
+       \fboxsep\FrameSep \fboxrule\FrameRule
+       \fcolorbox{spx@notice@bordercolor}{spx@notice@bgcolor}{##1}%
+       \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}%
+   \savenotes
+   % use a minipage if we are already inside a framed environment
+   \ifspx@inframed
+       \noindent\begin{minipage}{\linewidth}
+   \else
+       % handle case where notice is first thing in a list item (or is quoted)
+       \if@inlabel
+        \noindent\par\vspace{-\baselineskip}
+       \else
+        \vspace{\parskip}
+       \fi
+   \fi
+   \MakeFramed {\spx@inframedtrue
+     \advance\hsize-\width \@totalleftmargin\z@ \linewidth\hsize
+     % minipage initialization copied from LaTeX source code.
+     \@pboxswfalse
+     \let\@listdepth\@mplistdepth \@mplistdepth\z@
+     \@minipagerestore
+     \@setminipage }%
+   }
+   {%
+   \par\unskip
+   \@minipagefalse
+   \endMakeFramed
+   \ifspx@inframed\end{minipage}\fi
+   % set footnotes at bottom of page
+   \spewnotes
+   % arrange for similar spacing below frame as for "light" boxes.
+   \vskip .4\baselineskip
+   }% end of sphinxheavybox environment definition
+% may be renewenvironment'd by user for complete customization
+\newenvironment{sphinxwarning}[1]
+  {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxcaution}[1]
+  {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxattention}[1]
+  {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxdanger}[1]
+  {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxerror}[1]
+  {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+% or just use package options
+
+% the \colorlet of xcolor (if at all loaded) is overkill for our use case
+\newcommand{\sphinxcolorlet}[2]
+    {\expandafter\let\csname\@backslashchar color@#1\expandafter\endcsname
+                     \csname\@backslashchar color@#2\endcsname }
+
+% the main dispatch for all types of notices
+\newenvironment{sphinxadmonition}[2]{% #1=type, #2=heading
+  % can't use #1 directly in definition of end part
+  \def\spx@noticetype {#1}%
+  % set parameters of heavybox/lightbox
+  \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}%
+  \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}%
+  \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax
+  % start specific environment, passing the heading as argument
+  \begin{sphinx#1}{#2}}
+  % workaround some LaTeX "feature" of \end command
+ {\edef\spx@temp{\noexpand\end{sphinx\spx@noticetype}}\spx@temp}
+
+
+%% PYTHON DOCS MACROS AND ENVIRONMENTS
+%  (some macros here used by \maketitle in sphinxmanual.cls and sphinxhowto.cls)
+
+% \moduleauthor{name}{email}
+\newcommand{\moduleauthor}[2]{}
+
+% \sectionauthor{name}{email}
+\newcommand{\sectionauthor}[2]{}
+
+% Allow the release number to be specified independently of the
+% \date{}.  This allows the date to reflect the document's date and
+% release to specify the release that is documented.
+%
+\newcommand{\py@release}{\releasename\space\version}
+\newcommand{\version}{}% part of \py@release, used by title page and headers
+% \releaseinfo is used on titlepage (sphinxmanual.cls, sphinxhowto.cls)
+\newcommand{\releaseinfo}{}
+\newcommand{\setreleaseinfo}[1]{\renewcommand{\releaseinfo}{#1}}
+% this is inserted via template and #1=release config variable
+\newcommand{\release}[1]{\renewcommand{\version}{#1}}
+% this is defined by template to 'releasename' latex_elements key
+\newcommand{\releasename}{}
+% Fix issue in case release and releasename deliberately left blank
+\newcommand{\sphinxheadercomma}{, }% used in fancyhdr header definition
+\newcommand{\sphinxifemptyorblank}[1]{%
+% test after one expansion of macro #1 if contents is empty or spaces
+     \if&\expandafter\@firstofone\detokenize\expandafter{#1}&%
+     \expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi}%
+\AtBeginDocument {%
+   \sphinxifemptyorblank{\releasename}
+     {\sphinxifemptyorblank{\version}{\let\sphinxheadercomma\empty}{}}
+     {}%
+}%
+
+% Allow specification of the author's address separately from the
+% author's name.  This can be used to format them differently, which
+% is a good thing.
+%
+\newcommand{\py@authoraddress}{}
+\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
+
+% {fulllineitems} is the main environment for object descriptions.
+%
+\newcommand{\py@itemnewline}[1]{%
+  \kern\labelsep
+  \@tempdima\linewidth
+  \advance\@tempdima \labelwidth\makebox[\@tempdima][l]{#1}%
+  \kern-\labelsep
+}
+
+\newenvironment{fulllineitems}{%
+  \begin{list}{}{\labelwidth \leftmargin
+                 \rightmargin \z@ \topsep -\parskip \partopsep \parskip
+                 \itemsep -\parsep
+                 \let\makelabel=\py@itemnewline}%
+}{\end{list}}
+
+% Signatures, possibly multi-line
+%
+\newlength{\py@argswidth}
+\newcommand{\py@sigparams}[2]{%
+  \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}}
+\newcommand{\pysigline}[1]{\item[{#1}]}
+\newcommand{\pysiglinewithargsret}[3]{%
+  \settowidth{\py@argswidth}{#1\sphinxcode{(}}%
+  \addtolength{\py@argswidth}{-2\py@argswidth}%
+  \addtolength{\py@argswidth}{\linewidth}%
+  \item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}}]}
+\newcommand{\pysigstartmultiline}{%
+ \def\pysigstartmultiline{\vskip\smallskipamount\parskip\z@skip\itemsep\z@skip}%
+ \edef\pysigstopmultiline
+     {\noexpand\leavevmode\parskip\the\parskip\relax\itemsep\the\itemsep\relax}%
+ \parskip\z@skip\itemsep\z@skip
+}
+
+% Production lists
+%
+\newenvironment{productionlist}{%
+%  \def\sphinxoptional##1{{\Large[}##1{\Large]}}
+  \def\production##1##2{\\\sphinxcode{\sphinxupquote{##1}}&::=&\sphinxcode{\sphinxupquote{##2}}}%
+  \def\productioncont##1{\\& &\sphinxcode{\sphinxupquote{##1}}}%
+  \parindent=2em
+  \indent
+  \setlength{\LTpre}{0pt}%
+  \setlength{\LTpost}{0pt}%
+  \begin{longtable}[l]{lcl}
+}{%
+  \end{longtable}
+}
+
+% Definition lists; requested by AMK for HOWTO documents.  Probably useful
+% elsewhere as well, so keep in in the general style support.
+%
+\newenvironment{definitions}{%
+  \begin{description}%
+  \def\term##1{\item[{##1}]\mbox{}\\*[0mm]}%
+}{%
+  \end{description}%
+}
+
+%% FROM DOCTUTILS LATEX WRITER
+%
+% The following is stuff copied from docutils' latex writer.
+%
+\newcommand{\optionlistlabel}[1]{\normalfont\bfseries #1 \hfill}% \bf deprecated
+\newenvironment{optionlist}[1]
+{\begin{list}{}
+  {\setlength{\labelwidth}{#1}
+   \setlength{\rightmargin}{1cm}
+   \setlength{\leftmargin}{\rightmargin}
+   \addtolength{\leftmargin}{\labelwidth}
+   \addtolength{\leftmargin}{\labelsep}
+   \renewcommand{\makelabel}{\optionlistlabel}}
+}{\end{list}}
+
+\newlength{\lineblockindentation}
+\setlength{\lineblockindentation}{2.5em}
+\newenvironment{lineblock}[1]
+{\begin{list}{}
+  {\setlength{\partopsep}{\parskip}
+   \addtolength{\partopsep}{\baselineskip}
+   \topsep0pt\itemsep0.15\baselineskip\parsep0pt
+   \leftmargin#1\relax}
+ \raggedright}
+{\end{list}}
+
+% From docutils.writers.latex2e
+% inline markup (custom roles)
+% \DUrole{#1}{#2} tries \DUrole#1{#2}
+\providecommand*{\DUrole}[2]{%
+  \ifcsname DUrole\detokenize{#1}\endcsname
+    \csname DUrole\detokenize{#1}\endcsname{#2}%
+  \else% backwards compatibility: try \docutilsrole#1{#2}
+    \ifcsname docutilsrole\detokenize{#1}\endcsname
+      \csname docutilsrole\detokenize{#1}\endcsname{#2}%
+    \else
+      #2%
+    \fi
+  \fi
+}
+
+\providecommand*{\DUprovidelength}[2]{%
+  \ifdefined#1\else\newlength{#1}\setlength{#1}{#2}\fi
+}
+
+\DUprovidelength{\DUlineblockindent}{2.5em}
+\ifdefined\DUlineblock\else
+  \newenvironment{DUlineblock}[1]{%
+    \list{}{\setlength{\partopsep}{\parskip}
+            \addtolength{\partopsep}{\baselineskip}
+            \setlength{\topsep}{0pt}
+            \setlength{\itemsep}{0.15\baselineskip}
+            \setlength{\parsep}{0pt}
+            \setlength{\leftmargin}{#1}}
+    \raggedright
+  }
+  {\endlist}
+\fi
+
+%% TEXT STYLING
+%
+% to obtain straight quotes we execute \@noligs as patched by upquote, and
+% \scantokens is needed in cases where it would be too late for the macro to
+% first set catcodes and then fetch its argument. We also make the contents
+% breakable at non-escaped . , ; ? ! / using \sphinxbreaksviaactive.
+% the macro must be protected if it ends up used in moving arguments,
+% in 'alltt' \@noligs is done already, and the \scantokens must be avoided.
+\protected\def\sphinxupquote#1{{\def\@tempa{alltt}%
+  \ifx\@tempa\@currenvir\else
+   \ifspx@opt@inlineliteralwraps
+      \sphinxbreaksviaactive\let\sphinxafterbreak\empty
+      % do not overwrite the comma set-up
+      \let\verbatim@nolig@list\sphinx@literal@nolig@list
+   \fi
+   % fix a space-gobbling issue due to LaTeX's original \do@noligs
+   \let\do@noligs\sphinx@do@noligs
+   \@noligs\endlinechar\m@ne\everyeof{}% (<- in case inside \sphinxhref)
+   \expandafter\scantokens
+  \fi {{#1}}}}% extra brace pair to fix end-space gobbling issue...
+\def\sphinx@do@noligs #1{\catcode`#1\active\begingroup\lccode`\~`#1\relax
+    \lowercase{\endgroup\def~{\leavevmode\kern\z@\char`#1 }}}
+\def\sphinx@literal@nolig@list {\do\`\do\<\do\>\do\'\do\-}%
+
+% Some custom font markup commands.
+\protected\def\sphinxstrong#1{\textbf{#1}}
+\protected\def\sphinxcode#1{\texttt{#1}}
+\protected\def\sphinxbfcode#1{\textbf{\sphinxcode{#1}}}
+\protected\def\sphinxemail#1{\textsf{#1}}
+\protected\def\sphinxtablecontinued#1{\textsf{#1}}
+\protected\def\sphinxtitleref#1{\emph{#1}}
+\protected\def\sphinxmenuselection#1{\emph{#1}}
+\protected\def\sphinxaccelerator#1{\underline{#1}}
+\protected\def\sphinxcrossref#1{\emph{#1}}
+\protected\def\sphinxtermref#1{\emph{#1}}
+% \optional is used for ``[, arg]``, i.e. desc_optional nodes.
+\long\protected\def\sphinxoptional#1{%
+  {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
+
+% additional customizable styling
+% FIXME: convert this to package options ?
+\protected\def\sphinxstyleindexentry   #1{\texttt{#1}}
+\protected\def\sphinxstyleindexextra   #1{ \emph{(#1)}}
+\protected\def\sphinxstyleindexpageref #1{, \pageref{#1}}
+\protected\def\sphinxstyletopictitle   #1{\textbf{#1}\par\medskip}
+\let\sphinxstylesidebartitle\sphinxstyletopictitle
+\protected\def\sphinxstyleothertitle   #1{\textbf{#1}}
+\protected\def\sphinxstylesidebarsubtitle #1{~\\\textbf{#1} \smallskip}
+% \text.. commands do not allow multiple paragraphs
+\protected\def\sphinxstyletheadfamily    {\sffamily}
+\protected\def\sphinxstyleemphasis     #1{\emph{#1}}
+\protected\def\sphinxstyleliteralemphasis#1{\emph{\sphinxcode{#1}}}
+\protected\def\sphinxstylestrong       #1{\textbf{#1}}
+\protected\def\sphinxstyleliteralstrong#1{\sphinxbfcode{#1}}
+\protected\def\sphinxstyleabbreviation #1{\textsc{#1}}
+\protected\def\sphinxstyleliteralintitle#1{\sphinxcode{#1}}
+\newcommand*\sphinxstylecodecontinued[1]{\footnotesize(#1)}%
+\newcommand*\sphinxstylecodecontinues[1]{\footnotesize(#1)}%
+% figure legend comes after caption and may contain arbitrary body elements
+\newenvironment{sphinxlegend}{\par\small}{\par}
+
+% Declare Unicode characters used by linux tree command to pdflatex utf8/utf8x
+\def\spx@bd#1#2{%
+  \leavevmode
+  \begingroup
+  \ifx\spx@bd@height   \@undefined\def\spx@bd@height{\baselineskip}\fi
+  \ifx\spx@bd@width    \@undefined\setbox0\hbox{0}\def\spx@bd@width{\wd0 }\fi
+  \ifx\spx@bd@thickness\@undefined\def\spx@bd@thickness{.6\p@}\fi
+  \ifx\spx@bd@lower    \@undefined\def\spx@bd@lower{\dp\strutbox}\fi
+  \lower\spx@bd@lower#1{#2}%
+  \endgroup
+}%
+\@namedef{sphinx@u2500}% BOX DRAWINGS LIGHT HORIZONTAL
+  {\spx@bd{\vbox to\spx@bd@height}
+          {\vss\hrule\@height\spx@bd@thickness
+                     \@width\spx@bd@width\vss}}%
+\@namedef{sphinx@u2502}% BOX DRAWINGS LIGHT VERTICAL
+  {\spx@bd{\hb@xt@\spx@bd@width}
+          {\hss\vrule\@height\spx@bd@height
+                     \@width \spx@bd@thickness\hss}}%
+\@namedef{sphinx@u2514}% BOX DRAWINGS LIGHT UP AND RIGHT
+  {\spx@bd{\hb@xt@\spx@bd@width}
+          {\hss\raise.5\spx@bd@height
+           \hb@xt@\z@{\hss\vrule\@height.5\spx@bd@height
+                                \@width \spx@bd@thickness\hss}%
+           \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness
+                                            \@width.5\spx@bd@width\vss}}}%
+\@namedef{sphinx@u251C}% BOX DRAWINGS LIGHT VERTICAL AND RIGHT
+  {\spx@bd{\hb@xt@\spx@bd@width}
+          {\hss
+           \hb@xt@\z@{\hss\vrule\@height\spx@bd@height
+                                \@width \spx@bd@thickness\hss}%
+           \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness
+                                            \@width.5\spx@bd@width\vss}}}%
+\protected\def\sphinxunichar#1{\@nameuse{sphinx@u#1}}%
+
+% Tell TeX about pathological hyphenation cases:
+\hyphenation{Base-HTTP-Re-quest-Hand-ler}
+\endinput
diff --git a/doc/build/latex/sphinxhighlight.sty b/doc/build/latex/sphinxhighlight.sty
new file mode 100644
index 0000000..77c7e2c
--- /dev/null
+++ b/doc/build/latex/sphinxhighlight.sty
@@ -0,0 +1,105 @@
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesPackage{sphinxhighlight}[2016/05/29 stylesheet for highlighting with pygments]
+
+
+\makeatletter
+\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
+    \let\PYG@ul=\relax \let\PYG@tc=\relax%
+    \let\PYG@bc=\relax \let\PYG@ff=\relax}
+\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
+\def\PYG@toks#1+{\ifx\relax#1\empty\else%
+    \PYG@tok{#1}\expandafter\PYG@toks\fi}
+\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
+    \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
+\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
+
+\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
+\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
+\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
+\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
+\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}}
+\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}}
+\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
+\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
+\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}}
+\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}}
+\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@ch\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@fm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
+\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}}
+\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@mb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}}
+\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@cpf\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
+\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+
+\def\PYGZbs{\char`\\}
+\def\PYGZus{\char`\_}
+\def\PYGZob{\char`\{}
+\def\PYGZcb{\char`\}}
+\def\PYGZca{\char`\^}
+\def\PYGZam{\char`\&}
+\def\PYGZlt{\char`\<}
+\def\PYGZgt{\char`\>}
+\def\PYGZsh{\char`\#}
+\def\PYGZpc{\char`\%}
+\def\PYGZdl{\char`\$}
+\def\PYGZhy{\char`\-}
+\def\PYGZsq{\char`\'}
+\def\PYGZdq{\char`\"}
+\def\PYGZti{\char`\~}
+% for compatibility with earlier versions
+\def\PYGZat{@}
+\def\PYGZlb{[}
+\def\PYGZrb{]}
+\makeatother
+
+\renewcommand\PYGZsq{\textquotesingle}
diff --git a/doc/build/latex/sphinxhowto.cls b/doc/build/latex/sphinxhowto.cls
new file mode 100644
index 0000000..11a49a2
--- /dev/null
+++ b/doc/build/latex/sphinxhowto.cls
@@ -0,0 +1,95 @@
+%
+% sphinxhowto.cls for Sphinx (http://sphinx-doc.org/)
+%
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesClass{sphinxhowto}[2017/03/26 v1.6 Document class (Sphinx HOWTO)]
+
+% 'oneside' option overriding the 'twoside' default
+\newif\if@oneside
+\DeclareOption{oneside}{\@onesidetrue}
+% Pass remaining document options to the parent class.
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}}
+\ProcessOptions\relax
+
+% Default to two-side document
+\if@oneside
+% nothing to do (oneside is the default)
+\else
+\PassOptionsToClass{twoside}{\sphinxdocclass}
+\fi
+
+\LoadClass{\sphinxdocclass}
+
+% Set some sane defaults for section numbering depth and TOC depth.  You can
+% reset these counters in your preamble.
+%
+\setcounter{secnumdepth}{2}
+\setcounter{tocdepth}{2}% i.e. section and subsection
+
+% Change the title page to look a bit better, and fit in with the fncychap
+% ``Bjarne'' style a bit better.
+%
+\renewcommand{\maketitle}{%
+  \noindent\rule{\textwidth}{1pt}\par
+    \begingroup % for PDF information dictionary
+       \def\endgraf{ }\def\and{\& }%
+       \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup
+       \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}%
+    \endgroup
+  \begin{flushright}
+    \sphinxlogo
+    \py@HeaderFamily
+    {\Huge \@title }\par
+    {\itshape\large \py@release \releaseinfo}\par
+    \vspace{25pt}
+    {\Large
+      \begin{tabular}[t]{c}
+        \@author
+      \end{tabular}}\par
+    \vspace{25pt}
+    \@date \par
+    \py@authoraddress \par
+  \end{flushright}
+  \@thanks
+  \setcounter{footnote}{0}
+  \let\thanks\relax\let\maketitle\relax
+  %\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
+}
+
+\newcommand{\sphinxtableofcontents}{
+  \begingroup
+    \parskip = 0mm
+    \tableofcontents
+  \endgroup
+  \rule{\textwidth}{1pt}
+  \vspace{12pt}
+}  
+
+\@ifundefined{fancyhf}{
+  \pagestyle{plain}}{
+  \pagestyle{normal}}		% start this way; change for
+\pagenumbering{arabic}		% ToC & chapters
+
+\thispagestyle{empty}
+
+% Fix the bibliography environment to add an entry to the Table of
+% Contents.
+% For an article document class this environment is a section,
+% so no page break before it.
+%
+\newenvironment{sphinxthebibliography}[1]{%
+  % \phantomsection % not needed here since TeXLive 2010's hyperref
+  \begin{thebibliography}{1}%
+  \addcontentsline{toc}{section}{\ifdefined\refname\refname\else\ifdefined\bibname\bibname\fi\fi}}{\end{thebibliography}}
+
+
+% Same for the indices.
+% The memoir class already does this, so we don't duplicate it in that case.
+%
+\@ifclassloaded{memoir}
+ {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}
+ {\newenvironment{sphinxtheindex}{%
+    \phantomsection % needed because no chapter, section, ... is created by theindex
+    \begin{theindex}%
+    \addcontentsline{toc}{section}{\indexname}}{\end{theindex}}}
diff --git a/doc/build/latex/sphinxmanual.cls b/doc/build/latex/sphinxmanual.cls
new file mode 100644
index 0000000..5b3d183
--- /dev/null
+++ b/doc/build/latex/sphinxmanual.cls
@@ -0,0 +1,114 @@
+%
+% sphinxmanual.cls for Sphinx (http://sphinx-doc.org/)
+%
+
+\NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesClass{sphinxmanual}[2017/03/26 v1.6 Document class (Sphinx manual)]
+
+% chapters starting at odd pages (overridden by 'openany' document option)
+\PassOptionsToClass{openright}{\sphinxdocclass}
+
+% 'oneside' option overriding the 'twoside' default
+\newif\if@oneside
+\DeclareOption{oneside}{\@onesidetrue}
+% Pass remaining document options to the parent class.
+\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}}
+\ProcessOptions\relax
+
+% Defaults two-side document
+\if@oneside
+% nothing to do (oneside is the default)
+\else
+\PassOptionsToClass{twoside}{\sphinxdocclass}
+\fi
+
+\LoadClass{\sphinxdocclass}
+
+% Set some sane defaults for section numbering depth and TOC depth.  You can
+% reset these counters in your preamble.
+%
+\setcounter{secnumdepth}{2}
+\setcounter{tocdepth}{1}
+
+% Change the title page to look a bit better, and fit in with the fncychap
+% ``Bjarne'' style a bit better.
+%
+\renewcommand{\maketitle}{%
+  \let\spx@tempa\relax
+  \ifHy@pageanchor\def\spx@tempa{\Hy@pageanchortrue}\fi
+  \hypersetup{pageanchor=false}% avoid duplicate destination warnings
+  \begin{titlepage}%
+    \let\footnotesize\small
+    \let\footnoterule\relax
+    \noindent\rule{\textwidth}{1pt}\par
+      \begingroup % for PDF information dictionary
+       \def\endgraf{ }\def\and{\& }%
+       \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup
+       \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}%
+      \endgroup
+    \begin{flushright}%
+      \sphinxlogo
+      \py@HeaderFamily
+      {\Huge \@title \par}
+      {\itshape\LARGE \py@release\releaseinfo \par}
+      \vfill
+      {\LARGE
+        \begin{tabular}[t]{c}
+          \@author
+        \end{tabular}
+        \par}
+      \vfill\vfill
+      {\large
+       \@date \par
+       \vfill
+       \py@authoraddress \par
+      }%
+    \end{flushright}%\par
+    \@thanks
+  \end{titlepage}%
+  \setcounter{footnote}{0}%
+  \let\thanks\relax\let\maketitle\relax
+  %\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
+  \if@openright\cleardoublepage\else\clearpage\fi
+  \spx@tempa
+}
+
+\newcommand{\sphinxtableofcontents}{%
+  \pagenumbering{roman}%
+  \pagestyle{plain}%
+  \begingroup
+    \parskip \z@skip
+    \tableofcontents
+  \endgroup
+  % before resetting page counter, let's do the right thing.
+  \if@openright\cleardoublepage\else\clearpage\fi
+  \pagenumbering{arabic}%
+  \ifdefined\fancyhf\pagestyle{normal}\fi
+}
+
+% This is needed to get the width of the section # area wide enough in the
+% library reference.  Doing it here keeps it the same for all the manuals.
+%
+\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}}
+\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}}
+
+% Fix the bibliography environment to add an entry to the Table of
+% Contents.
+% For a report document class this environment is a chapter.
+%
+\newenvironment{sphinxthebibliography}[1]{%
+  \if@openright\cleardoublepage\else\clearpage\fi
+  % \phantomsection % not needed here since TeXLive 2010's hyperref
+  \begin{thebibliography}{1}%
+  \addcontentsline{toc}{chapter}{\bibname}}{\end{thebibliography}}
+
+% Same for the indices.
+% The memoir class already does this, so we don't duplicate it in that case.
+%
+\@ifclassloaded{memoir}
+ {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}
+ {\newenvironment{sphinxtheindex}{%
+    \if@openright\cleardoublepage\else\clearpage\fi
+    \phantomsection % needed as no chapter, section, ... created
+    \begin{theindex}%
+    \addcontentsline{toc}{chapter}{\indexname}}{\end{theindex}}}
diff --git a/doc/build/latex/sphinxmulticell.sty b/doc/build/latex/sphinxmulticell.sty
new file mode 100644
index 0000000..f0d11b1
--- /dev/null
+++ b/doc/build/latex/sphinxmulticell.sty
@@ -0,0 +1,317 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{sphinxmulticell}%
+    [2017/02/23 v1.6 better span rows and columns of a table (Sphinx team)]%
+\DeclareOption*{\PackageWarning{sphinxmulticell}{Option `\CurrentOption' is unknown}}%
+\ProcessOptions\relax
+%
+% --- MULTICOLUMN ---
+% standard LaTeX's \multicolumn
+% 1. does not allow verbatim contents,
+% 2. interacts very poorly with tabulary.
+%
+% It is needed to write own macros for Sphinx: to allow code-blocks in merged
+% cells rendered by tabular/longtable, and to allow multi-column cells with
+% paragraphs to be taken into account sanely by tabulary algorithm for column
+% widths.
+%
+% This requires quite a bit of hacking. First, in Sphinx, the multi-column
+% contents will *always* be wrapped in a varwidth environment. The issue
+% becomes to pass it the correct target width. We must trick tabulary into
+% believing the multicolumn is simply separate columns, else tabulary does not
+% incorporate the contents in its algorithm. But then we must clear the
+% vertical rules...
+%
+% configuration of tabulary
+\setlength{\tymin}{3\fontcharwd\font`0 }% minimal width of "squeezed" columns
+\setlength{\tymax}{10000pt}% allow enough room for paragraphs to "compete"
+% we need access to tabulary's final computed width. \@tempdima is too volatile
+% to hope it has kept tabulary's value when \sphinxcolwidth needs it.
+\newdimen\sphinx@TY@tablewidth
+\def\tabulary{%
+  \def\TY@final{\sphinx@TY@tablewidth\@tempdima\tabular}%
+  \let\endTY@final\endtabular
+  \TY@tabular}%
+% next hack is needed only if user has set latex_use_latex_multicolumn to True:
+% it fixes tabulary's bug with \multicolumn defined "short" in first pass. (if
+% upstream tabulary adds a \long, our extra one causes no harm)
+\def\sphinx@tempa #1\def\multicolumn#2#3#4#5#6#7#8#9\sphinx@tempa
+   {\def\TY@tab{#1\long\def\multicolumn####1####2####3{\multispan####1\relax}#9}}%
+\expandafter\sphinx@tempa\TY@tab\sphinx@tempa
+%
+% TN. 1: as \omit is never executed, Sphinx multicolumn does not need to worry
+% like standard multicolumn about |l| vs l|. On the other hand it assumes
+% columns are separated by a | ... (if not it will add extraneous
+% \arrayrulewidth space for each column separation in its estimate of available
+% width).
+%
+% TN. 1b: as Sphinx multicolumn uses neither \omit nor \span, it can not
+% (easily) get rid of extra macros from >{...} or <{...} between columns. At
+% least, it has been made compatible with colortbl's \columncolor.
+%
+% TN. 2: tabulary's second pass is handled like tabular/longtable's single
+% pass, with the difference that we hacked \TY@final to set in
+% \sphinx@TY@tablewidth the final target width as computed by tabulary. This is
+% needed only to handle columns with a "horizontal" specifier: "p" type columns
+% (inclusive of tabulary's LJRC) holds the target column width in the
+% \linewidth dimension.
+%
+% TN. 3: use of \begin{sphinxmulticolumn}...\end{sphinxmulticolumn} mark-up
+% would need some hacking around the fact that groups can not span across table
+% cells (the code does inserts & tokens, see TN1b). It was decided to keep it
+% simple with \sphinxstartmulticolumn...\sphinxstopmulticolumn.
+%
+% MEMO about nesting: if sphinxmulticolumn is encountered in a nested tabular
+% inside a tabulary it will think to be at top level in the tabulary. But
+% Sphinx generates no nested tables, and if some LaTeX macro uses internally a
+% tabular this will not have a \sphinxstartmulticolumn within it!
+%
+\def\sphinxstartmulticolumn{%
+    \ifx\equation$% $ tabulary's first pass
+        \expandafter\sphinx@TYI@start@multicolumn
+    \else % either not tabulary or tabulary's second pass
+        \expandafter\sphinx@start@multicolumn
+    \fi
+}%
+\def\sphinxstopmulticolumn{%
+    \ifx\equation$% $ tabulary's first pass
+        \expandafter\sphinx@TYI@stop@multicolumn
+    \else % either not tabulary or tabulary's second pass
+        \ignorespaces
+    \fi
+}%
+\def\sphinx@TYI@start@multicolumn#1{%
+    % use \gdef always to avoid stack space build up
+    \gdef\sphinx@tempa{#1}\begingroup\setbox\z@\hbox\bgroup
+}%
+\def\sphinx@TYI@stop@multicolumn{\egroup % varwidth was used with \tymax
+    \xdef\sphinx@tempb{\the\dimexpr\wd\z@/\sphinx@tempa}% per column width
+    \endgroup
+    \expandafter\sphinx@TYI@multispan\expandafter{\sphinx@tempa}%
+}%
+\def\sphinx@TYI@multispan #1{%
+    \kern\sphinx@tempb\ignorespaces % the per column occupied width
+    \ifnum#1>\@ne % repeat, taking into account subtleties of TeX's & ...
+      \expandafter\sphinx@TYI@multispan@next\expandafter{\the\numexpr#1-\@ne\expandafter}%
+    \fi
+}%
+\def\sphinx@TYI@multispan@next{&\relax\sphinx@TYI@multispan}%
+%
+% Now the branch handling either the second pass of tabulary or the single pass
+% of tabular/longtable. This is the delicate part where we gather the
+% dimensions from the p columns either set-up by tabulary or by user p column
+% or Sphinx \X, \Y columns. The difficulty is that to get the said width, the
+% template must be inserted (other hacks would be horribly complicated except
+% if we rewrote crucial parts of LaTeX's \@array !) and we can not do
+% \omit\span like standard \multicolumn's easy approach. Thus we must cancel
+% the \vrule separators. Also, perhaps the column specifier is of the l, c, r
+% type, then we attempt an ad hoc rescue to give varwidth a reasonable target
+% width.
+\def\sphinx@start@multicolumn#1{%
+    \gdef\sphinx@multiwidth{0pt}\gdef\sphinx@tempa{#1}\sphinx@multispan{#1}%
+}%
+\def\sphinx@multispan #1{%
+    \ifnum#1=\@ne\expandafter\sphinx@multispan@end
+            \else\expandafter\sphinx@multispan@next
+    \fi {#1}%
+}%
+\def\sphinx@multispan@next #1{%
+    % trick to recognize L, C, R, J or p, m, b type columns
+    \ifdim\baselineskip>\z@
+       \gdef\sphinx@tempb{\linewidth}%
+    \else
+    % if in an l, r, c type column, try and hope for the best
+       \xdef\sphinx@tempb{\the\dimexpr(\ifx\TY@final\@undefined\linewidth\else
+            \sphinx@TY@tablewidth\fi-\arrayrulewidth)/\sphinx@tempa
+            -\tw@\tabcolsep-\arrayrulewidth\relax}%
+    \fi
+    \noindent\kern\sphinx@tempb\relax
+    \xdef\sphinx@multiwidth
+           {\the\dimexpr\sphinx@multiwidth+\sphinx@tempb+\tw@\tabcolsep+\arrayrulewidth}%
+    % hack the \vline and the colortbl macros
+    \sphinx@hack@vline\sphinx@hack@CT&\relax
+    % repeat
+    \expandafter\sphinx@multispan\expandafter{\the\numexpr#1-\@ne}%
+}%
+% packages like colortbl add group levels, we need to "climb back up" to be
+% able to hack the \vline and also the colortbl inserted tokens. This creates
+% empty space whether or not the columns were | separated:
+\def\sphinx@hack@vline{\ifnum\currentgrouptype=6\relax
+    \kern\arrayrulewidth\arrayrulewidth\z@\else\aftergroup\sphinx@hack@vline\fi}%
+\def\sphinx@hack@CT{\ifnum\currentgrouptype=6\relax
+    \let\CT@setup\sphinx@CT@setup\else\aftergroup\sphinx@hack@CT\fi}%
+% It turns out \CT@row@color is not expanded contrarily to \CT@column@color
+% during LaTeX+colortbl preamble preparation, hence it would be possible for
+% \sphinx@CT@setup to discard only the column color and choose to obey or not
+% row color and cell color. It would even be possible to propagate cell color
+% to row color for the duration of the Sphinx multicolumn... the (provisional?)
+% choice has been made to cancel the colortbl colours for the multicolumn
+% duration.
+\def\sphinx@CT@setup #1\endgroup{\endgroup}% hack to remove colour commands
+\def\sphinx@multispan@end#1{%
+    % first, trace back our steps horizontally
+    \noindent\kern-\dimexpr\sphinx@multiwidth\relax
+    % and now we set the final computed width for the varwidth environment
+    \ifdim\baselineskip>\z@
+       \xdef\sphinx@multiwidth{\the\dimexpr\sphinx@multiwidth+\linewidth}%
+    \else
+       \xdef\sphinx@multiwidth{\the\dimexpr\sphinx@multiwidth+
+         (\ifx\TY@final\@undefined\linewidth\else
+          \sphinx@TY@tablewidth\fi-\arrayrulewidth)/\sphinx@tempa
+          -\tw@\tabcolsep-\arrayrulewidth\relax}%
+    \fi
+    % we need to remove colour set-up also for last cell of the multi-column
+    \aftergroup\sphinx@hack@CT
+}%
+\newcommand*\sphinxcolwidth[2]{%
+  % this dimension will always be used for varwidth, and serves as maximum
+  % width when cells are merged either via multirow or multicolumn or both,
+  % as always their contents is wrapped in varwidth environment.
+  \ifnum#1>\@ne % multi-column (and possibly also multi-row)
+  % we wrote our own multicolumn code especially to handle that (and allow
+  % verbatim contents)
+   \ifx\equation$%$
+       \tymax % first pass of tabulary (cf MEMO above regarding nesting)
+   \else % the \@gobble thing is for compatibility with standard \multicolumn
+       \sphinx@multiwidth\@gobble{#1/#2}%
+   \fi
+  \else % single column multirow
+   \ifx\TY@final\@undefined % not a tabulary.
+    \ifdim\baselineskip>\z@
+        % in a p{..} type column, \linewidth is the target box width
+        \linewidth
+    \else
+        % l, c, r columns. Do our best.
+        \dimexpr(\linewidth-\arrayrulewidth)/#2-
+                \tw@\tabcolsep-\arrayrulewidth\relax
+    \fi
+   \else % in tabulary
+    \ifx\equation$%$% first pass
+        \tymax % it is set to a big value so that paragraphs can express themselves
+    \else
+     % second pass.
+     \ifdim\baselineskip>\z@
+         \linewidth % in a L, R, C, J column or a p, \X, \Y ...
+     \else
+         % we have hacked \TY@final to put in \sphinx@TY@tablewidth the table width
+         \dimexpr(\sphinx@TY@tablewidth-\arrayrulewidth)/#2-
+                 \tw@\tabcolsep-\arrayrulewidth\relax
+     \fi
+    \fi
+   \fi
+  \fi
+}%
+% fallback default in case user has set latex_use_latex_multicolumn to True:
+% \sphinxcolwidth will use this only inside LaTeX's standard \multicolumn
+\def\sphinx@multiwidth #1#2{\dimexpr % #1 to gobble the \@gobble (!)
+    (\ifx\TY@final\@undefined\linewidth\else\sphinx@TY@tablewidth\fi
+     -\arrayrulewidth)*#2-\tw@\tabcolsep-\arrayrulewidth\relax}%
+%
+% --- MULTIROW ---
+% standard \multirow
+% 1. does not allow verbatim contents,
+% 2. does not allow blank lines in its argument,
+% 3. its * specifier means to typeset "horizontally" which is very
+%    bad for paragraph content. 2016 version has = specifier but it
+%    must be used with p type columns only, else results are bad,
+% 4. it requires manual intervention if the contents is too long to fit
+%    in the asked-for number of rows.
+% 5. colour panels (either from \rowcolor or \columncolor) will hide
+%    the bottom part of multirow text, hence manual tuning is needed
+%    to put the multirow insertion at the _bottom_.
+%
+% The Sphinx solution consists in always having contents wrapped
+% in a varwidth environment so that it makes sense to estimate how many
+% lines it will occupy, and then ensure by insertion of suitable struts
+% that the table rows have the needed height. The needed mark-up is done
+% by LaTeX writer, which has its own id for the merged cells.
+%
+% The colour issue is solved by clearing colour panels in all cells,
+% whether or not the multirow is single-column or multi-column.
+%
+% In passing we obtain baseline alignements across rows (only if
+% \arraylinestretch is 1, as LaTeX's does not obey \arraylinestretch in "p"
+% multi-line contents, only first and last line...)
+%
+% TODO: examine the situation with \arraylinestretch > 1. The \extrarowheight
+% is hopeless for multirow anyhow, it makes baseline alignment strictly
+% impossible.
+\newcommand\sphinxmultirow[2]{\begingroup
+  % #1 = nb of spanned rows, #2 = Sphinx id of "cell", #3 = contents
+  % but let's fetch #3 in a way allowing verbatim contents !
+  \def\sphinx@nbofrows{#1}\def\sphinx@cellid{#2}%
+  \afterassignment\sphinx@multirow\let\next=
+}%
+\def\sphinx@multirow {%
+  \setbox\z@\hbox\bgroup\aftergroup\sphinx@@multirow\strut
+}%
+\def\sphinx@@multirow {%
+  % The contents, which is a varwidth environment, has been captured in
+  % \box0 (a \hbox).
+  % We have with \sphinx@cellid an assigned unique id. The goal is to give
+  % about the same height to all the involved rows.
+  % For this Sphinx will insert a \sphinxtablestrut{cell_id} mark-up
+  % in LaTeX file and the expansion of the latter will do the suitable thing.
+  \dimen@\dp\z@
+  \dimen\tw@\ht\@arstrutbox
+  \advance\dimen@\dimen\tw@
+  \advance\dimen\tw@\dp\@arstrutbox
+  \count@=\dimen@       % type conversion dim -> int
+  \count\tw@=\dimen\tw@
+  \divide\count@\count\tw@ % TeX division truncates
+  \advance\dimen@-\count@\dimen\tw@
+  % 1300sp is about 0.02pt. For comparison a rule default width is 0.4pt.
+  % (note that if \count@ holds 0, surely \dimen@>1300sp)
+  \ifdim\dimen@>1300sp \advance\count@\@ne \fi
+  % now \count@ holds the count L of needed "lines"
+  % and \sphinx@nbofrows holds the number N of rows
+  % we have L >= 1 and N >= 1
+  % if L is a multiple of N, ... clear what to do !
+  % else write L = qN + r, 1 <= r < N and we will
+  % arrange for each row to have enough space for:
+  %     q+1 "lines" in each of the first r rows
+  %       q "lines" in each of the (N-r) bottom rows
+  % for a total of (q+1) * r + q * (N-r) = q * N + r = L
+  % It is possible that q == 0.
+  \count\tw@\count@
+  % the TeX division truncates
+  \divide\count\tw@\sphinx@nbofrows\relax
+  \count4\count\tw@ % q
+  \multiply\count\tw@\sphinx@nbofrows\relax
+  \advance\count@-\count\tw@ % r
+  \expandafter\xdef\csname sphinx@tablestrut_\sphinx@cellid\endcsname
+     {\noexpand\sphinx@tablestrut{\the\count4}{\the\count@}{\sphinx@cellid}}%
+  \dp\z@\z@
+  % this will use the real height if it is >\ht\@arstrutbox
+  \sphinxtablestrut{\sphinx@cellid}\box\z@
+  \endgroup % group was opened in \sphinxmultirow
+}%
+\newcommand*\sphinxtablestrut[1]{%
+  % #1 is a "cell_id", i.e. the id of a merged group of table cells
+  \csname sphinx@tablestrut_#1\endcsname
+}%
+% LaTeX typesets the table row by row, hence each execution can do
+% an update for the next row.
+\newcommand*\sphinx@tablestrut[3]{\begingroup
+  % #1 = q, #2 = (initially) r, #3 = cell_id, q+1 lines in first r rows
+  % if #2 = 0, create space for max(q,1) table lines
+  % if #2 > 0, create space for q+1 lines and decrement #2
+  \leavevmode
+  \count@#1\relax
+  \ifnum#2=\z@
+    \ifnum\count@=\z@\count@\@ne\fi
+  \else
+    % next row will be with a #2 decremented by one
+    \expandafter\xdef\csname sphinx@tablestrut_#3\endcsname
+      {\noexpand\sphinx@tablestrut{#1}{\the\numexpr#2-\@ne}{#3}}%
+   \advance\count@\@ne
+  \fi
+  \vrule\@height\ht\@arstrutbox
+        \@depth\dimexpr\count@\ht\@arstrutbox+\count@\dp\@arstrutbox-\ht\@arstrutbox\relax
+        \@width\z@
+  \endgroup
+  % we need this to avoid colour panels hiding bottom parts of multirow text
+  \sphinx@hack@CT
+}%
+\endinput
+%%
+%% End of file `sphinxmulticell.sty'.
diff --git a/doc/src/write_command.rst b/doc/src/write_command.rst
index a50999d..a3f48f8 100644
--- a/doc/src/write_command.rst
+++ b/doc/src/write_command.rst
@@ -128,9 +128,9 @@ Here is a *hello* command, file *commands/hello.py*:
         (options, args) = parser.parse_args(args)
         # algorithm
         if not options.french:
-            logger.write('HELLO! WORLD!\n')
+            logger.info('HELLO! WORLD!\n')
         else:
-            logger.write('Bonjour tout le monde!\n')
+            logger.writeinfo('Bonjour tout le monde!\n')
             
 A first call of hello:
 
diff --git a/src/coloringSat.py b/src/coloringSat.py
index 310f231..c7bb61d 100755
--- a/src/coloringSat.py
+++ b/src/coloringSat.py
@@ -10,6 +10,9 @@ so '' are not supposed existing in log message
 "{}".format() is not choosen because "{}" are present
 in log messages of contents of python dict (as JSON) etc.
 
+usage:
+>> import src.coloringSat as COLS
+
 example:
 >> log("this is in color green, OK is in blue: OK?")
 """
diff --git a/src/debug.py b/src/debug.py
index 4542134..0718b42 100644
--- a/src/debug.py
+++ b/src/debug.py
@@ -36,7 +36,8 @@ import sys
 import traceback
 import StringIO as SIO
 import pprint as PP
-
+import src.coloringSat as COLS
+        
 _debug = [False] #support push/pop for temporary activate debug outputs
 
 _user = os.environ['USER']
@@ -49,17 +50,31 @@ def indent(text, amount=2, ch=' '):
     padding = amount * ch
     return ''.join(padding + line for line in text.splitlines(True))
 
+def isTypeConfig(var):
+    """To know if var is instance from Config/pyconf"""
+    typ = str(type(var))
+    # print "isTypeConfig" ,type, dir(var)
+    if ".pyconf.Config" in typ: return True
+    if ".pyconf.Mapping" in typ: return True
+    if ".pyconf.Sequence" in typ: return True
+    # print "NOT isTypeConfig %s" % typ
+    return False
+    
 def write(title, var="", force=None, fmt="\n#### DEBUG: %s:\n%s\n"):
     """write sys.stderr a message if _debug[-1]==True or optionaly force=True"""
     if _debug[-1] or force:
-        if '.Config' in str(type(var)): 
-            sys.stderr.write(fmt % (title, indent(getStrConfigDbg(var))))
-        if 'loggingSat.UnittestStream' in str(type(var)): 
-            sys.stderr.write(fmt % (title, indent(var.getLogs())))
-        elif type(var) is not str:
-            sys.stderr.write(fmt % (title, indent(PP.pformat(var))))
-        else:
-            sys.stderr.write(fmt % (title, indent(var)))
+      typ = str(type(var))
+      if isTypeConfig(var):
+        sys.stderr.write(fmt % (title, indent(COLS.toColor(getStrConfigDbg(var)))))
+        return
+      if 'loggingSat.UnittestStream' in typ: 
+        sys.stderr.write(fmt % (title, indent(var.getLogs())))
+        return
+      if type(var) is not str:
+        sys.stderr.write(fmt % (title, indent(PP.pformat(var))))
+        return
+      sys.stderr.write(fmt % (title, indent(var)))
+      return
     return
 
 def tofix(title, var="", force=None):
@@ -206,6 +221,6 @@ def _saveConfigRecursiveDbg(config, aStream, indent, path):
         aStream.write("%s%s.%s : '%s'\n" % (indstr, path, key, str(value)))
         continue
       try:
-        aStream.write("!!! TODO fix that %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value)))
+        aStream.write("!!! TODO fix that %s %s%s.%s : %s\n" % (type(value), indstr, path, key, str(value)))
       except Exception as e:      
         aStream.write("%s%s.%s : !!! %s\n" % (indstr, path, key, e.message))
diff --git a/src/product.py b/src/product.py
index cf419ca..dcc289a 100644
--- a/src/product.py
+++ b/src/product.py
@@ -16,7 +16,7 @@
 #  License along with this library; if not, write to the Free Software
 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 
-"""\
+"""
 Contains the methods 
 relative to the product notion of salomeTools
 """
@@ -33,7 +33,8 @@ VERSION_DELIMITER = "_to_"
 
 def get_product_config(config, product_name, with_install_dir=True):
     """
-    Get the specific configuration of a product from the global configuration
+    Get the specific configuration of a product 
+    from the global configuration
     
     :param config: (Config) The global configuration
     :param product_name: (str) The name of the product
@@ -290,7 +291,6 @@ def get_product_section(config, product_name, version, section=None):
       (if not None, the section is explicitly given)
     :return: (Config) The product description
     """
-
     # if section is not None, try to get the corresponding section
     if section:
         if section not in config.PRODUCTS[product_name]:
@@ -466,27 +466,24 @@ def check_config_exists(config, prod_dir, prod_info):
     
     return False, None
             
-            
-    
-def get_products_infos(lproducts, config):
+def get_products_infos(products, config):
     """Get the specific configuration of a list of products
     
-    :param lproducts: (list) The list of product names
+    :param products: (list) The list of product names
     :param config: (Config) The global configuration
     :return: (list) of tuples (str, Config)
       as (product name, specific configuration of the product)
     """
     products_infos = []
     # Loop on product names
-    for prod in lproducts:       
-        # Get the specific configuration of the product
-        prod_info = get_product_config(config, prod)
-        if prod_info is not None:
-            products_infos.append((prod, prod_info))
-        else:
-            msg = _("The %s product has no definition "
-                    "in the configuration.") % prod
-            raise Exception(msg)
+    for prod in products:       
+      # Get the specific configuration of the product
+      prod_info = get_product_config(config, prod)
+      if prod_info is not None:
+        products_infos.append((prod, prod_info))
+      else:
+        msg = _("The product '%s' has no definition in the configuration.") % prod
+        raise Exception(msg)
     return products_infos
 
 def get_product_dependencies(config, product_info):
diff --git a/src/utilsSat.py b/src/utilsSat.py
index e52df60..4769bce 100644
--- a/src/utilsSat.py
+++ b/src/utilsSat.py
@@ -37,6 +37,7 @@ import re
 import tempfile
 
 import src.returnCode as RCO
+import src.debug as DBG # Easy print stderr (for DEBUG only)
 
 
 ##############################################################################
@@ -47,7 +48,7 @@ def ensure_path_exists(path):
     
     :param path: (str) The path.
     """
-    print "the path",path
+    # DBG.write("ensure_path_exists", path, True)
     if not os.path.exists(path):
         os.makedirs(path)
         
@@ -212,7 +213,25 @@ def handleRemoveReadonly(func, path, exc):
 ##############################################################################
 # pyconf config utilities
 ##############################################################################
-def check_config_has_application( config, details = None ):
+        
+def check_has_key(inConfig, key):
+    """Check that the in-Config node has the named key (as an attribute) 
+    
+    :param inConfig: (Config or Mapping etc) The in-Config node
+    :param key: (str) The key to check presence in in-Config node
+    :return: (RCO.ReturnCode) 'OK' if presence
+    """
+    debug = True
+    if key not in inConfig:
+      msg = _("check_has_key '%s' not found" % key)
+      DBG.write("check_has_key", msg, debug)
+      return RCO.ReturnCode("KO", msg)
+    else:
+      msg = _("check_has_key '%s' found" % key)
+      DBG.write("check_has_key", msg, debug)
+      return RCO.ReturnCode("OK", msg)
+         
+def check_config_has_application(config):
     """
     Check that the config has the key APPLICATION. 
     Else raise an exception.
@@ -220,28 +239,33 @@ def check_config_has_application( config, details = None ):
     :param config: (Config) The config.
     """
     if 'APPLICATION' not in config:
-        msg = _("An  is required.")
-        msg += "\n" + _("(as 'sat prepare ')")
-        msg += "\n" + _("Use 'sat config --list' to get the list of available applications.")
-        if details :
-            details.append(msg)
-        raise Exception(msg)
+      msg = _("An application name is required.")
+      msg += "\n" + _("(as 'sat prepare ')")
+      msg += "\n" + _("Use 'sat config --list' to get the list of available applications.")
+      DBG.write("check_config_has_application", msg)
+      return RCO.ReturnCode("KO", msg)
+    else:
+      msg = _("APPLICATION '%s' found." % config)
+      DBG.write("check_config_has_application", msg)
+      return RCO.ReturnCode("OK", msg)
 
-def check_config_has_profile( config, details = None ):
+def check_config_has_profile(config):
     """
     Check that the config has the key APPLICATION.profile.
     Else, raise an exception.
     
     :param config: (Config) The config.
     """
-    check_config_has_application(config)
+    check_config_has_application(config).raiseIfKo()
     if 'profile' not in config.APPLICATION:
-        message = _("A profile section is required in your application.\n")
-        if details :
-            details.append(message)
-        raise Exception( message )
+      msg = _("An 'APPLICATION.profile' section is required in config.")
+      return RCO.ReturnCode("KO", msg)
+    else:
+      msg = _("An 'APPLICATION.profile' is found in config.")
+      return RCO.ReturnCode("OK", msg)
+
 
-def config_has_application( config ):
+def config_has_application(config):
     return 'APPLICATION' in config
 
 def get_cfg_param(config, param_name, default):
@@ -274,19 +298,20 @@ def get_base_path(config):
     return base_path
 
 def get_launcher_name(config):
-    """Returns the name of salome launcher.
+    """Returns the name of application file launcher, 'salome' by default.
     
     :param config: (Config) The global Config instance.
     :return: (str) The name of salome launcher.
     """
-    check_config_has_application(config)
-    if 'profile' in config.APPLICATION and 'launcher_name' in config.APPLICATION.profile:
+    check_config_has_application(config).raiseIfKo()
+    if 'profile' in config.APPLICATION and \
+       'launcher_name' in config.APPLICATION.profile:
         launcher_name = config.APPLICATION.profile.launcher_name
     else:
         launcher_name = 'salome'
-
     return launcher_name
 
+
 def get_log_path(config):
     """Returns the path of the logs.
     
@@ -349,7 +374,7 @@ def get_property_in_product_cfg(product_cfg, pprty):
     return product_cfg.properties[pprty]
 
 ##############################################################################
-# logger and color utilities
+# logger utilities
 ##############################################################################
 def formatTuples(tuples):
     """
@@ -381,13 +406,25 @@ def formatValue(label, value, suffix=""):
     
 def logger_info_tuples(logger, tuples):
     """
-    for convenience
+    For convenience
     format as formatTuples() and call logger.info()
     """
     msg = formatTuples(tuples)
     logger.info(msg)
 
-# for convenience    
+def log_step(logger, header, step):
+    logger.info("\r%s%s" % (header, " " * 20))
+    logger.info("\r%s%s" % (header, step))
+
+def log_res_step(logger, res):
+    if res == 0:
+        logger.info("\n")
+    else:
+        logger.info("\n")
+
+##############################################################################
+# color utilities, for convenience    
+##############################################################################
 _colors = "BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE".lower().split(" ")
     
 def black(msg):
@@ -501,10 +538,8 @@ def parse_date(date):
 
 
 ##############################################################################
-# log utilities (TODO: set in loggingSat class, later, changing tricky xml ?
-##############################################################################
-
-    
+# log utilities (TODO: set in loggingSat class, later, changing tricky xml?
+##############################################################################    
 def date_to_datetime(date):
     """
     From a string date in format YYYYMMDD_HHMMSS

            
      
             
            
      
            
        c