Skip to contents

Report the version of a LANDIS-II console

landis_version.Rd

Runs the console with no scenario file. It prints its version banner – LANDIS-II 8.0 (8) – and then exits with an error about the missing scenario, so a non-zero status is expected and is not treated as failure.

Usage

landis_version(
  console = NULL,
  image = NULL,
  container = NULL,
  timeout = 60,
  check_version = FALSE
)

Arguments

console

Character or NULL. Path to Landis.Console.dll; resolved via landis_find() when NULL and no image/container is given.

image

Character or NULL. Docker image to probe.

container

Character or NULL. Running container to probe.

timeout

Numeric. Seconds to wait for the console to print its banner.

check_version

Logical. Passed to landis_find() when console is NULL; FALSE here avoids infinite recursion.

Value

A numeric_version, or NA when the console, dotnet, or the banner cannot be found.

Details

The console can be a local install, a Docker image (probed with a throwaway container), or a container that is already running (probed with docker exec). Supply at most one of the three; console is the default.

See also

landis_find(), landis_assert_version()

Other LANDIS-II execution helpers: host_cpu_info(), landis_archive_rep(), landis_assert_version(), landis_find(), landis_find_docker(), landis_pool_exec(), landis_pool_restart_one(), landis_pool_start(), landis_pool_stop(), landis_replicate(), landis_run_docker(), landis_run_local(), landis_target_version(), read_landis_resource_logs(), tar_landis(), validate_landis_scenario(), write_landis_scenario_file()