Changes between Version 6 and Version 7 of Plugin

Timestamp:

Jun 20, 2016, 2:47:53 PM (8 years ago)

Author:

Olivier Mattelaer

Comment:

--

Plugin

@@ -1 @@
-=== Plugin idea
-
-=== init file:
+=== Structure
+
+The idea of the plugin idea is to allow some modification of the code behavior without the need to modify the internal code.
+Allowing an easy support of many modification in the future release of MG5aMC.
+So far three type of modification are supported by this module:
+  1. New output type (for LO processes)
+  2. New cluster type
+  3. Modification of the interface (new command/modification of the command)
+
+The plugin is a directory to placed inside the PLUGIN directory of MG5aMC.
+It should at least have one file named "!__init!__.py" which should contains some minimal information (see below).
+This file should link to other python file if needed.
+
+
+=== !__init!__.py file:
+
+The minimal information that need to be present in that file is:
 
 {{{
@@ -21 +35 @@
 #    example new_cluster = {'mycluster': MYCLUSTERCLASS}
 #    allow "set cluster_type mycluster" in madgraph
-#    MYCLUSTERCLASSshould inherated from madgraph.various.cluster.Cluster
+#    MYCLUSTERCLASS should inherated from madgraph.various.cluster.Cluster
 new_cluster = {}
 
@@ -46 +60 @@
 === Example 1: hello world (adding command to the interface)
 
-__init__.py file
+!__init!__.py file
 {{{
 ## import the required files
-
-import helloworld as helloworld
-
-
-## Does it define a new interface (will be avaible with ./bin/mg5_aMC --mode=maddm
+# example: import maddm_interface as maddm_interface # local file
+#          import madgraph.various.cluster as cluster #MG5 distribution file
+# 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 = {}
+
+
+# 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
+import helloworld as helloworld # local file
 new_interface = helloworld.NewInterface
-
-## Does it define a new output mode. Need to be define
-new_output = {}
-
-## The test/code have been validated up to this version
-latest_validated_version = '2.3.4'
+ 
+ 
+########################## 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)
 }}}
 
 helloworld.py file
 {{{
-class Newinterface(master_interface.MasterCmd):
+
+import madgraph.interface.master_interface as master_interface
+
+class NewInterface(master_interface.MasterCmd):
 
     def do_helloworld(self, line):
@@ -73 +111 @@
 }}}
 
+Now you can run the standard executable with 
+{{{
+./bin/mg5_aMC --mode=helloworld
+}}}
+Note that "helloworld" is the name of the DIRECTORY where the above file have been placed.
+
+The above command create you a shell where you have access to one additional command "helloworld"
+{{{
+MG5_aMC>helloworld
+hello world
+}}}
+
 === Example 2: New Exporter
 
-__init__.py file
+!__init!__.py file
 {{{
 ## import the required files