run_archimed: Run ARCHIMED

In VEZY/archimedR: A Package To Manage ARCHIMED Simulations

Description

Run ARCHIMED

Usage

run_archimed(
  exe = file.path(getwd(), "archimed.jar"),
  memory = 4096,
  config = NULL,
  args = NULL,
  java = NULL
)

Arguments

exe	Path to the ARCHIMED executable file including its name
memory	The memory allocated to the JVM (Java Virtual Machine) in megabytes (see details)
config	The configuration file. The function tries to find it if not provided. If the function finds no configuration file, or several, it exits and returns FALSE.
args	Further arguments to pass to the ARCHIMED app
java	Java path (optionnal, see details)

Details

The memory actually used to run ARCHIMED is the minimum between the input memory and the available memory on the system (see get_free_ram()). The java argument can be a path to the java executable if the user needs a particular version (for example if the default Java used is the Open JDK, because ARCHIMED is only compatible with the Oracle version).

Value

The function prints the model outputs to the console and returns TRUE if ARCHIMED ran successfully, or an error code if any problem occured

Note

If you are using a version of ARCHIMED prior to 2018, you need to pass Archimed in the configuration file, such as run_archimed(path= "archimed.jar", config= "Archimed app_parameters/ArchimedConfiguration.properties")

Examples

## Not run: 
run_archimed(path= "Archimed/archimed.jar", config= "app_parameters/config.properties")

## End(Not run)

VEZY/archimedR documentation built on Feb. 28, 2020, 6:36 p.m.