feat: add support for conda environments (#35)

* feat: add support for conda environments

* add conda to ci; clean up public API

* feat: add yaml config param to acro init

* chore: clean up conda warning message

---------

Signed-off-by: Richard Preen <rpreen@gmail.com>
Co-authored-by: Jim-smith <jim-smith@users.noreply.github.com>

Author: rpreen

.github/workflows/R-CMD-check.yaml

@@ -3,43 +3,67 @@ on:
     branches: [main, master]
   pull_request:
     branches: [main, master]
+
 name: R-CMD-check
+
 jobs:
   R-CMD-check:
     runs-on: ${{ matrix.os }}
-    name: ${{ matrix.os }} (${{ matrix.r }})
+    name: ${{ matrix.os }} (${{ matrix.r }}) - ${{ matrix.backend }}
+
     strategy:
       fail-fast: false
       matrix:
         include:
-          - { os: "ubuntu-latest", python: "3.13", r: "release" }
-          - { os: "windows-latest", python: "3.13", r: "release" }
-          - { os: "macOS-latest", python: "3.13", r: "release" }
-          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-1" }
-          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-2" }
-          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-3" }
+          - { os: "ubuntu-latest", python: "3.13", r: "release", backend: "venv" }
+          - { os: "ubuntu-latest", python: "3.13", r: "release", backend: "conda" }
+
+          - { os: "windows-latest", python: "3.13", r: "release", backend: "venv" }
+          - { os: "windows-latest", python: "3.13", r: "release", backend: "conda" }
+
+          - { os: "macOS-latest", python: "3.13", r: "release", backend: "venv" }
+          - { os: "macOS-latest", python: "3.13", r: "release", backend: "conda" }
+
+          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-1", backend: "venv" }
+          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-2", backend: "venv" }
+          - { os: "ubuntu-latest", python: "3.10", r: "oldrel-3", backend: "venv" }
+
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
       MPLBACKEND: Agg
+      ACRO_USE_CONDA: ${{ matrix.backend == 'conda' && 'true' || 'false' }}
+
     steps:
       - name: Checkout ACRO
         uses: actions/checkout@v6
+
+      - name: Setup Miniconda
+        if: matrix.backend == 'conda'
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: ${{ matrix.python }}
+          auto-activate-base: false
+
       - name: Setup Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python }}
+
       - name: Setup pandoc
         uses: r-lib/actions/setup-pandoc@v2
+
       - name: Setup R
         uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.r }}
+
       - name: Install R dependencies
         uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: any::rcmdcheck
           needs: check
+
       - name: Check R Package
         uses: r-lib/actions/check-r-package@v2
         with:

R/acro_init.R

@@ -1,12 +1,96 @@
+# Globals -----------------------------------------------------------------
+acro_venv <- "r-acro"
+acro_pkg <- "acro==0.4.11"
+ch <- "conda-forge"
+
+
+# Internal helper: resolve Python executable
+## nocov start
+get_python <- function() {
+  python <- Sys.which("python3")
+  if (python == "") {
+    python <- Sys.which("python")
+    if (python == "") {
+      stop("Python not found in PATH. Please ensure Python is installed.")
+    }
+  }
+  return(python)
+}
+## nocov end
+
+
+# Internal helper: install ACRO in a Conda environment
+## nocov start
+install_conda <- function(envname) { # nocov
+  if (!reticulate::condaenv_exists(envname = envname, conda = "auto")) {
+    reticulate::conda_create(envname = envname, python_version = "3.12", channel = ch)
+    reticulate::conda_install(envname = envname, packages = acro_pkg, channel = ch)
+  }
+}
+## nocov end
+
+
+# Internal helper: install ACRO in a Python virtual environment
+install_venv <- function(envname = acro_venv) {
+  if (!reticulate::virtualenv_exists(envname)) {
+    python <- get_python()
+
+    reticulate::virtualenv_create(
+      envname = envname,
+      python = python,
+      force = TRUE,
+      packages = NULL
+    )
+
+    reticulate::py_install(acro_pkg, envname = envname)
+  }
+}
+
+
+# Internal helper: resolve whether Conda should be used
+get_use_conda <- function(use_conda = NULL) {
+  if (is.null(use_conda)) {
+    use_conda <- tolower(Sys.getenv("ACRO_USE_CONDA")) %in% c("1", "true", "yes")
+  }
+  use_conda <- isTRUE(use_conda) # default FALSE
+
+  if (use_conda && is.null(reticulate::conda_binary())) { # nocov
+    stop("Conda requested but no conda installation found", call. = FALSE) # nocov
+  }
+
+  return(use_conda)
+}
+
+
 #' Initialise an ACRO object
 #'
+#' @param config Name of a yaml configuration file with safe parameters.
 #' @param suppress Whether to automatically apply suppression.
+#' @param envname Name of the Python environment to use.
+#' @param use_conda Whether to use a Conda environment.
+#'   If `NULL`, looks for environment variable `ACRO_USE_CONDA`,
+#'   defaults to `FALSE` if unset.
 #'
-#' @return No return value, called for side effects
+#' @return Invisibly returns the ACRO object, which is used internally.
 #' @export
+acro_init <- function(config = "default", suppress = FALSE, envname = acro_venv, use_conda = NULL) {
+  # define the environment
+  use_conda <- get_use_conda(use_conda)
 
-acro_init <- function(suppress = FALSE) {
-  create_virtualenv()
+  # initialise the environment
+  if (!reticulate::py_available(initialize = FALSE)) {
+    if (use_conda) { # nocov
+      install_conda(envname) # nocov
+      reticulate::use_condaenv(envname, required = TRUE) # nocov
+    } else {
+      install_venv(envname)
+      reticulate::use_virtualenv(envname, required = TRUE)
+    }
+  }
+
+  # import the acro package and instantiate an object
   acro <- reticulate::import("acro", delay_load = TRUE)
-  acroEnv$ac <- acro$ACRO(suppress = suppress)
+  acroEnv$ac <- acro$ACRO(config = config, suppress = suppress)
+
+  invisible(acroEnv$ac)
 }

R/create_virtualenv.R

@@ -4,7 +4,7 @@ test_that("install_acro installs 'acro' in the specified environment", {
   test_envname <- "test-acro-env"
 
   # Run the install_acro function
-  install_acro(envname = test_envname)
+  install_venv(envname = test_envname)
 
   # Check if 'acro' is installed in the test environment
   is_installed <- reticulate::py_module_available("acro")