Top Banner
User Guide BioMA Spatial
56

BioMA Spatial User Guide - The BioMA Portalbioma.jrc.ec.europa.eu/.../BioMA_Spatial_User_Guide.pdfBioMA Spatial User Guide 5 Getting started with BioMA 2 Spatial What BioMA Spatial

May 13, 2018

Download

Documents

dinhcong
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
  • User Guide

    BioMA Spatial

  • 2 BioMA Spatial User Guide

    Copyright

    EuropeanUnion,19952016Reproductionisauthorised,providedthesourceisacknowledged,savewhereotherwisestated.Wherepriorpermissionmustbeobtainedforthereproductionoruseoftextualandmultimediainformation(sound,images,software,etc.),suchpermissionshallcanceltheabovementionedgeneralpermissionandshallclearlyindicateanyrestrictionsonuse.

    Disclaimer

    OnanyoftheMARSpagesyoumayfindreferencetoacertainsoftwarepackage,aparticularcontractor,orgroupofcontractors,theuseofoneoranothersensorproduct,etc.Inallcases,unlessspecificallystated,thisdoesnotindicateanypreferenceoftheCommissionforthatparticularproduct,partyorparties.Whenrelevant,weincludelinkstopagesthatgiveyoumoreinformationaboutthereferences.Feelfreetocontactus,incaseyouneedadditionalexplanationsorinformation.

    Release Issue Date Authors1.0.6 6 February 2016 G.Ferrari/D.Fumagalli

  • 1

    Contents

    1 Help contents 32 Getting started with BioMA Spatial 5

    InstallingandlaunchingBioMASpatial ............................................... 6Prerequisites .............................................................. 6Installationprocedure ....................................................... 7

    BioMASpatialworkspaceoverview ................................................. 11

    3 Using BioMA Spatial to run model simulations 17Choosingandconfiguringthemodelingsolution...................................... 18

    Choosingthemodelingsolution.............................................. 18Configuringthemodellingsolution........................................... 19

    Configuringhowtostorethemodeloutput .......................................... 33Runningthemodelsimulation..................................................... 40Savingandloadingaconfiguration.................................................. 41UsingMapDataVisualizertoviewthesimulationresults ............................... 42UsingSimulationResultVisualizertoviewthesimulationresults ......................... 44

    LaunchingtheSimulationResultVisualizerfromBioMASpatial .................... 45ExportingtheresultstoaCSVfile ............................................ 47

    Deployingplugins ................................................................ 48Managinglibrariesandregionalsettings ............................................. 49

    Deployinglibraries,modellingsolutions,andregionalsettings .................... 50Deletingthesimulationresultsfromadatabase....................................... 53

  • CONTENTS

    2 BioMA Spatial User Guide

  • BioMASpatial User Guide 3

    1Help contents

    ThisGuideistargetedtotheusersoftheBioMASoftwareFramework.Inparticular,itdescribeshowtousetheBioMASpatialgraphicaluserinterfacetoconfigure,run,andviewtestedmodels(eitherstaticordynamic)againstspatialunitsorrunamodelwhichrequirescouplingspatialunitsateachtimestep.Thetopicsareorganizedasfollows:

    For an introduction to the BioMA Software Framework, see: BioMAFrameworkUserGuide(http://bioma.jrc.ec.europa.eu/bioma/

    help/)

    Topic ContentsGettingstartedwithBioMASpatialonpage 5

    Howtoinstall,launchandtestBioMASpatial.Furthermore,itprovidesanoverviewoftheuserinterfacewithlinkstotherelevantsections.

    UsingBioMASpatialtorunmodelsimulationsonpage 17

    Howtochooseandconfigureamodellingsolution

    HowtoaccesstheModelParametersEditor Howtorunamodelsimulation HowtoaccessandusetheMapData

    VisualizerBioMAplugintoviewthesimulationsresults

    HowtoanalyzetheresultsusingtheSimulationResultVisualizer

    http://bioma.jrc.ec.europa.eu/bioma/help/http://bioma.jrc.ec.europa.eu/bioma/help/

  • 1 HELP CONTENTS

    4 BioMASpatial User Guide

    Tip: A quick BioMA Spatial Tutorial is available in the Web-based BioMA Portal (http://bioma.jrc.ec.europa.eu/) . You will find both the Tutorial and all the files you need to complete the lessons.Furthermore, the Documentation page of the BioMA Portal gives access to the User Guides of all the BioMA components.

    http://bioma.jrc.ec.europa.eu/http://bioma.jrc.ec.europa.eu/

  • BioMA Spatial User Guide 5

    2Getting started with BioMA SpatialWhat BioMA Spatial it is used for

    BioMASpatialistheGraphicalUserInterfacedevelopedwithintheBioMAFrameworkthatallowsconfiguring,running,andviewinginstancesofaModelingSolutioninaspatiallyandtemporallydistributedcontext.BioMASpatialincludesseveralplugins,suchasMapVisualizer,ModelParametersEditor(MPE),GraphicDataDisplay(GDD),andModelComponentExplorer(MCE)thatyoucanlaunchandusefromwithintheapplicationforfurthersimulation'sanalysis.Furthermore,userscandeployotherpluginstobeusedwithinBioMASpatial.

    In this topic: InstallingandlaunchingBioMASpatialonpage 6 BioMASpatialworkspaceoverviewonpage 11

    Related topics: UsingBioMASpatialtorunmodelsimulationsonpage 15

  • 2 GETTING STARTED WITH BIOMA SPATIAL

    6 BioMA Spatial User Guide

    Installing and launching BioMA-Spatial Prerequisitesonpage 6 Installationprocedureonpage 7

    PrerequisitesInordertoinstallandrunBioMA,thefollowingprerequisitesmustbefulfilled:

    Hardware prerequisites Operativesystem:WindowsXP/Vista/7/8(32or64bit) 1GBRAMminimum(recommended2GB)

    Software prerequisitesThefollowingsoftwaremustbeinstalledonyourcomputer: NET4.5FrameworkToinstallgotohttp://www.microsoft.com/net/

    .Followtheproductsdocumentation,ifneeded. SQLServerCompactEditiondriverItisrequiredinordertousethe

    SQLServerportabledatabases(ifthisisgoingtobeyourDB).Toinstallthelatestversion,gotohttps://www.microsoft.com/enUS/download/details.aspx?id=5783.

    Regional Settings of your PCEnsurethattheRegionalSettingsofyourPCareproperlyset:1 AccesstheWindowsControlPanel:

    Windows7andpreviousversions:ClicktheStartbutton,thenselectControlPanel.

    Windows8:Rightclickinthelowerleftcornerofthescreen,then,intheWindows'QuickAccessMenu,clickControlPanelnearthebottom.

    2 IntheControlPanelselectClock,Language,andRegion,then,intheRegionandLanguagewindow,clickAdditionalsettings.

    Important note:The driver to be installed depends on the database you are using: for instance, if you are going to use a Oracle database, visit the Oracle Web site and install the drivers latest version. You might also use a SQLServer, or PostgreSQL database.

    http://www.microsoft.com/net/https://www.microsoft.com/en-US/download/details.aspx?id=5783https://www.microsoft.com/en-US/download/details.aspx?id=5783

  • 7

    INSTALLING AND LAUNCHING BIOMA-SPATIAL

    BioMA Spatial User Guide

    3 BesurethattheDecimalsymbolissettopoint(.).

    Installation procedureToinstallBioMASpatial,youmustcompletethefollowingsteps: UninstallanyolderversionofBioMASpatial(seeUninstallingolder

    versionsofBioMASpatialherebelow) Installtheapplication(seeInstallingandlaunchingtheapplication

    onpage 7) Deploythepackage(orthepackages)containingthemodeling

    solution(s)toberun(seeDeployingthemodellingsolutionpackageonpage 8)

    Deploytheregionalsettingsthatallowrunningthemodelingsolution(s)inaspecificcontext(seeDeployingtheregionalsettingsonpage 9)

    Uninstalling older versions of BioMA SpatialDothefollowing:1 AccesstheWindowsControlPanelandopentheprogramsuninstall

    utility(ControlPanel>Programs>Uninstallaprogram).2 SelectBioMASpatialanduninstallit.3 DeletealltheresidualcontentfromtheBioMASpatialinstallation

    folder.

    Installing and launching the applicationDothefollowing:1 Runthesetup.exefilethatyoufindintheinstallationpackagethat

    youdownloadedonyourPC.(NotethatyoucanchooseanydirectoryonthePCastheinstallationdirectory.Bydefault,theinstallationfolderis: Ona64bitmachine:C:\Program Files(x86)\JRC\BioMASpatial) Ona32bitmachine:C:\Program Files\JRC\BioMASpatial)TheinstallationcreatesashortcuttoBioMAonthedesktop,andineithertheWindowsStartmenu(Windows7andpreviousversions)ortheWindowsCharmbar(Windows8:thebarpopsupbydraggingthemousetothetoprightcornerofthescreen).

  • 2 GETTING STARTED WITH BIOMA SPATIAL

    8 BioMA Spatial User Guide

    2 LaunchBioMASpatial.TheHomepageofBioMAisdisplayed.3 ChecktheLogwindow,atthebottomleftoftheHomepagetoverify

    thatnoerrorswerefoundduringstartupandtheapplicationwassuccessfullyinitialized.

    To troubleshoot access problems, if any:Ifanerrorisdisplayedregardingmissinggrantsontheinstallationfolder(likeAccesstothepathXisdenied),youmustchangethesecuritypropertiesofthefolderanditssubfolders.Todothat:1 GototheBioMAsetupfolder(e.g.,C:\Program Files

    (x86)\JRC\BiomaSpatial),rightclickit,andthenselectProperties.2 SelecttheSecuritytabandclicktheEditbutton.3 UnderGrouporusernames,selectthecurrentuserorUsers.4 Allowtotheuser(s)theFullcontrolpermission,clickApply,thenOk.

    Deploying the modelling solution packageTouseamodellingsolutioninBioMASpatial,usersmustdeployaBioMApackagefile(.bpkgfile).Apackagecontainsoneormorelibraries(.dllor.exefiles)andthe.xmlconfigurationfiles.ThesefilesareprovidedintoasingleZIPfilewhoseextensionhasbeenrenamedto.bpkg.PackagesareusedtocollectallthefilesthatareneededtodeployamodelingsolutioninBioMASpatial.

    To deploy the modelling solutions:1 FromtheBioMASpatialmenuselectSettings>Librariesmanagement

    andregionalsettings.

    2 Inthewindowthatopens,clicktheChooseapackagetodeploybutton.

  • 9

    INSTALLING AND LAUNCHING BIOMA-SPATIAL

    BioMA Spatial User Guide

    3 Browsetolocatethe.bpkgfilesthatyoudownloaded,selectone(e.g.,WofostPackage.bpkg)andclickOpen.

    4 CheckDeployasmodelingsolution,thenclickDeploy.BioMASpatialwillrestartandwillnowincludethemodellingsolutionpackageyoudeployed.

    5 Repeatthesameoperationwiththeotherpackagesyouwanttodeploy,e.g.,CropSystPackage.bpkg).

    See also: Managinglibrariesandregionalsettingsonpage 49

    Deploying the regional settingsBydeployingregionalsettingstheusercanfilltheapplicationwithallthefilesneededforrunningamodelingsolutioninaspecificcontext.(Fordetailedinformation,seeManaginglibrariesandregionalsettingsonpage 49).

    To deploy the regional settings:1 FromtheBioMASpatialmenuselectSettings>Librariesmanagement

    andregionalsettings.2 Atthebottomofthewindowthatopens,clicktheAdd(orChange)

    button.(Ifaregionalsettingssethasalreadybeendeployed,thisbuttonisnamedChangeandthenameoftheCurrentregionalsettingsisdisplayedinthisarea.)

    3 Selectthe.brsfilethatyouwanttouseasregionalsettings,thenclickOpen.

    4 Inthepopupthatdisplaysinformingyouthattheexistingregionalsettingsfileswillbedeleted,clickOk,thenwaitfortheunzipprocesstocomplete(thismightrequirefewminutes).

    5 Attheend,themessageRegionalsettingsunzippedwillbedisplayed(thismightincludesomepotentialwarningssayingthatsomedllsarealreadyloadedinBioMAandcannotbeoverwritten).

    6 ClickOk.Theapplicationwillberestarted.

    Attention:When you change the regional settings, the current set will be deleted, and so any data file belonging to it. Make a back-up of your sensible data (if any) before proceeding.

  • 2 GETTING STARTED WITH BIOMA SPATIAL

    10 BioMA Spatial User Guide

    See also: Managinglibrariesandregionalsettingsonpage 49 BioMASpatialworkspaceoverviewonpage 11

  • 11

    BIOMA-SPATIAL WORKSPACE OVERVIEW

    BioMA Spatial User Guide

    BioMA-Spatial workspace overviewThissectionprovidesanoverviewoftheBioMASpatialworkspace:

    Thetablethatfollowsprovidesashortdescriptionofallpanesandcommands.Linkstosectionsofinterestarealsoprovided.

    Figure 1 Home page overview

  • 2 GETTING STARTED WITH BIOMA SPATIAL

    12 BioMA Spatial User Guide

    Interface element/group Description

    1 Main menu

    Load/save configuration - Allows saving a modeling solution configuration for a later reuse, and loading an available pre-saved configuration (*.BCF file), respectively. See Saving and loading a configuration on page 41.

    Validate values - Allows validating the configuration before running the simulation.

    Start/pause/stop simulation - Allows starting and managing the simulation. See Running the model simulation on page 40.

    Settings - The button displays a popup menu including the following commands: Plugin configuration: It allows registering or de-registering

    plugins. See Deploying plugins on page 48. Libraries management and regional settings: It allows

    deploying new modeling solutions or components and installing the regional settings. See Managing libraries and regional settings on page 49.

    Model output storing: Same as the Model output storing button at the bottom of the window. See Configuring how to store the model output on page 33.

    Log iteration success - This is a checkbox. If selected, a log file will be saved for each interaction. By default, is deselected because it might slow down the performance.

    About and Help icons - These icons display the release information and all the available user guides, respectively.

  • 13

    BIOMA-SPATIAL WORKSPACE OVERVIEW

    BioMA Spatial User Guide

    1Tools buttons

    Map visualizer - It launches the Map and Data Visualizer tool. See Using Map Data Visualizer to view the simulation results on page 42.

    Simulation result visualizer - It opens the Result Visualizer window that allows exporting the result data to a CSV file. See Using Simulation Result Visualizer to view the simulation results on page 44.

    Simulation result cleaner - This button is only available upon request. It allows deleting the simulation results from the database. See Deleting the simulation results from a database on page 53.

    MCE - It launches the Model Component Explorer.

    MPE - It launches the Model Parameter Editor.GDD - It launches the Graphic Display Data tool.(To view the User Guides of the MCE, MPE, and GDD tools, please refer to the CRA Web site: http://agsys.cra-cin.it/Tools/)

    2 TabsHome - The tab that is displayed at the application startup.

    Main page - It allows selecting and configuring the modeling solution (see Main page overview on page 14)

    3 Right paneThis pane includes several tabs that allows viewing or downloading reference documentation. The pane is dynamic: it gets updated whenever an authorized user changes a document.

    4 Log window

    This pane allows checking if the current operation (starting the application, launching a simulation, and so forth) has been successfully completed. Furthermore, it lists detected errors, if any.The Clear log button allows clearing the log window, whereas the Show pre-conditions log allows checking at runtime that the values are within the proper ranges; by clicking this button a dedicated log window is displayed.

    5 Simulation descriptionSimulation progress

    It allows naming the simulation and viewing its progress when launched.

    6 Model output storingModel output selection

    These buttons allow to: Specify how to save the model output (either in a Database or a

    textual file). Select the variables that will be saved in the model output. See Configuring how to store the model output on page 33.

    Interface element/group Description

    http://agsys.cra-cin.it/Tools/

  • 2 GETTING STARTED WITH BIOMA SPATIAL

    14 BioMA Spatial User Guide

    Thetablethatfollowsprovidesashortdescriptionofallpanesandcommands.Linkstosectionsofinterestarealsoprovided.

    Figure 2 Main page overview

  • 15

    BIOMA-SPATIAL WORKSPACE OVERVIEW

    BioMA Spatial User Guide

    See also: Choosingandconfiguringthemodelingsolutiononpage 18

    Interface element/group Description

    1 Modeling solution configuration

    This is the configuration editor that allows choosing the modeling solution to run and set its configuration. See Choosing the modeling solution on page 18.The grid shows the following columns: Iterate - If selected, it allows the iteration on multiple values

    of the item (if possible). For example, you might iterate on multiple years or locations. See, Iterating over multiple item values on page 26.

    Configuration item - This column shows the name of the item to be set in the Value column.

    Value - By clicking a field in this column, a dropdown list is made available from which you can choose the desired value. Furthermore, in some cases, an ellipsis button is displayed in the third column: click it to display a popup that helps you in your selection. (See Using the Location selector on page 30).

    Value Hints and Definitions - This column shows the value constraints (if any). If you dont see this column drag the scrollbar at the bottom of the panel.

    2 Components parameters

    This panel shows the models parameters, grouped by the component of the model which they belong to. It allows viewing and editing the parameters. Besides of showing the name of the components, two buttons are displayed: Show and View parameters that allow displaying the values and launching the Model Parameter Editor, respectively.

  • 2 GETTING STARTED WITH BIOMA SPATIAL

    16 BioMA Spatial User Guide

  • BioMA Spatial User Guide 17

    3Using BioMA Spatial to run model simulationsTogetyoustartedwithBioMASpatial,inthefollowingyoufindthestepbystepproceduresforrunningamodelingsolution.Thetopichasbeenorganizedintothefollowingsections: Choosingandconfiguringthemodelingsolutiononpage 18 Configuringhowtostorethemodeloutputonpage 33 Runningthemodelsimulationonpage 40 Savingandloadingaconfigurationonpage 41 UsingMapDataVisualizertoviewthesimulationresultsonpage 42 UsingSimulationResultVisualizertoviewthesimulationresultson

    page 44 Deployingpluginsonpage 48 Managinglibrariesandregionalsettingsonpage 49 Deletingthesimulationresultsfromadatabaseonpage 53

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    18 BioMA Spatial User Guide

    Choosing and configuring the modeling solutionInthisguidewewillchoose,configure,andruntheWOFOSTmodelingsolution.WOFOST(WOrldFOodSTudies)isasimulationmodelforthequantitativeanalysisofthegrowthandproductionofannualfieldcrops.Itsimulatescropgrowthwithtimestepsofoneday.WOFOSTisamechanisticmodelthatexplainscropgrowthonthebasisoftheunderlyingprocesses,suchasphotosynthesis,respirationandhowtheseprocessesareinfluencedbyenvironmentalconditions.

    In this section: Choosingthemodelingsolutiononpage 18 Configuringthemodellingsolutiononpage 19

    Choosing the modeling solution

    To select the modeling solution to run:1 LaunchBioMASpatialeitherfromyourdesktoporfromtheStart

    menuinyourWindowsapplicationbar.2 IntheBioMAwindow,selecttheMainpagetab:

    Tip:To configure other modeling solutions, you can mainly use the same procedure that is described in the following.The only differences are due to specific parameters that refer to that modelling solution. For information on the modelling solutions and their components, please refer to the Modelling Solutions Documentation.

  • 19

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    3 IntheModelingsolutionconfigurationpanel,doubleclicktheValuecolumnnexttoModelingSolutiontodisplaythedropdownlist:

    4 Choosethemodelingsolution.Forthesakeofthisuserguide,wewillchoosetheWOFOSTmodelingsolutionfromthelist.Thelistincludes: IteratedmodelandIteration,whichareauxiliaryvaluesthatcan

    beignoredfromtheuser. AnyothermodelingsolutionthatwasdeployedinyourBioMA

    platform.

    Configuring the modelling solutionOnceyouhaveselectedthemodelingsolutiontorun,youmustconfigurethemodelwiththeinputdatasourcesandspecifytheoutputformat.

    To configure the model:1 AfterselectingWOFOSTastheModelingsolution,theconfiguration

    itemsareshown,whicharespecificforthatmodelingsolution:

    2 ConfigurethemodelingsolutionbyselectingaValueforeachConfigurationItem,asdescribedinthetablethatfollows.(ClicktheyellowfieldintheValuecolumn,thenselecttheproperitemfromthedropdownlist).

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    20 BioMA Spatial User Guide

    Table 1 WOFOST model configuration items

    Configuration Item Possible values and description

    Simulation configuration

    Please, before configuring this item, set the Weather Configuration (that is, the data source to use) so as to make available the years to select. (See below for instructions).The Simulation configuration item allows setting the time frame and the location to run the simulation for. Select the proper value from the dropdown list, then set the sub-values. The following shows an example where Daily step with start year has been selected as the main item: Start Year - 2010 Start Year Doy - 1 Number of Years - 2 Location ID - 75102. This is the ID of the location you will

    run the simulation for. Furthermore, this item allows accessing the Location selector tool. For further information, see Using the Location selector on page 30.

    Agromanagement Configuration

    The agromanagement file defines the chronology of the agromanagement practices, including sowing date and harvesting date. Available options are: Agromanagement data from CSV file - If selected, it

    allows browsing to choose a CSV file. Load rules from agromanagement file - If selected, the

    Agromanagement file item is displayed. Clicking the ellipsis button results in displaying the following popup:

    - Click Change agromanagement file, then, in the BioMA installation folder, browse to the ParameterFiles folder and select the XML file you want to use.

  • 21

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    Weather configuration

    The dropdown list includes the source from which weather input data are taken. This can be a CSV file or a source database (remote or portable):Remote database: It allows running the simulation using the remote weather dataset.Portable database: Select this item to run the simulation using the real weather saved in a remote portable database.The following item will be enabled:

    Connection - It allows selecting the provider and the source database. Double-click the row, then select SQLServer CE DB from the dropdown list to locate the weather data source. See Establishing the Internet connection to the database: on page 28 for detailed instructions on how to proceed.

    CSV single file real weather: It allows selecting a single CSV file containing the weather input data. If selected the following items allow you selecting the relevant files: WeatherCsvFilePath - The browse button next to the

    Value column allows selecting the CSV file for weather data to use.

    GridDataCsvFilePath - The browse button next to the Value column allows selecting the CSV file for the locations data (latitude and longitude).

    CSV file set real weather: It allows selecting a set of CSV files containing the weather input data. If selected the following item is displayed: CsvFilesDirectory - The browse button next to the

    Value column allows selecting the directory where the CSV files are located.

    The Configuration items that follow are the modelling solutions switches, that is, the options that the modeler can set to enable (True) or disable (False) an optional component or to change the internal behaviour of a component.Weather Switch Calculate evapotranspiration

    Set it to True to calculate the value of the daily evapotranspiration. If it is set to False, the model uses the evapotranspiration read from the weather source.

    Weather switch Calculate VPD

    Set it to True to calculate the value of the daily vapour pressure deficit. If it is set to False, the model uses the VPD read from the weather source.

    Weather switch Calculate Humidity

    Set it to True to calculate the value of the daily maximum and minimum relative humidity. If set to False, the model uses the humidity read by the weather source.

    Table 1 WOFOST model configuration items

    Configuration Item Possible values and description

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    22 BioMA Spatial User Guide

    Soil data configuration This component provides the soil data to the other components. The dropdown allows connecting to a data source to get a set of soil data for a specific location. Read soil data from DB - If selected, the following field is displayed: Connection - Being a remote database, it requires an

    Internet connection. Double-click the row, then select SQLServer CE DB from the dropdown list to locate the database you want to connect to. See Establishing the Internet connection to the database: on page 28 for detailed instructions on how to proceed.

    Read soil data from XML files - If selected, our new fields are displayed for you to specify the files path. Two XML files are provided with the application including three soil typologies each: Soil parameters file path - The browse button next to

    the Value column allows selecting the XML file for soil data to use. (E.g., BioMA Installation folder > SoilFiles folder > Soil_SoilParameters.xml).

    Soil parameters key - The SiltyLoam soil typology will be automatically set after selecting the XML file.

    Soil inizialization file path - The browse button next to the Value column allows selecting the XML file. (E.g., BioMA Installation folder > SoilFiles folder > Soil_SoilInizialization.xml).

    Soil inizialization key - The SiltyLoam soil typology will be automatically set after selecting the XML file.

    WOFOSTComponent Switch UsePhotoPeriod

    Set it to True. This switch allows users to activate or deactivate the simulation of the impact of day length on development rate, via a modulation effect on thermal time accumulation rate. This option is useful in case of species/varieties sensitive to photoperiod.

    WOFOSTLimitedComponent Switch Enable water limitation

    Set it to True. The WOFOST Limited Component calculates the water limited crop simulation by using the soil water content calculated by the soil water component.

    LeafWetnessComponent Switch Select leaf wetness strategy

    This switch allows setting the strategy to be used for calculated the leaf wetness, which is a requisite to calculate the plant disease. If set to None, the leaf wetness is not calculated. You can select among six alternative strategies: CART, DP, SWEB, ET, LWR, FT. If DP or SWEB or LWR is selected, the modeler must configure its parameters before running the simulation. (For further information, on these strategies, please refer to the LeafWetness documentation).

    Table 1 WOFOST model configuration items

    Configuration Item Possible values and description

    http://bioma.jrc.ec.europa.eu/components/componentstools/leafwetness/help/webframe.html

  • 23

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    3 Onceyouarefinishedwiththemodelconfiguration,intheComponentsparameterspanelattherightofthewindow,theparametersaredisplayed:

    DiseaseProgress Switch Enable disease component

    Set it to True to include the disease damage optional component in the modelling solution. If this component is included, the modeler must configure its parameters before running the simulation.

    DiseaseImpactsOnPlants Switch Enable disease impacts on plant

    Set it to True to include the disease impact on plants optional component in the modelling solution. If this component is included, the modeler must configure its parameters before running the simulation.

    Check preconditions Set this value to Enable, to automatically perform a check before running the simulation.

    Iteration values You can iterate the simulation over more configuration items values (in particular, for the Simulation Configurations Location ID and Year items). Here are displayed the items you enabled the iteration for. (For further information, see Iterating over multiple item values on page 26).

    Table 1 WOFOST model configuration items

    Configuration Item Possible values and description

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    24 BioMA Spatial User Guide

    Theparametersofthemodelaregroupedbythecomponentofthemodelwhichtheybelongto.Inthisexample,theComponentsparameterspanelincludesseveralComponents.Thesecomponentsdependonthemodellingsolutionthathasbeenloaded.Componentscouldchangeif,forexample,eitheradifferentsoilmoduleorconfigurationisembeddedinthemodellingsolution.

    4 ClicktheShowbuttonnexttothefirstComponenttodisplaytherelevantparameters.ThebuttonchangestoHideandtheconfigurationparametersaredisplayed:

  • 25

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    5 FromtheParametersreaderdropdownlist,selectMPEparametersfromXML.TheXMLfilefieldwillbedisplayed.

    6 BrowsetolocateyourBioMASpatialinstallationfolder,locatetheParemeterFilesfolder,thenselecttheXMLfile.

    7 RepeatthesamefortheotherComponents.Inallcases,theParameterskeyfieldwillbeautomaticallyfilled.

    When finished, validate your configuration:1 IntheBioMASpatialtoolbar,clickValidatevalues tovalidatethe

    configuration.Therearetwopossiblescenarios: IfeverythingisOKyouwillseethegreenValidationsucceeded

    message. Iferrorsaredetected,apopupisdisplayedwithadescription

    (missing/wrongfieldvalues)alongwiththeErrorduringvalidationmessage.

    2 Correcttheerrors,ifany,andrepeatthevalidation.

    See also: Iteratingovermultipleitemvaluesonpage 26 UsingtheLocationselectoronpage 30

    Note: The View parameters button allows displaying the Models Parameter Editor (MPE) for you to view and edit the parameters before launching the simulation. MPE can be used as a BioMA plugin, or as a standalone tool to load specific parameters definitions as XML files, which were created using the Domain Class Coder (DCC) application.To launch MPE, click the button on the Spatial toolbar. For information on how to use it, refer to the integrated Help that you can access by clicking > MPE User Guide from the MPE menu bar.

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    26 BioMA Spatial User Guide

    Iterating over multiple item valuesYoucaniteratethesimulationovermoreconfigurationitemsvalues(iftheoptionisavailable).Inparticular,thisfunctionisavailableforyearsandlocations.Thefollowingshowsanexamplewhereaspecificyearforthesimulationhasbeenchosen:

    Inthisexample,wewanttoiterateovermoreLocations:1 SelecttheIteratecheckboxintheleftmostcolumnnexttothe

    LocationIDSimulationConfigurationsitem.Asaresult,theIterationfieldnameitemwillbedisplayedshowingtheselectedconfigurationitem(location).

    2 ClicknexttoValues,intheValuecolumn,todisplaythedropdownlistthatallowsselectingmultiplevalues.Thelistincludestheavailablevaluesfortheselectedmodel.

    Note:For the sake of this guide, we have chosen a specific year. However, users can choose other ranges of dates (start and end date, or start and number of years, and so forth) accordingly to their needs.

  • 27

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    3 SelectthedesiredlocationIDsfromthelist.ToseewhichgeographicallocationsareassociatedwiththeIDs,clicktheellipsisbuttoninthethirdcolumnandusetheLocationselector.

    See also: EstablishingtheInternetconnectiontothedatabase:onpage 28 UsingtheLocationselectoronpage 30

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    28 BioMA Spatial User Guide

    Establishing the Internet connection to the database:

    To establish the connection:1 AfterselectingaremotedatabaseastheWeatherConfiguration,click

    theValuecolumnnexttoConnection.Adropdownlistisdisplayed:Notethatinthethirdcolumn,anellipsisbuttonisalsodisplayed(asindicatedbythearrow).

    2 Selectfromthedropdownlistthekindofdatabaseyouwanttoconnectto: OracleDB:ConnectstoadatabaseOracle. SQLServerCEDB:ConnectstoaSQLServerCEportableDB. SQLServerCEPasswordprotectedDB:Connectstoapassword

    protectedSQLServerCEportableDB.Thepasswordtoaccessthedataisamandatoryfieldoftheconfiguration.

    SSQLServerDB:ConnectstoaSQLServerdatabaseusingtheWindowsaccountastheaccesscredential.

    SSQLServerDBwithusername:ConnectstoaSQLServerdatabasewithaUser/Passwordaccount.

    SPostgreSQLDB:ConnectstoaPostgreSQLdatabaseSelectoneofthedatabasetypes(e.g.,SQLServerCEDB).

    3 Clicktheellipsisbuttononthethirdcolumntodisplayapopupwindowwhosecontentsdependonthedatabaseyouselected.Inthefollowingexample,theSQLServerCEDBdatabasehasbeenselected:

  • 29

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    4 Hereyoucanconfiguretheconnectiontoaspecificdatabase.Inthiscase,clicktheBrowsebutton,andthenselecttheportabledatabasefilethatcontainstheweatherdata.

    5 ClicktheTestconnectionbuttontoensurethateverythingisworking.

    See also: Iteratingovermultipleitemvaluesonpage 26 UsingtheLocationselectoronpage 30

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    30 BioMA Spatial User Guide

    Using the Location selectorWhenconfiguringtheModellingSolution,theLocationIDConfigurationitemallowsselectingthelocation(s)youwanttorunthesimulationfor.1 SetaValuefortheSimulationConfigurationitem,thendooneofthe

    following: SelectaLocationIDfromthedropdownlistintheValuecolumn.

    ThedropdownliststheavailableIDsaccordingtoyourselections. Clickthe ellipsisbuttontoselectthegeographicallocationson

    amap,asshownbelow:

    2 TheLocationSelectorwindowthatisdisplayedallowstoviewandselectthelocationsbydoingoneofthefollowing: IntheMaskselectionarea,selectalocationssetfromthe

    Availablemaskdropdownlist. IntheManualselectiontextbox,enteragridcodeforaspecific

    locationssetandthenclickAdd.3 ClicktheShowmapbuttontodisplayamapshowing,ingreen,the

    locationssetyouselected:

  • 31

    CHOOSING AND CONFIGURING THE MODELING SOLUTION

    BioMA Spatial User Guide

    NotethatthebuttonsnamechangestoHidemapandatoolbarisdisplayed,whichallowsyoutofurthermanageyourselection(s):

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    32 BioMA Spatial User Guide

    Thebuttonsaretoggle:toquitafunction,clickthebuttonagain.4 Whenyouaredonewithselection,therearetwopossiblescenarios:

    ClickSaveselectionasmaskifyouwanttosaveanewlycreatedlocationsset.Youwillbepromptedtoenteranamefortheset.

    ClickSaveandclosetosavethesettingsandreturntothemodelconfiguration.(ClickCanceltoreturntothemodelconfigurationwithoutsavingtheselection.)

    IntheLocationConfigurationitem,theIDoftheselectedlocationwillbedisplayed.

    See also: Iteratingovermultipleitemvaluesonpage 26 EstablishingtheInternetconnectiontothedatabase:onpage 28

    Buttons FunctionZoom buttons - Allow magnifying, reducing, and viewing the whole map, respectively.Move buttons - Allow moving the map up, down, right, and left, respectively.Select buttons - Allow selecting a single grid, a group of grids (based on a rectangle, and a group of grids based on a polygon, respectively. Drag to select the cells. Add selected items from query - It allows opening the selection form. (For further information on how to fill the selection form, please refer to Using Map Data Visualizer to view the simulation results on page 42).Deselect buttons - Allow deselecting specific or all selected grids, respectively. To deselect a specific set of grids, drag to highlight the desired area, and then double-click it. Inspect values button - Allows displaying information on the selection (e.g., the grid code). Click the button and then click the selection you want to see the information about.Save and close button - Allows saving the current selections and closing the form.

  • 33

    CONFIGURING HOW TO STORE THE MODEL OUTPUT

    BioMA Spatial User Guide

    Configuring how to store the model outputBeforestartingthesimulation,itisnecessarytospecifyhowthemodeloutputwillbestored,thatis,howtosavethesimulationresultsinapersistenceform(suchas,forexample,adatabase,atextfile,oraXMLfile).Furthermore,theusercanspecifythemodelvariablestobeincludedinthemodeloutput.Bydefault,BioMAallowssavingthesimulationresultsinseveralways: XMLSavesthesimulationresultsinXMLformat(tobereadbythe

    Simulationresultvisualizerplugin). CSVSavesthesimulationresultsasatextualCSVfile. DatabaseSavesthesimulationresultsinadatabase. DatainmemoryforGDDSavesthesimulationresultssoastobe

    abletoopenitwiththeGraphicDataDisplay(GDD)tool.However,theusercancreateanddeployitsownstoringmethods(alsocalledpersisters).

    In this section: Tospecifyhowtostorethemodeloutput:onpage 33 Tospecifywhichvariablestoincludeinthemodeloutput:on

    page 36

    To specify how to store the model output:1 Dooneofthefollowing:

    IntheSimulationpanel,atthebottomrightoftheBioMAwindow,clicktheModeloutputstoringbutton.

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    34 BioMA Spatial User Guide

    \IntheBioMAmainmenu,clicktheSettings buttonandthenselectModeloutputstoringfromthedropdownmenu.

    TheModeloutputsstoringwindowwillbedisplayedthatallowsyoutosetuptofourpersistersatthesametime:

    2 ClickSelect...todisplaythedropdownlist,thenchoosehowyouwanttosaveyoursimulationresults:

  • 35

    CONFIGURING HOW TO STORE THE MODEL OUTPUT

    BioMA Spatial User Guide

    Youmightusethedefaultconfigurationsordeployyourownstoringmethods.

    3 Dependingonyourselection,specificconfigurationitemsaredisplayedforyoutoset,asitisdescribedinthefollowing: IfyouselectSavetoXMLorSavetoCSVfiles:

    IfyouselectKeepdatainmemoryforGDD,youwillbeabletoretrievetheconfigurationfilefromtheGraphicDataDisplayapplication(forfurtherinformation,gotohttp://agsys.cracin.it/Tools/toaccesstheGDDHelp).

    IfyouselectSavetoDatabase(notethattheNumberofresultstostoreincacheitemwillonlybedisplayedifyouselectSavetoaDatabaseusingacache):

    Configuration Item DescriptionDirectory Specify the folder where to save the file(s).File name prefix Specify the file prefix.

    Configuration Item Description

    Number of results to store in cache

    This item is only displayed if you select Save to a Database using a cache. It allows saving the results in a temporary cache memory: once the number of results you specify here is reached, the results are stored in the database. This allows for performance optimization.

    Mapping file pathThe XML file that allows matching the columns of the table coming from the model and the columns of the database tables.

    http://agsys.cra-cin.it/Tools/http://agsys.cra-cin.it/Tools/http://agsys.cra-cin.it/tools/" target="_blank

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    36 BioMA Spatial User Guide

    To specify which variables to include in the model output:Thisfunctionallowsspecifyingwhichvariablesyouwanttoincludeinthemodeloutput.Iftheuserdoesnotspecifyanyvalue,onlythemandatorytableswillbeaddedtothemodeloutputorthedefaultconfigurationthattheuserhascreated,ifany.1 IntheSimulationpanel,atthebottomrightoftheBioMAwindow,

    clicktheModeloutputselectionbutton:

    2 TheModeloutputsselectionwindowisdisplayedlistingthecomponentstablesbelongingtothecurrentlyselectedmodellingsolution(inthisexample,theCropSystmodellingsolutionhasbeenselected):

    Connection

    Select the database type. After the selection of the database type, configure the connection to the specific database. For information on how to do it, see Establishing the Internet connection to the database: on page 30.

    Save rulesSelect how to save the data. You can use this setting to filter the number of records that will be saved in the database.

    Configuration Item Description

  • 37

    CONFIGURING HOW TO STORE THE MODEL OUTPUT

    BioMA Spatial User Guide

    Thewindowlistsallthetablesandtherelevantcolumnsthatcanbeincludedinthemodeloutput.Notethat,inthelowerpartofthewindow,themandatorytablesarealreadyselected.

    3 Toselectawholetable,clicktheIncludeinoutputcheckboxnexttothetable.YoumightusetheDeselectallcheckboxatthebottomlefttodeselectthecurrentlyselectedtables.

    4 Toselectspecificcolumnsofthetable,clicktheColumnsbuttonnexttothetable,asshownbelow:

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    38 BioMA Spatial User Guide

    Notethatthecolumnsthatbelongtothattablearenowlistedintherightpane.

    5 Toenablethecolumnsselection,clicktheIncludeinoutputcheckboxasshownbelow:

    6 SelectthecolumnsyouwanttoincludeinthemodeloutputbyselectingtheIncludeinoutputcheckboxnexttothecolumn.

    7 Ifneeded,youcanusetheSelect/Deselectallbuttonatthebottomofthewindowtooperateonallcolumnsatonce.

    8 Onceyouarefinished,clicktheSaveconfigurationbuttonatthetopleftofthewindow.YouwillthenbeabletoreloadtheconfigurationbyusingtheLoadconfigurationbutton.

    9 ClicktheMakethisthedefaultconfigurationbuttonifthisisthecase.

  • 39

    CONFIGURING HOW TO STORE THE MODEL OUTPUT

    BioMA Spatial User Guide

    See also: Choosingandconfiguringthemodelingsolutiononpage 18 Configuringhowtostorethemodeloutputonpage 33 Runningthemodelsimulationonpage 40

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    40 BioMA Spatial User Guide

    Running the model simulationPrerequisites: Youhavechosen,configured,andsuccessfullyvalidatedthemodeling

    solutiontorun(byclickingonValidatevalues ).SeeChoosingandconfiguringthemodelingsolutiononpage 18.

    Youhavespecifiedhowthesimulationresultswillbesaved.SeeConfiguringhowtostorethemodeloutputonpage 33.

    To run the simulation:1 IntheSimulationareaatthebottomrightoftheBioMAwindow,

    enteraSimulationdescription.2 IntheBioMAmainmenu,click tolaunch

    thesimulation.Notethatduringthesimulation,twoactivitiesarecarriedon: Themessagesfromthemodelingsolutioncode(e.g.,errors,

    progressstatus)areshownintheLogwindowatthetopleft. IntheSimulationareatheSimulationprogressisshown:

    3 EnsurethattheEndofthesimulationmessageisdisplayedintheLogwindowandnoerrorsaredetected.

    4 AnalyzetheresultsofthesimulationbyusingoneoftheBioMAplugins,thatisMapVisualizerorSimulationResultVisualizer.

    Related topics: UsingMapDataVisualizertoviewthesimulationresultsonpage 42 UsingSimulationResultVisualizertoviewthesimulationresultson

    page 44

  • 41

    SAVING AND LOADING A CONFIGURATION

    BioMA Spatial User Guide

    Saving and loading a configuration

    Saving a configurationWhenyouarefinishedwiththemodelconfiguration(seeChoosingandconfiguringthemodelingsolutiononpage 18),itispossibletosavetheconfigurationintoafile,soastoavoidrebuildingitmanytimes.

    To save the configuration:1 Inthemainmenu,clickthesavebutton .2 IntheSaveaconfigurationfilewindowthatisdisplayed,enteraFile

    name.3 ClickSave.ThefilewillbesavedasaBioMAconfigurationfile(*.BCF

    file)thatyouwillbeabletoreload,asitisdescribedinthesectionbelow.

    Note:BydefaultthefilewillbesavedintheBiomaConfigFilesfolder,butyoucanchooseanotherdirectory.

    Loading a pre-saved configurationItispossibletoopenandrunaconfigurationthatwaspreviouslysaved.

    To load a configuration:1 Clicktheloadbutton .2 IntheOpenaBiomaconfigurationfile(.bcf)windowthatis

    displayed,selectthedesiredfile.TheavailablefilesdependonyourBioMAinstallation.

    3 ClickOpentoreturntotheBioMAMainpagewheretheselectedmodelconfigurationwillbedisplayed.

    Related topics: UsingMapDataVisualizertoviewthesimulationresultsonpage 42 UsingSimulationResultVisualizertoviewthesimulationresultson

    page 44

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    42 BioMA Spatial User Guide

    Using Map Data Visualizer to view the simulation resultsAfterrunningasimulation,youcanusetheMapDataVisualizer(MDV)BioMAplugintoviewtheresults.MDVallowsinspectingandvisuallyanalyzingtheoutputsofsimulationsthroughgraphsandmaps,aswellasdisplayingvaluesforspecificareasastimeseries.MDVcanbeusedintwoways:asaBioMASpatialplugin,orasastandalonecomponent.However,thefunctioningisexactlythesame.

    Using Map Data Visualizer as a BioMA plugin

    To launch MDV:1 Afterrunningthesimulation(seeRunningthemodelsimulationon

    page 40),clickthe buttonintheBioMAtoolbar.TheMapDataVisualizerwindowpopsup.

    2 SelectaWorkSetfromthedropdownlist.Thisdefinesthedatabasetoqueryandthetypologyofdata.

    3 TheMDVfeaturesallowsyouto: Changethelegendtoapplytothemap Changethecolorsofthemap Customizethemaplayoutbyaddinginformation Savethelegendsettingsforalaterreuse Exportthemaptodifferentfileformats Usethecontrolstonavigate,inspect,andzoomthemap Drawagraphofspecificgeographicalelements

    4 Fordetailedinstructionsonhowtouseeachfeature,fromthemenutoolbarofMDV,select (Help)>UserGuide.

    See also: Choosingandconfiguringthemodelingsolutiononpage 18

    To access the MDV Help:MDV has its own User Guide, which you can access by selecting (Help) > User Guide from the tools menu bar. Alternatively, to access the Web-based version of the Help go to http://bioma.jrc.ec.europa.eu/mdv/help .

    http://bioma.jrc.ec.europa.eu/mdv/help

  • 43

    USING MAP DATA VISUALIZER TO VIEW THE SIMULATION RESULTS

    BioMA Spatial User Guide

    Configuringhowtostorethemodeloutputonpage 33 Runningthemodelsimulationonpage 40 UsingSimulationResultVisualizertoviewthesimulationresultson

    page 44

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    44 BioMA Spatial User Guide

    Using Simulation Result Visualizer to view the simulation results

    Afterrunningasimulation,youcanuseoneoftheBioMApluginstoanalyzetheresults.Inthissection,isdescribedhowtoviewtheresultsgraphically.TheSimulationResultVisualizerallowsviewingtheresultofasimulationinatableforanalysispurposes.Youcanthenexportthetableinacommaseparatedvaluesfile(CSV)thatcanbeopenedinMicrosoftExcel(seeExportingtheresultstoaCSVfileonpage 47).Inthissection: LaunchingtheSimulationResultVisualizerfromBioMASpatialon

    page 45 ExportingtheresultstoaCSVfileonpage 47

    Related topics: UsingMapDataVisualizertoviewthesimulationresultsonpage 42

  • 45

    USING SIMULATION RESULT VISUALIZER TO VIEW THE SIMULATION RESULTS

    BioMA Spatial User Guide

    Launching the Simulation Result Visualizer from BioMA Spatial

    Prerequisite:YouhaveconfiguredtheXMLpersister,whichallowssavingthesimulationresultsinXMLformattobereadbytheSimulationResultVisualizer.SeeConfiguringhowtostorethemodeloutputonpage 33forfurtherinformation.

    Procedure1 Afterrunningthesimulation(seeRunningthemodelsimulationon

    page 40),clicktheSimulationresultvisualizerbuttonintheBioMAtoolbar.TheResultVisualizerwindowisdisplayed:

    2 ClicktheLoadBioMAsimulationresultindexfile(.brifile)button.3 Inthewindowthatisdisplayed,selectthesimulationresultfileyou

    wanttoanalyze.Notethat: Thesimulationresultsarestoredinthe[BioMA installation

    directory]/ResultLogsdirectoryasfileswith.briextension(BioMA Result Indexfiles).

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    46 BioMA Spatial User Guide

    Thenameofthefilecontains:thenameofthemodel,thesimulationIDandthedate/hourwhenthesimulationwasstarted.Example:ThefileResultIndex_Model_WOFOSTModelCaller_SimId_17_starttime

    _2013-11-10_12-29-34_log.briisthesimulationresultofaWOFOSTmodel,simulationID17,startedat12:29,10/11/2013.

    4 ClickOpen.Asaresult,thetableontheleftwillbefilledwiththeidentifierofeachiteration(onyearandlocationcolumns)ofthesimulation:

    5 Dooneofthefollowing: Doubleclickonarowtoshowtheresultofaspecificiteration. ClicktheLoadalldatabuttontoloadalltheresults.Theresultsareshowninthetableontherightofthewindow.

    6 Youcannow: ExporttheresultfileintoaCSVfile,asdescribedbelow. OpenthetableswiththeGraphicDataViewer(GDD)pluginby

    clickingthebuttonOpentableswithGDDatthebottomleft.

    Related topics: ExportingtheresultstoaCSVfileonpage 47

    Tip:If the model output is stored in more than one data set (corresponding to a database table), select the table in the Tables pane at the bottom-left of the window. Note that, by default, the first one is selected.

  • 47

    USING SIMULATION RESULT VISUALIZER TO VIEW THE SIMULATION RESULTS

    BioMA Spatial User Guide

    Exporting the results to a CSV fileDothefollowing:1 Ifthesimulationhasbeenexecutedonmanylocations/years,there

    aretwopossiblescenarios: Toexporttheresultsofeachlocation/yearinadifferentfile,click

    onExporttabletoCSVtoexportthecontentofthatspecifictable. Toexportthewholesimulationresultinasinglefile,clickLoadall

    dataandthanExporttabletoCSV.2 InthewindowSaveaCSVfilethatisdisplayed,enteranameforthe

    fileandclickSave.Bydefault,thefilewillbesavedintotheResultLogfolderofyourBioMAinstallationdirectory.

    Related topics: LaunchingtheSimulationResultVisualizerfromBioMASpatialon

    page 45

    See also: Choosingandconfiguringthemodelingsolutiononpage 18 Configuringhowtostorethemodeloutputonpage 33 Runningthemodelsimulationonpage 40 UsingMapDataVisualizertoviewthesimulationresultsonpage 42

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    48 BioMA Spatial User Guide

    Deploying pluginsThisfunctionallowsextendingtheBioMAgraphicaluserinterfacebyloadingplugins.

    To deploy a plugin:1 Copyyourpluginssoftwarelibrariesintothepluginsdirectoryofthe

    BioMASpatialinstallationfolder.2 Clickthe SettingsbuttonintheBioMASpatialtoolbar.3 Fromthedropdownlist,selectPluginconfiguration.Thefollowingis

    displayed:

    TheRegisteredpluginslistincludesallpluginsalreadyregisteredandfunctioninginBioMASpatial,suchas,MPE,MCE,andsoforth.

    4 Toaddthenewplugin,enteritsFullclassnameandthepluginsAssemblypath.

    5 ClicktheRegisterbuttonatthebottomofthewindow.6 Toderegisteraplugin,clicktheDeregisterlinkintheRegistered

    pluginsgrid.

  • 49

    MANAGING LIBRARIES AND REGIONAL SETTINGS

    BioMA Spatial User Guide

    Managing libraries and regional settingsBydeployinglibrariesandpackagestheusercanmakeavailabletotheapplicationnewfunctionalities.Forexample,theusercanaddtotheapplicationnewweatherproviders(Libraries)andnewmodellingsolutions(Packages),aswellasnewparametersproviders.Furthermore,userscandeploytheRegionalSettings,whichallowfillingtheapplicationwithallthefilesneededforrunningamodellingsolutioninaspecificcontext,suchasdataforaspecificregion,mappingandshapefiles,andsoforth.

    To access the Libraries management and regional settings function:1 IntheBioMASpatialtoolbar,clicktheSettingsmenubutton,then

    selectLibrariesmanagementandregionalsettings:

    Thefollowingwindowisdisplayed:

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    50 BioMA Spatial User Guide

    Deploying libraries, modelling solutions, and regional settings

    Deploying a libraryLibrariesareutilityDLLsforthefunctioningoftheapplication.Forexample,librariesrelatetowheatearproviders,soildataproviders,andagromanagementproviders.

    To deploy a library:1 ToaddnewweatherdataproviderstoBioMASpatial,clickChoosea

    librarytodeploy.2 IntheBioMAinstallationfolderbrowsetoselectthelibrary(.dll)you

    wanttodeploy.Theselectedlibrarywillbeaddedtothelistinthetableunderneath.

  • 51

    MANAGING LIBRARIES AND REGIONAL SETTINGS

    BioMA Spatial User Guide

    Deploying a modelling solutionTouseamodellingsolutioninBioMASpatial,usersmustdeployaBioMApackagefile(.bpkgfile),whichcontainsoneormorelibraries(.dllor.exefiles)andthe.xmlconfigurationfiles.PackagesareusedtocollectallthefilesthatareneededtodeployamodelingsolutioninBioMASpatial.

    To deploy a modelling solution:1 ToaddamodellingsolutiontoBioMASpatial,clickChooseapackage

    todeploy.2 Browsetolocatethe.bpkgfilethatyouwanttodeploy(e.g.,

    WofostPackage.bpkg),thenclickOpen.3 CheckDeployasmodelingsolution,thenclickDeploy.BioMASpatial

    willrestartandwillnowincludethemodellingsolutionpackageyoudeployed.

    4 RepeatthesameoperationforanymodellingsolutionyouwanttouseinBioMASpatial.

    Deploying the regional settingsBydeployingtheregionalsettingsuserscanaddtoBioMASpatialallthefilesthatareneededforrunningmodellingsolutionsinaspecificcontext,suchas: Aweatherprovider,orasoilprovider,togetdataforaspecificregion TheMappingfilestoconnecttodatabases TheBioMAconfigurationfiles(.bcf)thatwehaveprovidedtoquickly

    configureasimulationrun TheShapeFilesandtheconfigurationfiles,tobeabletoplotmapsby

    usingtheMapDataVisualizer(MDV)toolforthespecificregion/modelingsolution(s)

    Thecropmasksdefinitionstobeusedinthelocationselector TheParameterfilescontainingthemodelingsolution(s)parameters

    forthespecificcontextofthesimulation TheAgromanagementfilescontainingtheagromanagementrulesfor

    thesimulationsspecificcontext Theportabledatabasescontainingdatathatareusedforthe

    simulation,aswellastoprovidetablestostorethesimulationresults TheBioMAsettingsfiles

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    52 BioMA Spatial User Guide

    Otherfilesneededbyamodelingsolution

    To deploy the regional settings:1 AtthebottomleftoftheLibrariesdeployandregionalsettings

    window,clicktheAddbutton.

    2 Browsetoselectthe.brsfilethatyouwanttouseasregionalsettings.3 Inthepopupthatdisplaysinformingyouthattheexistingregional

    settingsfileswillbedeleted,clickOk,thenwaitfortheunzipprocesstocomplete(thismightrequirefewminutes).

    4 Attheend,themessageRegionalsettingsunzippedwillbedisplayed(thismightincludesomepotentialwarningssayingthatsomedllsarealreadyloadedinBioMAandcannotbeoverwritten).

    5 ClickOk.Theapplicationwillberestarted.

    See also: Installationprocedureonpage 7

    Attention:If a regional settings set has already been deployed, this button is named Change and the name of the Current regional settings is displayed in this area.When you change the regional settings, the current set will be deleted, and so any data file belonging to it. Make a back-up of your sensible data (if any) before proceeding.

  • 53

    DELETING THE SIMULATION RESULTS FROM A DATABASE

    BioMA Spatial User Guide

    Deleting the simulation results from a database

    ThisoperationallowsdeletingtheBioMAsimulationresultsfromtheoutputdatabase.Usethisprocedureif,forexample,thedatabaseisfullofobsoletedata.

    Procedure:1 Selectthemodelingsolutionwhosedatayouwanttodelete(see

    Choosingthemodelingsolutiononpage 18).2 ClicktheSimulationresultcleanerbuttonintheBioMAtoolbar.3 Inthewindowthatisdisplayed,fromtheConnectionprovider

    dropdownlist,selecttheconnectiontothedatabaseyouwanttoclean.(ClickTestconnectiontoverifythattheconnectionisproperlyworking).

    4 IntheAdditionalparameterspane,fillinanyrequiredparameterdependingonthedatabaseyouselected.Forexample,browsetoselectaspecificdatabasefile.

    5 FromtheChoosethesimulationtocleandropdownlistatthebottomofthewindow,selectthesimulationyouwanttodelete.

    6 ClicktheCleanresultsbuttontodeleteallrecordsoftheselectedsimulation.

    Related topics: Choosingandconfiguringthemodelingsolutiononpage 18 Configuringhowtostorethemodeloutputonpage 33 Runningthemodelsimulationonpage 40 Savingandloadingaconfigurationonpage 41

    What is this?This option is not always visible in BioMA Spatial. It will be made available upon request.

    Attention:Please note that cleaned data are deleted forever and cannot be retrieved.

  • 3 USING BIOMA SPATIAL TO RUN MODEL SIMULATIONS

    54 BioMA Spatial User Guide

    Help contentsGetting started with BioMA SpatialWhat BioMA Spatial it is used forInstalling and launching BioMA-SpatialPrerequisitesInstallation procedureUninstalling older versions of BioMA SpatialInstalling and launching the applicationDeploying the modelling solution packageDeploying the regional settings

    BioMA-Spatial workspace overview

    Using BioMA Spatial to run model simulationsChoosing and configuring the modeling solutionChoosing the modeling solutionConfiguring the modelling solutionIterating over multiple item valuesEstablishing the Internet connection to the database:Using the Location selector

    Configuring how to store the model outputRunning the model simulationSaving and loading a configurationSaving a configurationLoading a pre-saved configuration

    Using Map Data Visualizer to view the simulation resultsUsing Map Data Visualizer as a BioMA plugin

    Using Simulation Result Visualizer to view the simulation resultsLaunching the Simulation Result Visualizer from BioMA SpatialExporting the results to a CSV file

    Deploying pluginsManaging libraries and regional settingsTo access the Libraries management and regional settings function:Deploying libraries, modelling solutions, and regional settingsDeploying a libraryDeploying a modelling solutionDeploying the regional settings

    Deleting the simulation results from a database