= MSE Batch plugin user notes = ''10 Sept, 2010'' == '''Overview''' == The MSE Batch plugin runs the MSE (Management Strategy Evaluator) in batch mode from a command file. The command file runs the MSE changing input harvest rule parameters for each iteration and outputting data file. MSE parameters available through the command file. 1. Number of MSE simulations 1. End Year 1. Assessment and Implementation error 1. Primary Production forcing functions 1. Primary Production forcing function variation 1. Fleet Control types * 0 No controls imposed on fleet * 1 Weakset stock * 2 Highest value stock * 3 Selective fishery 1. Harvest rules * Fishing Mortality * Total Allowable Catch * Target Fishing Mortality (hockey stick parameters) == How to run == ''still to do'' ''Load the MSE batch plugin interface from the MSE in the navigation tree'' ''Load a command file'' ''hit the run button'' == MSE Batch iterations == The MSE Batch loops over Forcing Functions, Fleet Control types and Harvest Rules running the MSE for each set of parameters from the command file. Parameters not set by the command file will be left at the values loaded by the current Ecosim model. Sample loops structure {{{ For each Forcing Function For each Fleet Control For each Harvest Rule MSE run... next Harvest Rule next Fleet Control next Forcing Function }}} '''''''''' == Command file format == The command file is a CSV (coma separated values) file that contains tags. A tag is a predefined string of text that appears at the start of the line and is used to identify the line as valid input for the MSE module. After the data part of the tag there must be a least one empty entry to mark the end of the valid data. All data that appears after the empty entry will be ignored. For example {{{ Control_File_Version,1.0,,,ignored comments,,, }}} Lines in the command file that do not contain a recognized tag will be ignored. A command file can have any number of lines that are not valid inputs as long as they don't start with a valid tag, these could include comments and user notes. The order of the tags in the file is not important. == == == Tags == ==== Control_File_Version ==== {{{ Control_File_Version,1.0,, }}} * Version number of the control file 1.0 for the current version. Used to identify parameter that may be in the file. ==== Model_Name ==== {{{ Model_Name,C:\EwE\Some model.ewemdb,,, }}} * File name of the EwE model * Used to check the command file against the currently loaded EwE model. If the models do not match a warning is issued. ==== Ecosim_Scenario ==== {{{ Ecosim_Scenario,Scenario1,, }}} * Name of the Ecosim Scenario that the command file can work with. If the scenario name does not match a warning is issued. However, the command file can still be run. ==== Run_Type ==== {{{ Run_Type,1,, }}} * Type of harvest rules to set for the current MSE run. For each run of the MSE the harvest rules for the other Run_Type's will be set to zero. * Valid inputs, * 1 Fishing Mortality (Constant_F) sets the fishing mortality rates to a constant value for the run, * 2 Total Allowable Catch (Constant_Y) sets the catch to a constant value for the run, * 3 Target Fishing Mortality(Hockey stick) sets the fishing mortality using the Target Fishing Mortality rules, * 0 Any when this Run_Type option is set the harvest rules for other Run_Types will not be set to zero. Harvest rule values for groups not explicitly set by the command file will use the values in the currently load EwE model. This option allows for different types of harvest rules during the same MSE run. ==== Number_Sims ==== {{{ Number_Sims,50,, }}} * Number of Ecosim simulation the MSE will run for each iteration. This is the 'Number of trials' parameter on the MSE run form. ==== Error_CV ==== {{{ Error_CV,0.3,, }}} * Coefficient of variation for the observation and implementation error for the MSE stock assessment model. This is the equivalent of the Group CV's in the MSE interface. ==== Output_Directory ==== {{{ Output_Directory,C:\EwE data,, }}} * Directory where the MSE batch output will be sent. The MSE batch will try to create the directory if it does not already exist. ==== End_Year ==== {{{ End_Year,-1,, }}} * Last year (time step) the harvest rules are applied to the simulation run. * Valid values * -1 Harvest rules will be applied for the complete simulation run. * > 0 Harvest rules will be stopped before the end of the run. For all years greater than End_Year the simulation will use the current Ecosim Fishing Effort. ==== PP_STDEV ==== {{{ PP_STDEV,0.5,, }}} * One standard deviation for normal distribution of Primary Production variance. ==== PP ==== {{{ PP,1,Increasing,10,, PP,2,Decreasing,10,, }}} * Primary Production forcing function in the current Ecosim model to load for an MSE Batch iteration. * Each line in the command file loads a separate forcing function and loop over all the Fleet Controls and Harvest Rules in the file. 1. Forcing function index for the currently load Ecosim model. See "Time dynamics (Ecoism)>Forcing function" in the EwE interface for the currently loaded forcing functions and indexes. 1. Name of the forcing function. This is just used a check and a warning will be posted if the name in the model and command file do not match. 1. Ecosim group index to apply the forcing function to. If the Group index does not match a primary producer group in Ecosim the MSE Batch will post an error and will not run.