biogeme_setup: Automatically prepare the native Biogeme runtime

In rbiogeme: Interface to 'Biogeme'

Automatically prepare the native Biogeme runtime

Description

This is the recommended first command for a new user. With no python argument, reticulate provisions an isolated managed environment containing the configured Biogeme requirement when the runtime is first initialized. If python is supplied, that existing interpreter is selected instead and must already contain the requested Biogeme package. In both cases the function returns the same actionable status object as biogeme_check().

Usage

biogeme_setup(
  python = NULL,
  biogeme_requirement = NULL,
  debug = NULL,
  verbose = interactive()
)

Arguments

python	Optional existing Python executable. If omitted, use the reticulate-managed environment when no user-managed environment has been selected.
biogeme_requirement	Python requirement to provision or verify. Defaults to ⁠biogeme==3.3.5⁠.
debug	If TRUE, preserve the Python traceback in Biogeme error conditions.
verbose	If TRUE, print the setup status and any corrective actions.

Value

An object of class biogeme_check. Its ready element is TRUE when the runtime can be used for model operations.

See Also

biogeme_check(), biogeme_config()

rbiogeme documentation built on Sept. 29, 2026, 5:09 p.m.