GamaExploration¶

class comokit4py.GamaExploration(experimentName: str, gamlFile: str, replication: int, final: int, experimentPerXML: int = - 1, xmlOutputName: str = 'headless.xml', until: str = '', seed: int = 0)¶

Bases: object

GamaExploration object

Object necessary for defining the exploration.

Parameters

experimentName (str) – Name of the experiment you want to explore
gamlFile (str) – Path to the GAML file to explore
replication (int) – Number of replication of each parameter combinaison
final (int) – Maximal step to explore (force end the simulation if not already finished)
experimentPerXML (int) – (Optional) Split exploration plan in several XML files [Default = disable = -1]
xmlOutputName (str) – (Optional) Name of the generated XML file(s) [Default = “headless.xml”]
until (str) – (Optional) Define GAML experiment end condition
seed (int) – (Optional) Starting seed value [Default = 0]
_expSpace (list) – (Generated) Experiment parameters space
_parametersList (list) – (Generated) List of experiment’s parameter

__init__(experimentName: str, gamlFile: str, replication: int, final: int, experimentPerXML: int = - 1, xmlOutputName: str = 'headless.xml', until: str = '', seed: int = 0)¶: Constructor for GamaExploration

calculatesExperimentSpace() → None¶

Scrap experiment’s parameters and calculate all the possible combinaison

Results are store in object’s variables [expSpace, parametersList]

Returns: None

getExperimentName() → str¶

Return setted GAML experiment name

Returns: GAML experiment name

getExperimentPerXML() → int¶

Return setted number of simulation by xml

Note

This parameter is useful for launching several GAMA in parallel

Returns: Simulation per XML number

getExperimentSpace() → list¶

Return generated experiment space parameters (full combinaison set)

Warning

This parameter is automatically setted by the self.calculatesExperimentSpace() function

Returns: list

getFinal() → int¶

Return setted maximal step for simulations

Returns: Max final step

getGamlFile() → str¶

Return setted GAML file

Returns: GAML file

getParametersList() → list¶

Return generated experiment parameters list

Warning

This parameter is automatically setted by the self.calculatesExperimentSpace() function

Returns: list

getReplication() → int¶

Return setted replication number

Returns: Replication number

getSeed() → int¶

Return setted starting seed

Returns: Seed

getUntil() → str¶

Return setted simulation stop condition

Returns: Stop condition

getXmlOutputName() → str¶

Return setted XML name file (used for gama headless)

Returns: XML name file

setExperimentName(experimentName: str) → None¶

Set GAML experiment name for exploring

Parameters: experimentName (str) – GAML experiment name
Returns: None

setExperimentPerXML(experimentPerXML: int) → None¶

Set number of simulation by xml

Note

This parameter is useful for launching several GAMA in parallel

Parameters: experimentPerXML (int) – Simulation per XML number
Returns: None

setFinal(final: int) → None¶

Set maximal step for simulations

Parameters: final (int) – Max final step
Returns: None

setGamlFile(gamlFile: str) → None¶

Set GAML file

Parameters: gamlFile (str) – GAML file
Returns: None

setReplication(replication: int) → None¶

Set replication number

Parameters: replication (int) – Replication number
Returns: None

setSeed(seed: int) → None¶

Set starting seed

Parameters: seed (str) – Start seed value
Returns: None

setUntil(until: str) → None¶

Set simulation stop condition

Parameters: final (str) – Stop condition
Returns: None

setXmlOutputName(xmlOutputName: str) → None¶

Set XML name file (used for gama headless)

Parameters: xmlOutputName (str) – XML name file
Returns: None