Changes between Version 8 and Version 9 of Plugin

Timestamp:

Jun 20, 2016, 3:21:57 PM (8 years ago)

Author:

Olivier Mattelaer

Comment:

--

Plugin

@@ -1 @@
-=== Structure
+= Structure
 
 The idea of the plugin idea is to allow some modification of the code behavior without the need to modify the internal code.
@@ -13 +13 @@
 
 
-=== !__init!__.py file:
+== !__init!__.py file:
 
 The minimal information that need to be present in that file is:
@@ -54 +54 @@
 }}}
 
-
-
+== create new output mode
+
+=== Base class which can be use to create a new exporter from scratch:
+
+At the beginning of madgraph/various/iolibs/export_v4.py.
+A virtual class "VirtualExporter" is defined all exporter class should derive from that class.
+That virtual class list all the functions called by the interface that you can define (that class in itself does nothing)
+and list all the common attribute that need to be defined with the explanation of their impact.
+
+In Most of the case, it is more convenient to subclass one of the class creating a real output like ProcessExporterFortran.
+
+
+=== List of function that need to be defined in the exporter For Fortran/CPP output:
+   
+   This list correspond to the call to the exporter performed outside the class itself. Please check the VirtualExporter class (begin of madgraph/various/iolibs/export_v4.py) to check that the following list is up-to-date with your version of MG5aMC.
+
+   1. __init__(self, dir_path = "", opt=None)
+   2. copy_template(self, modelname)
+   3. generate_subprocess_directory(self, subproc_group, helicity_model, me=None) [for grouped]
+   4. generate_subprocess_directory(self, matrix_element, helicity_model, me_number) [for ungrouped]
+   4. convert_model(model, wanted_lorentz=[], wanted_coupling=[])
+   5. finalize(self,matrix_element, cmdhistory, MG5options, outputflag)     
+   6. modify_grouping(self, matrix_element)
+   7. export_model_files(self, model_v4_path) [only if you want to support old model format]
+   8. export_helas(self, HELAS_PATH) [only if you want to support old model format]
+
+
+=== List of class variable that need to be defined in the exporter:
+
+    This list correspond to the attribute of the exporter called outside the  exporter class. Please check the VirtualExporter class (begin of madgraph/various/iolibs/export_v4.py) to check that the following list is up-to-date with your version of MG5aMC.
+
+    1. '''grouped_mode'''  This variable changes the type of object called within 'generate_subprocess_directory' functions. 
+       a. '''False''' to avoid grouping (only identical matrix element are merged)
+       b. ''' 'madevent' ''' group the massless quark and massless lepton
+       c. ''' 'madweight' ''' group the gluon with the massless quark
+    2. '''sa_symmetry''' If no grouped_mode=False, uu~ and u~u will be called independently. Putting sa_symmetry generates only one of the two matrix-element. (might not work for cpp output.
+    3. '''check''' Ask madgraph to check if the directory already exists and propose to the user to remove it first if this is the case
+    4. '''output'''  [Template, None, dir]
+       a. ''''Template'''', madgraph will call copy_template
+       b. ''''dir'''', madgraph will just create an empty directory for initialisation
+       c. '''None''', madgraph do nothing for initialisation
+    5. '''exporter'''  ['v4'/'cpp'] language of the output 'v4' for Fortran output, 'cpp' for C++ output 
+
+
+
+= Example
 
 
@@ -266 +310 @@
 
 
-=== List of function that need to be defined in the exporter For Fortran/CPP output:
-   
-   Note: All of them are defined in ProcessExporterFortran. So you need to define them only if you start a class from scratch.
-         This list correspond to the call to the exporter performed outside the class itself.
-
-   1. __init__(self, dir_path = "", opt=None)
-   2. copy_template(self, modelname)
-   3. generate_subprocess_directory(self, subproc_group, helicity_model, me=None) [for grouped]
-   4. generate_subprocess_directory(self, matrix_element, helicity_model, me_number) [for ungrouped]
-   4. convert_model(model, wanted_lorentz=[], wanted_coupling=[])
-   5. finalize(self,matrix_element, cmdhistory, MG5options, outputflag)     
-   6. modify_grouping(self, matrix_element)
-   7. export_model_files(self, model_v4_path) [only if you want to support old model format]
-   8. export_helas(self, HELAS_PATH) [only if you want to support old model format]
-
-
-=== List of class variable that need to be defined in the exporter:
-
-   Note: All of them are defined in ProcessExporterFortran/ProcessExporterCPP. So you need to define them only if you start a class from scratch.
-         This list correspond to the attribute of the exporter called outside the  exporter class.
-
-    1. '''grouped_mode'''  This variable changes the type of object called within 'generate_subprocess_directory' functions. 
-       a. '''False''' to avoid grouping (only identical matrix element are merged)
-       b. ''' 'madevent' ''' group the massless quark and massless lepton
-       c. ''' 'madweight' ''' group the gluon with the massless quark
-    2. '''sa_symmetry''' If no grouped_mode=False, uu~ and u~u will be called independently. Putting sa_symmetry generates only one of the two matrix-element. (might not work for cpp output.
-    3. '''check''' Ask madgraph to check if the directory already exists and propose to the user to remove it first if this is the case
-    4. '''output'''  [Template, None, dir]
-       a. ''''Template'''', madgraph will call copy_template
-       b. ''''dir'''', madgraph will just create an empty directory for initialisation
-       c. '''None''', madgraph do nothing for initialisation
-    5. '''exporter'''  ['v4'/'cpp'] language of the output 'v4' for Fortran output, 'cpp' for C++ output 
-
-
-
-=== Base class which can be use to create a new exporter from scratch:
-
-at the beginning of madgraph/various/iolibs/export_v4.py.
-A virtual class "VirtualExporter" is defined all exporter class should derive from that class.
-That virtual class list all the functions called by the interface that you can define (that class in itself does nothing)
-
+=== Example 3: New Cluster
+
+A condor cluster not submitting more than a given number of job simultaneously:
+
+
+!__init!__.py
+{{{
+## import the required files
+# example: import maddm_interface as maddm_interface # local file
+#          import madgraph.various.cluster as cluster #MG5 distribution file
+
+import magraph.various.cluster as cluster
+import time
+
+#local file
+
+class MYcluster(cluster.MultiCore):
+
+    maximum_submited_jobs = 100
+    restart_submission = 50
+
+    def submit(self,  prog, argument=[], cwd=None, stdout=None, stderr=None, log=None,
+               required_output=[], nb_submit=0):
+        """pause the submission of jobs if more than """
+
+        me_dir = self.get_jobs_identifier(cwd, prog)
+        if len(self.submitted_ids) > self.maximum_submited_jobs:
+            fct = lambda idle, run, finish: logger.info('Waiting for free slot: %s %s %s' % (idle, run, finish))
+            self.wait(me_dir, fct, self.restart_submission)
+
+
+        # call the normal submission scheme
+        super(MYcluster, self).submit( prog, argument, cwd, stdout, stderr, log, required_output, nb_submit)
+
+
+# Three types of functionality are allowed in a plugin
+#   1. new output mode
+#   2. new cluster support
+#   3. new interface
+
+# 1. Define new output mode
+#    example: new_output = {'myformat': MYCLASS}
+#    madgraph will then allow the command "output myformat PATH"
+#    MYCLASS should inherated of the class madgraph.iolibs.export_v4.VirtualExporter 
+new_output = {}
+
+# 2. Define new way to handle the cluster.
+#    example new_cluster = {'mycluster': MYCLUSTERCLASS}
+#    allow "set cluster_type mycluster" in madgraph
+#    MYCLUSTERCLASS should inherated from madgraph.various.cluster.Cluster
+new_cluster = {'new_condor': MYcluster}
+
+
+# 3. Define a new interface (allow to add/modify MG5 command)
+#    This can be activated via ./bin/mg5_aMC --mode=PLUGINNAME
+## Put None if no dedicated command are required
+new_interface = None
+ 
+ 
+########################## CONTROL VARIABLE ####################################
+__author__ = 'Mattelaer Olivier'
+__email__ = 'o.p.c.mattelaer@durham.ac.uk'
+__version__ = (1,0,0)
+minimal_mg5amcnlo_version = (2,5,0) 
+maximal_mg5amcnlo_version = (1000,1000,1000)
+latest_validated_version = (2,5,0)
+}}}
+
+