1. Workflow Editor
Workflow Editor allows to analyse the workflow's (e.g. ETS) Code Parameters.
Each actor with Code Parameters can store them inside workflow file (XML).
You can easily get these parameters by calling workflow-editor with proper arguments.
To use the tool, you need to load module workflow-editor
> module load workflow-editor
1.1. Getting help
To get basic overview of available options call workflow-editor with help argument
> workflow-editor --help usage: workflow-editor -help print this message -actors list all actors with Code Parameters -version print the version information and exit -workflow <file> analyze this workflow file -actor <actorname> name of the actor we will retrieve -xml list Code Parameters for actor -dxml list default Code Parameters for actor -xsd list XSD definition of Code Parameters for actor -validate <dest> validate with [workflow|kepler] -actorxml show XML Code Parameters inside actor -actorxsd show XSD Code Parameters inside actor -actordxml show Default XML Code Parameters inside actor
1.2. Listing actors inside workflow
You can get the list of all actors that have Code Parameters by calling workflow-editor with "-actors" argument (remember to pass workflow as well)
> workflow-editor -actors -workflow workflow_ets.xml 12:29:25.267 [main] INFO pl.psnc.kepler.commands.CommandGetActors - WEILAND - eu.itm.TCIWEILAND.TCIWEILAND 12:29:25.269 [main] INFO pl.psnc.kepler.commands.CommandGetActors - emeq_inside_simple_init - eu.itm.emeq.emeq 12:29:25.269 [main] INFO pl.psnc.kepler.commands.CommandGetActors - addICant - eu.itm.addICant.addICant 12:29:25.269 [main] INFO pl.psnc.kepler.commands.CommandGetActors - spider_inside_consistent_init - eu.itm.spider.spider 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - TGLF - eu.itm.TCITGLF.TCITGLF 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - chease - eu.itm.chease.chease 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - TORAYFOM - eu.itm.TORAYFOM.TORAYFOM 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - synchrotron_cytran - eu.itm.synchrotron_cytran.synchrotron_cytran 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - GLF23 - eu.itm.TCIGLF23.TCIGLF23 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - QLK - eu.itm.TCIQLK.TCIQLK 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - icdept - eu.itm.icdept.icdept 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - EDWM - eu.itm.TCIEDWM.TCIEDWM 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - afsi - eu.itm.afsi.afsi 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - ntmets - eu.itm.ntmets.ntmets 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - SOURCE_COMBINER - eu.itm.sourcecombiner.sourcecombiner 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - impuritymanipulator - eu.itm.impuritymanipulator.impuritymanipulator 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - ascot4parallel - eu.itm.ascot4parallel.ascot4parallel 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - emeq_inside_consistent_init - eu.itm.emeq.emeq 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - NCLASS - eu.itm.TCINCLASSZ.TCINCLASSZ 12:29:25.270 [main] INFO pl.psnc.kepler.commands.CommandGetActors - toric - eu.itm.toric.toric 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - EDWMZ - eu.itm.TCIEDWMZ.TCIEDWMZ 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - nemo - eu.itm.nemo.nemo 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - MMM - eu.itm.TCIMMM.TCIMMM 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - lion - eu.itm.LIONslice.LIONslice 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - pellettrigger - eu.itm.pellettrigger.pellettrigger 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - cyrano-in-loop - eu.itm.Cyrano.Cyrano 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - spot - eu.itm.spot.spot 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - teffcvg - eu.itm.teffcvg.teffcvg 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - deltacombiner - eu.itm.deltacombiner.deltacombiner 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - StixReDist - eu.itm.StixReDist.StixReDist 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - ascot4serial - eu.itm.ascot4serial.ascot4serial 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - nuclearsim - eu.itm.nuclearsim.nuclearsim 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - sawcrash - eu.itm.sawcrash.sawcrash 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - spider_inside_simple_init - eu.itm.spider.spider 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - IMP4imp - eu.itm.IMP4imp.IMP4imp 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - nbisim - eu.itm.nbisim.nbisim 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - hcd2coresource - eu.itm.hcd2coresource.hcd2coresource 12:29:25.271 [main] INFO pl.psnc.kepler.commands.CommandGetActors - gray - eu.itm.gray.gray 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - RELAX - eu.itm.RELAX.RELAX 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - gaussiansources - eu.itm.gausiansources.gausiansources 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - nbisim2 - eu.itm.nbisim2.nbisim2 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - RITM - eu.itm.TCIRITM.TCIRITM 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - addECant - eu.itm.addECant.addECant 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - checktearing - eu.itm.checktearing.checktearing 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - hcd2corefast - eu.itm.hcd2corefast.hcd2corefast 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - pelletactor - eu.itm.pelletactor.pelletactor 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - sawupdate - eu.itm.sawupdate.sawupdate 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - cyrano - eu.itm.Cyrano.Cyrano 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - ntmDeffTLets - eu.itm.ntmDeffTLets.ntmDeffTLets 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - cece - eu.itm.cece.cece 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - sawcrit - eu.itm.sawcrit.sawcrit 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - chease_inside_consistent_init - eu.itm.chease.chease 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - nbifiller - eu.itm.nbifiller.nbifiller 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - NEO - eu.itm.TCINEO.TCINEO 12:29:25.272 [main] INFO pl.psnc.kepler.commands.CommandGetActors - risk - eu.itm.risk.risk 12:29:25.273 [main] INFO pl.psnc.kepler.commands.CommandGetActors - emeq - eu.itm.emeq.emeq 12:29:25.273 [main] INFO pl.psnc.kepler.commands.CommandGetActors - travis - eu.itm.travis.travis 12:29:25.273 [main] INFO pl.psnc.kepler.commands.CommandGetActors - spider - eu.itm.spider.spider 12:29:25.273 [main] INFO pl.psnc.kepler.commands.CommandGetActors - chease_inside_simple_init - eu.itm.chease.chease 12:29:25.273 [main] INFO pl.psnc.kepler.commands.CommandGetActors - BgB_JETTO_Particles - eu.itm.BgB_JETTO_Particles.BgB_JETTO_Particles 12:29:25.273 [main] INFO pl.psnc.kepler.commands.CommandGetActors - lion-in-loop - eu.itm.LIONslice.LIONslice
1.3. Retrieving XML/Default XML/XSD for actor
Once you have the name of the actor, you can list it's Code Parameters
# User's Code Parameters > workflow-editor -xml -actor risk -workflow workflow_ets.xml <?xml version="1.0" encoding="UTF-8"?> <?jaxfront version=2.66;time=2014-10-28 17:14:54.425?> <parameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <n_out_profiles>20</n_out_profiles> <dx_resolution>0.02</dx_resolution> <fac_implicit>0.7</fac_implicit> <debug_mode>0</debug_mode> </parameters>
# Default Code Parameters > workflow-editor -dxml -actor risk -workflow workflow_ets.xml <?xml version="1.0" encoding="UTF-8"?> <parameters> <!-- Resolution of the output 1D-profiles --> <n_out_profiles> 30 </n_out_profiles> <!-- Normalized velocity resolution (v/vth) --> <dx_resolution> 0.01 </dx_resolution> <!-- Implicit/explicit contribution for integration scheme (Crank-Nicholson or so) --> <fac_implicit> 0.7 </fac_implicit> </parameters>
# XSD based definition of Code Parameters > workflow-editor -xsd -actor risk -workflow workflow_ets.xml <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:annotation> <xs:documentation>Code parameters for Risk (Fokker-Planck code)</xs:documentation> </xs:annotation> <xs:simpleType name="integer_minInclusive_2"> <xs:restriction base="xs:integer"> <xs:minInclusive value="2"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="float_minInclusive_dot0001"> <xs:restriction base="xs:float"> <xs:minInclusive value="0.0001"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="float_minInclusive_dot1"> <xs:restriction base="xs:float"> <xs:minInclusive value="0.1"/> </xs:restriction> </xs:simpleType> <!-- document element --> <xs:element name="parameters"> <xs:complexType> <xs:all> <xs:element ref="n_out_profiles" minOccurs="0"/> <xs:element ref="dx_resolution" minOccurs="0"/> <xs:element ref="fac_implicit" minOccurs="0"/> </xs:all> </xs:complexType> </xs:element> <!-- Resolution of the output 1D profiles --> <xs:element name="n_out_profiles" type="integer_minInclusive_2"> <xs:annotation> <xs:documentation>Resolution of the output 1D profiles</xs:documentation> </xs:annotation> </xs:element> <!-- Normalized velocity resolution (v/vth) --> <xs:element name="dx_resolution" type="float_minInclusive_dot0001"> <xs:annotation> <xs:documentation>Normalized velocity resolution (v/vth)</xs:documentation> </xs:annotation> </xs:element> <!-- Implicit/explicit contribution for integration scheme (Crank-Nicholson or so) --> <xs:element name="fac_implicit" type="float_minInclusive_dot1"> <xs:annotation> <xs:documentation>Implicit/explicit contribution for integration scheme (Crank-Nicholson or so)</xs:documentation> </xs:annotation> </xs:element> </xs:schema>
You can combine command (e.g. get everything at once)
workflow-editor -xsd -xml -dxml -actor risk -workflow workflow_ets.xml
1.4. Getting Code Parameters from actor (installed inside Kepler)
It may happen that Code Parameters inside actor's code (inside Kepler) differ from data stored inside workflow. This can happen whenever you try to open workflow with more recent version of Kepler.