Skip to content
Snippets Groups Projects
Commit e2b4163a authored by Johannes Boog's avatar Johannes Boog
Browse files

[doc] options for ogs call via singularity exec

parent eaa816f7
No related branches found
No related tags found
1 merge request!41standardize files references during prj import/export (new MR)
......@@ -4,12 +4,15 @@
\alias{construct_ogs_command}
\title{construct_ogs_command}
\usage{
construct_ogs_command(ogs6_bin_path)
construct_ogs_command(ogs6_bin_path, singularity_opts)
}
\arguments{
\item{ogs6_bin_path}{string: Optional: Path to OpenGeoSys 6 executable or
OpenGeoSys container (singularity image) file. Defaults
to \code{options("r2ogs6.default_ogs6_bin_path")}}
\item{singularity_opts}{string: Optional: Options to singularity exec
command. Defaults to \code{options("r2ogs6.singularity_opts")}}
}
\value{
string: Call object.
......
......@@ -4,7 +4,13 @@
\alias{ogs6_call_ogs6}
\title{ogs6_call_ogs6}
\usage{
ogs6_call_ogs6(ogs6_obj, write_logfile = TRUE, ogs6_bin_path, verbose = F)
ogs6_call_ogs6(
ogs6_obj,
write_logfile = TRUE,
ogs6_bin_path,
verbose = F,
singularity_opts
)
}
\arguments{
\item{ogs6_obj}{OGS6: Simulation object}
......@@ -18,6 +24,9 @@ OpenGeoSys container (singularity image) file. Defaults
to \code{options("r2ogs6.default_ogs6_bin_path")}}
\item{verbose}{flag}
\item{singularity_opts}{string: Optional: Options to singularity exec
command. Defaults to \code{options("r2ogs6.singularity_opts")}}
}
\description{
Makes system call to OpenGeoSys 6 and retrieves exit code.
......
......@@ -10,7 +10,8 @@ ogs6_run_simulation(
ogs6_bin_path,
overwrite = T,
copy_ext_files = F,
verbose = F
verbose = F,
singularity_opts
)
}
\arguments{
......@@ -29,6 +30,9 @@ to \code{options("r2ogs6.default_ogs6_bin_path")}}
\code{ogs6_obj} be be copied to \code{ogs6_obj$sim_path}?}
\item{verbose}{flag}
\item{singularity_opts}{string: Optional: Options to singularity exec
command. Defaults to \code{options("r2ogs6.singularity_opts")}}
}
\description{
Wrapper function that calls \code{ogs6_export_sim_files()},
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment