use_julia: Start Julia and activate environment

View source: R/julia_setup.R

use_juliaR Documentation

Start Julia and activate environment

Description

Start Julia session and activate Julia environment to simulate stock-and-flow models. To do so, Julia needs to be installed and findable from within R. See this vignette for guidance. In addition, the Julia environment specifically for sdbuildR needs to have been instantiated. This can be set up with install_julia_env().

Usage

use_julia(stop = FALSE, force = FALSE)

Arguments

stop

If TRUE, stop active Julia session. Defaults to FALSE.

force

If TRUE, force Julia setup to execute again.

Details

Julia supports running stock-and-flow models with units as well as ensemble simulations (see ensemble()).

In every R session, use_julia() needs to be run once (which is done automatically in simulate()), which can take around 30-60 seconds.

Value

Returns NULL invisibly, used for side effects

See Also

julia_status(), install_julia_env()

Examples


# Start a Julia session and activate the Julia environment for sdbuildR
use_julia()

# Stop Julia session
use_julia(stop = TRUE)


sdbuildR documentation built on Nov. 19, 2025, 5:07 p.m.