...

Arguments required by user C++/F method

• All arguments 'packed' within a class <ActorName>Arguments
• Class will be automatically generated, and copied to a wrapper package
• Order of attributes corresponds to order of  user function arguments
• Every attribute is a class <ToolName>Argument keeping not only value but also metadata describing argument:
  • Name
  • Type of value
  • Value
  • IN or OUT
• Attributes' setters/getters will be overridden - user will set only value of argument 
  • To reduce complexity visible by user
  • To check if arg type is correct

...

# AUTO GENERATED !
class <ActorName>Arguments : 
  def __init__(self):
    self.arg1 = <ToolName>Argument( 'InVar', int, None, IN)
    self.arg2 = <ToolName>Argument( 'OutVar', double, None, OUT)
    self.diagnostic_info = <ToolName>DiagnosticInfo()

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
class <ToolName>Argument :
  def __init__(self, name, type, sub_type, intent):
    self.name =  name #'argument name' READ ONLY
	self.type = type # (INT, DOUBLE, STRING, COMPLEX, IDS) READ ONLY
	self.sub_type = sub_type  #'equilibrium'  for IDSes only READ ONLY
	self.intent = intent # (IN/OUT) READ ONLY
	self.value  = 7. # to be set by user
    
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
class <ToolName>DiagnosticInfo :
  def __init__(self):
    self.status  
	self.message

...

class <ToolName>XMLParamaters :  
  def __init__(self):
    self.parameters = # file name or string or... (?)
    self.default_parameters = # file name or string or ... (?)
	self.schema = # file name or string or ... (?)

Job settings

...

settings

...

• queue
• ???

...

...

• mpi parameters - TBD
• ???

...

• openMP parameters - TBD
• ???

...

• path to sandbox
• sandbox 'lifetime'

Code Block
language py
class <ToolName>JobSettings : def __init__(self): self.batch_job = <ToolName>BatchJob() self.debug = <ToolName>Debug() self.mpi = <ToolName>MPI() self.open_mp = <ToolName>OpenMP() self.sandbox = <ToolName>Sandbox() self.????? #any other info needed? # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # class <ToolName>BatchJob : def __init__(self): self.queue = self.TBD # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # class <ToolName>Debug : def __init__(self): self.debugger #TotalView/gdb self.mode #attach/standalone self.TBD # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # class <ToolName>MPI : def __init__(self): self.TBD self.debug_switch # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # class <ToolName>OpenMP : def __init__(self): self.TBD # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # class <ToolName>Sandbox : def __init__(self): self.path self.lifetime self.TBD

...

• OUT arguments - wrapper will update fields of <ActorName>Arguments class

Example

from my_test.wrapper import my_test_actor

# # # # # JOB SETTINGS # # # # # # # 
job_settings = <ToolName>JobSettings()
 
#batch job
job_settings.batch_job.queue = 'gw_default"
#debugging
# no debugging for batch jobs
#mpi
job_settings.mpi.nodes = 5
#OpenMP
# it is not OpenMP job
# Sandbox
job_settings.sandbox.lifetime = LIFTIME_WORKFLOW
job_settings.sandbox.clean_up = True

# # # # # CODE ARGUMENTS # # # # # # # 
arguments = <ActorName>Arguments()  

self.my_in_arg_01.value = 5
self.my_in_arg_02.value = 0.123
self.my_in_core_profiles_01.value = in_cp_obj
self.my_in_core_profiles_02.value = in_cp_metadata #object keeping shot/run/user

# # # # # RUNNING ACTOR # # # # # # # 
my_test(code_args = arguments, job_settings = job_settings)

# # # # # RETURN # # # # # # # 
ret_eq = arguments.my_out_equilibrium_02.value

...