R/envvars.R

In tulpa: Templated Unified Library for Posterior Approximation in Bayesian Hierarchical Models

#' Environment variables tulpa reads
#'
#' Switches read from the process environment rather than from a fitter's
#' `control` list, because each one changes how the compiled kernels partition
#' work or which tests run rather than what model is fitted.
#'
#' @section Parallel scatter:
#'
#' \describe{
#'   \item{`TULPA_SCATTER_FORCE_PARALLEL=1`}{Takes the per-thread parallel fill
#'     of an uncoupled arm's per-observation scatter whatever its size, instead
#'     of only where the fill work outweighs the per-thread buffers. Read on
#'     every scatter call, so it can be set within a session.}
#' }
#'
#' The cell-coupled scatter needs no switch: its cells are split into a fixed
#' number of chunks set by the cell count alone, so a fit returns the same
#' numbers at every thread count.
#'
#' @section Test-suite tiers:
#'
#' `TULPA_FAST`, `TULPA_SLOW_TESTS` and `TULPA_FULL_RECOVERY` select which cost
#' tier of the test suite runs; they are read by the suite, not by the package,
#' and are described in `tests/testthat/README.md`.
#'
#' @name tulpa-envvars
#' @keywords internal
NULL