-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '90-add_fun_install_ogs_commit_reorganize' into 'master'
Resolve "Add function to install ogs and python dependencies" Closes #90 See merge request ogs/tools/r2ogs6!64
- Loading branch information
Showing
17 changed files
with
1,011 additions
and
698 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # Function based on: | ||
| # https://rstudio.github.io/reticulate/articles/python_dependencies.html | ||
|
|
||
| #' Install specific version of OpenGeoSys 6 (OGS) along with necessary Python | ||
| #' packages `vtk` and `numpy` into a specified Python virtual environment. | ||
| #' Note, this does not work with `conda` environments. | ||
| #' | ||
| #' @param ogs_version The version of OGS to install (default: 6.4.4). | ||
| #' @param envname The name of the Python virtual environment (default: r2ogs6). | ||
| #' @param ... Rest of the arguments passed to "py_install()" | ||
| #' @return None. | ||
| #' | ||
| #' @export | ||
| install_ogs <- | ||
| function(..., | ||
| ogs_version = "6.4.4", | ||
| envname = "r2ogs6" | ||
| ) { | ||
|
|
||
| if (!(reticulate::virtualenv_exists(envname))){ | ||
| stop( | ||
| paste0('The Python virtual environment "', envname, | ||
| '" does not exist. You can create it with ', | ||
| 'reticulate::virtualenv_create("r2ogs6").\n', | ||
| 'Make sure that this environment is used as the actual ', | ||
| 'Python configuration; see reticulate::py_config().' | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| pkgs <- c(paste0("ogs==", ogs_version), "numpy", "vtk") | ||
|
|
||
| reticulate::py_install( | ||
| packages = pkgs, | ||
| envname = envname, | ||
| ... | ||
| ) | ||
| } | ||
|
|
||
|
|
||
| #' Set default OpenGeoSys 6 binary path | ||
| #' | ||
| #' This function automatically detects and temporarily sets the path to the | ||
| #' OpenGeoSys (OGS) binary within the active Python virtual environment. It is | ||
| #' typically called after installing OGS using the `install_ogs()` function. | ||
| #' For a permanent setting of the OGS binary path, consider to define | ||
| #' `r2ogs6.default_ogs6_bin_path` in a `config.yml` file.' | ||
| #' | ||
| #' @return None, but it sets an option `r2ogs6.default_ogs6_bin_path` to point | ||
| #' to the detected OGS binary path. | ||
| #' | ||
| #' @export | ||
| set_ogs6_bin_path <- | ||
| function() { | ||
| cfg <- reticulate::py_config() | ||
|
|
||
| has_python <- reticulate::py_available(initialize = FALSE) | ||
| has_numpy <- reticulate::py_numpy_available(initialize = FALSE) | ||
| has_vtk <- reticulate::py_module_available("vtk") | ||
| has_ogs <- reticulate::py_module_available("ogs") | ||
| assertthat::assert_that( | ||
| isTRUE(has_python), isTRUE(has_numpy), isTRUE(has_vtk), | ||
| isTRUE(has_ogs) | ||
| ) | ||
|
|
||
| # Search for ogs binary in potential paths | ||
| if (Sys.info()["sysname"] == "Windows") { | ||
| bin_dir <- "Scripts" | ||
| ogs_name <- "ogs.exe" | ||
| } else { | ||
| bin_dir <- "bin" | ||
| ogs_name <- "ogs" | ||
| } | ||
| virtualenv_path <- win_to_linux_path(cfg$virtualenv) | ||
| ogs_bin_dir <- file.path(virtualenv_path, bin_dir) | ||
| files <- list.files(ogs_bin_dir, full.names = TRUE) | ||
| ogs_bin_path <- files[grepl(paste0(ogs_name, "$"), basename(files))] | ||
|
|
||
| assertthat::assert_that( | ||
| file.exists(ogs_bin_path), | ||
| msg = "OGS executable not found." | ||
| ) | ||
| assertthat::assert_that( | ||
| basename(ogs_bin_path) %in% c("ogs.exe", "ogs"), | ||
| msg = "OGS executable not found." | ||
| ) | ||
| options("r2ogs6.default_ogs6_bin_path" = ogs_bin_path) | ||
|
|
||
| message( | ||
| paste0( | ||
| 'The option "r2ogs6.default_ogs6_bin_path" was temporarily ', | ||
| 'set to "', ogs_bin_path, '" .\n', | ||
| 'For a permanent setting of "r2ogs6.default_ogs6_bin_path=', | ||
| ogs_bin_path, ' define it in a "config.yml" file.' | ||
| ) | ||
| ) | ||
| } |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.