Skip to contents

Find the LANDIS-II console for a local installation

landis_find.Rd

Returns the path to Landis.Console.dll for a locally-installed LANDIS-II. Resolution order: the LANDIS_CONSOLE environment variable, then a filesystem search under /opt for a build/Release/ path.

Usage

landis_find(check_version = TRUE, required_major = landis_target_version())

Arguments

check_version

Logical. When TRUE (default), verify the console's major version with landis_assert_version() and stop if it is not required_major. A version that cannot be determined also stops – see that function for why, and for the opt-out.

required_major

Integer. Required LANDIS-II major version. Defaults to landis_target_version(), the generation this package is built for.

Value

Character. Path to Landis.Console.dll, or NA_character_ if not found.

Details

The /opt search is a Linux convention and finds nothing on Windows, where LANDIS_CONSOLE is the only route. method = "local" is the default there (see tar_landis()), so a Windows user must set that variable.

See also

landis_assert_version(), landis_version(), landis_find_docker(), landis_run_local(), tar_landis()

Other LANDIS-II execution helpers: host_cpu_info(), landis_archive_rep(), landis_assert_version(), 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(), landis_version(), read_landis_resource_logs(), tar_landis(), validate_landis_scenario(), write_landis_scenario_file()