run_DockerImage: Run the simulation software using the docker image.

View source: R/run_DockerImage.R

run_DockerImageR Documentation

Run the simulation software using the docker image.

Description

run_DockerImage runs the simulation software using the docker image.

Usage

run_DockerImage(
  input_folder,
  simulationCFGFile,
  mapFile,
  personsCFGFile,
  antennasCFGFile,
  output_folder
)

Arguments

input_folder

Absolute path of the folder which contains the input data.

simulationCFGFile

Name of the simulation configuration file.

mapFile

Name of the map file.

personsCFGFile

Name of the persons' configuration file.

antennasCFGFile

Name of the antennas' configuration file.

output_folder

Name of the output folder indicated in the simulation's configuration file.

Details

Return invisible NULL after executing the docker image.

Examples

rootPath <- system.file(package = "simutils")
input_folder <- file.path(rootPath, "extdata/input_files")
simulationCFGFile <- "simulation.xml"
mapFile <- "map.wkt"
personsCFGFile <- "persons.xml"
antennasCFGFile <- "antennas.xml"
output_folder <- file.path(Sys.getenv("HOME"), "example_docker")
## Not run: 
# run only after checking your installation of docker
run_DockerImage(
  input_folder = input_folder,
  simulationCFGFile = simulationCFGFile,
  mapFile = mapFile,
  personsCFGFile = personsCFGFile,
  antennasCFGFile = antennasCFGFile,
  output_folder = output_folder
)

## End(Not run)

bogdanoancea/simutils documentation built on April 4, 2022, 2:58 p.m.