diff --git a/daliuge-engine/dlg/apps/bash_shell_app.py b/daliuge-engine/dlg/apps/bash_shell_app.py index 29d224079..e886c36c2 100644 --- a/daliuge-engine/dlg/apps/bash_shell_app.py +++ b/daliuge-engine/dlg/apps/bash_shell_app.py @@ -331,27 +331,27 @@ def execute(self, data): # @par EAGLE_START # @param category BashShellApp # @param tag template -# @param[in] cparam/command Command//String/readwrite/False/ +# @param[in] cparam/command Command//String/readwrite/False//False/ # \~English The command to be executed -# @param[in] cparam/input_redirection Input Redirection//String/readwrite/False/ +# @param[in] cparam/input_redirection Input Redirection//String/readwrite/False//False/ # \~English The command line argument that specifies the input into this application -# @param[in] cparam/output_redirection Output Redirection//String/readwrite/False/ +# @param[in] cparam/output_redirection Output Redirection//String/readwrite/False//False/ # \~English The command line argument that specifies the output from this application -# @param[in] cparam/command_line_arguments Command Line Arguments//String/readwrite/False/ +# @param[in] cparam/command_line_arguments Command Line Arguments//String/readwrite/False//False/ # \~English Additional command line arguments to be added to the command line to be executed -# @param[in] cparam/paramValueSeparator Param value separator/ /String/readwrite/False/ +# @param[in] cparam/paramValueSeparator Param value separator/ /String/readwrite/False//False/ # \~English Separator character(s) between parameters on the command line -# @param[in] cparam/argumentPrefix Argument prefix/"--"/String/readwrite/False/ +# @param[in] cparam/argumentPrefix Argument prefix/"--"/String/readwrite/False//False/ # \~English Prefix to each keyed argument on the command line -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up # @par EAGLE_END class BashShellApp(BashShellBase, BarrierAppDROP): diff --git a/daliuge-engine/dlg/apps/crc.py b/daliuge-engine/dlg/apps/crc.py index dd696b73e..baf3a21f4 100644 --- a/daliuge-engine/dlg/apps/crc.py +++ b/daliuge-engine/dlg/apps/crc.py @@ -79,17 +79,17 @@ def run(self): # @par EAGLE_START # @param category PythonApp # @param tag daliuge -# @param[in] cparam/appclass Application Class/dlg.apps.crc.CRCStreamApp/String/readonly/False/ +# @param[in] cparam/appclass Application Class/dlg.apps.crc.CRCStreamApp/String/readonly/False//False/ # \~English Application class -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up # @param[out] port/data Data/String/ # @par EAGLE_END diff --git a/daliuge-engine/dlg/apps/dockerapp.py b/daliuge-engine/dlg/apps/dockerapp.py index 8794a063c..1dcd1512e 100644 --- a/daliuge-engine/dlg/apps/dockerapp.py +++ b/daliuge-engine/dlg/apps/dockerapp.py @@ -74,43 +74,43 @@ def waitForIp(self, timeout=None): # @par EAGLE_START # @param category Docker # @param tag template -# @param[in] cparam/image Image//String/readwrite/False/ +# @param[in] cparam/image Image//String/readwrite/False//False/ # \~English The name of the docker image to be used for this application -# @param[in] cparam/tag Tag/1.0/String/readwrite/False/ +# @param[in] cparam/tag Tag/1.0/String/readwrite/False//False/ # \~English The tag of the docker image to be used for this application -# @param[in] cparam/digest Digest//String/readwrite/False/ +# @param[in] cparam/digest Digest//String/readwrite/False//False/ # \~English The hexadecimal hash (long version) of the docker image to be used for this application -# @param[in] cparam/command Command//String/readwrite/False/ +# @param[in] cparam/command Command//String/readwrite/False//False/ # \~English The command line to run within the docker instance. The specified command will be executed in a bash shell. That means that images will need a bash shell. -# @param[in] cparam/input_redirection Input Redirection//String/readwrite/False/ +# @param[in] cparam/input_redirection Input Redirection//String/readwrite/False//False/ # \~English The command line argument that specifies the input into this application -# @param[in] cparam/output_redirection Output Redirection//String/readwrite/False/ +# @param[in] cparam/output_redirection Output Redirection//String/readwrite/False//False/ # \~English The command line argument that specifies the output from this application -# @param[in] cparam/command_line_arguments Command Line Arguments//String/readwrite/False/ +# @param[in] cparam/command_line_arguments Command Line Arguments//String/readwrite/False//False/ # \~English Additional command line arguments to be added to the command line to be executed -# @param[in] cparam/paramValueSeparator Param value separator/ /String/readwrite/False/ +# @param[in] cparam/paramValueSeparator Param value separator/ /String/readwrite/False//False/ # \~English Separator character(s) between parameters on the command line -# @param[in] cparam/argumentPrefix Argument prefix/"--"/String/readwrite/False/ +# @param[in] cparam/argumentPrefix Argument prefix/"--"/String/readwrite/False//False/ # \~English Prefix to each keyed argument on the command line -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up -# @param[in] cparam/user User//String/readwrite/False/ +# @param[in] cparam/user User//String/readwrite/False//False/ # \~English Username of the user who will run the application within the docker image -# @param[in] cparam/ensureUserAndSwitch Ensure User And Switch/False/Boolean/readwrite/False/ +# @param[in] cparam/ensureUserAndSwitch Ensure User And Switch/False/Boolean/readwrite/False//False/ # \~English Make sure the user specified in the User parameter exists and then run the docker container as that user -# @param[in] cparam/removeContainer Remove Container/True/Boolean/readwrite/False/ +# @param[in] cparam/removeContainer Remove Container/True/Boolean/readwrite/False//False/ # \~English Instruct Docker engine to delete the container after execution is complete -# @param[in] cparam/additionalBindings Additional Bindings//String/readwrite/False/ +# @param[in] cparam/additionalBindings Additional Bindings//String/readwrite/False//False/ # \~English Directories which will be visible inside the container during run-time. Format is srcdir_on_host:trgtdir_on_container. Multiple entries can be separated by commas. -# @param[in] cparam/portMappings Port Mappings//String/readwrite/False/ +# @param[in] cparam/portMappings Port Mappings//String/readwrite/False//False/ # \~English Port mappings on the host machine # @par EAGLE_END class DockerApp(BarrierAppDROP): @@ -345,7 +345,7 @@ def initialize(self, **kwargs): logger.debug("Image '%s' found, no need to pull it", self._image) # Check if the image specifies a working directory - # If it doesn't use the one provided by the user. + # If it doesn't use the one provided by the user. # If none is provided use the session directory inspection = c.api.inspect_image(self._image) logger.debug("Docker Image inspection: %r", inspection) @@ -498,7 +498,7 @@ def run(self): addEnv[key] = value env.update(addEnv) elif isinstance(addEnv, list): # if it is a list populate from host environment - for e in addEnv: + for e in addEnv: env.update(os.environ[e]) else: logger.warning("Ignoring provided environment variables: Format wrong! Check documentation") diff --git a/daliuge-engine/dlg/apps/dynlib.py b/daliuge-engine/dlg/apps/dynlib.py index 9706df837..ef03a5407 100644 --- a/daliuge-engine/dlg/apps/dynlib.py +++ b/daliuge-engine/dlg/apps/dynlib.py @@ -354,17 +354,17 @@ def addStreamingInput(self, streamingInputDrop, back=True): # @par EAGLE_START # @param category DynlibApp # @param tag template -# @param[in] cparam/libpath Library Path//String/readwrite/False/ +# @param[in] cparam/libpath Library Path//String/readwrite/False//False/ # \~English The location of the shared object/DLL that implements this application -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up # @par EAGLE_END class DynlibApp(DynlibAppBase, BarrierAppDROP): diff --git a/daliuge-engine/dlg/apps/simple.py b/daliuge-engine/dlg/apps/simple.py index a01357934..3a8320eaf 100644 --- a/daliuge-engine/dlg/apps/simple.py +++ b/daliuge-engine/dlg/apps/simple.py @@ -113,19 +113,19 @@ def run(self): # @par EAGLE_START # @param category PythonApp # @param tag daliuge -# @param[in] cparam/appclass Application Class/dlg.apps.simple.CopyApp/String/readonly/False/ +# @param[in] cparam/appclass Application Class/dlg.apps.simple.CopyApp/String/readonly/False//False/ # \~English Application class -# @param[in] cparam/bufsize buffer size/65536/Integer/readwrite/False/ +# @param[in] cparam/bufsize buffer size/65536/Integer/readwrite/False//False/ # \~English Application class -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up # @par EAGLE_END class CopyApp(BarrierAppDROP): @@ -290,17 +290,17 @@ def _getArray(self): # @param tag daliuge # @param[in] aparam/method Method/mean/Select/readwrite/False/mean,median/False/ # \~English The method used for averaging -# @param[in] cparam/appclass Application Class/dlg.apps.simple.AverageArraysApp/String/readonly/False/ +# @param[in] cparam/appclass Application Class/dlg.apps.simple.AverageArraysApp/String/readonly/False//False/ # \~English Application class -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up # @param[in] port/array Array/array/ # \~English Port for the input array(s) diff --git a/daliuge-engine/dlg/drop.py b/daliuge-engine/dlg/drop.py index 14d521b13..871c60ddb 100644 --- a/daliuge-engine/dlg/drop.py +++ b/daliuge-engine/dlg/drop.py @@ -1523,15 +1523,15 @@ def dataURL(self) -> str: # @par EAGLE_START # @param category File # @param tag template -# @param[in] cparam/data_volume Data volume/5/Float/readwrite/False/ +# @param[in] cparam/data_volume Data volume/5/Float/readwrite/False//False/ # \~English Estimated size of the data contained in this node -# @param[in] cparam/group_end Group end/False/Boolean/readwrite/False/ +# @param[in] cparam/group_end Group end/False/Boolean/readwrite/False//False/ # \~English Is this node the end of a group? -# @param[in] aparam/check_filepath_exists Check file path exists/True/Boolean/readwrite/False/ +# @param[in] aparam/check_filepath_exists Check file path exists/True/Boolean/readwrite/False//False/ # \~English Perform a check to make sure the file path exists before proceeding with the application -# @param[in] aparam/filepath File Path//String/readwrite/False/ +# @param[in] aparam/filepath File Path//String/readwrite/False//False/ # \~English Path to the file for this node -# @param[in] aparam/dirname Directory name//String/readwrite/False/ +# @param[in] aparam/dirname Directory name//String/readwrite/False//False/ # \~English Path to the file for this node # @par EAGLE_END class FileDROP(DataDROP, PathBasedDrop): @@ -2614,17 +2614,17 @@ def initialize(self, **kwargs): # @par EAGLE_START # @param category Branch # @param tag template -# @param[in] cparam/appclass Application Class/dlg.apps.simple.SimpleBranch/String/readonly/False/ +# @param[in] cparam/appclass Application Class/dlg.apps.simple.SimpleBranch/String/readonly/False//False/ # \~English Application class -# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False/ +# @param[in] cparam/execution_time Execution Time/5/Float/readonly/False//False/ # \~English Estimated execution time -# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False/ +# @param[in] cparam/num_cpus No. of CPUs/1/Integer/readonly/False//False/ # \~English Number of cores used -# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False/ +# @param[in] cparam/group_start Group start/False/Boolean/readwrite/False//False/ # \~English Is this node the start of a group? -# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False/ +# @param[in] cparam/input_error_threshold "Input error rate (%)"/0/Integer/readwrite/False//False/ # \~English the allowed failure rate of the inputs (in percent), before this component goes to ERROR state and is not executed -# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False/ +# @param[in] cparam/n_tries Number of tries/1/Integer/readwrite/False//False/ # \~English Specifies the number of times the 'run' method will be executed before finally giving up # @par EAGLE_END class BranchAppDrop(BarrierAppDROP):