diff --git a/man/export_all_sim_files.Rd b/man/export_all_sim_files.Rd new file mode 100644 index 0000000000000000000000000000000000000000..d6710ab97f6817dc2aa5686693c25363a2001d49 --- /dev/null +++ b/man/export_all_sim_files.Rd @@ -0,0 +1,15 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/sim_utils.R +\name{export_all_sim_files} +\alias{export_all_sim_files} +\title{export_all_sim_files} +\usage{ +export_all_sim_files(ogs6_obj) +} +\arguments{ +\item{ogs6_obj}{OGS6: Simulation object} +} +\description{ +Exports and / or copies all simulation files to +`ogs6_obj$sim_path` +} diff --git a/man/generate_all_benchmark_scripts.Rd b/man/generate_all_benchmark_scripts.Rd index 6cbe61ea283689a03f2d42fae60480bb06dd4df4..0f1bf40d0e2d53e3d0beeb2f819b4620b4fb11cb 100644 --- a/man/generate_all_benchmark_scripts.Rd +++ b/man/generate_all_benchmark_scripts.Rd @@ -6,28 +6,30 @@ \usage{ generate_all_benchmark_scripts( path, - scripts_path = "D:/OGS_scripts/", + sim_path, + scripts_path, starting_from_prj_path = "", skip_prj_paths = character(), - read_in_vtus = TRUE, - test_mode = FALSE + read_in_vtus = FALSE, + read_in_gmls = TRUE ) } \arguments{ \item{path}{string: Path to a benchmark directory to generate scripts from} -\item{scripts_path}{string: Optional: Path where benchmark scripts will be -saved. Change this to fit your system!} +\item{sim_path}{string: Path where all simulation files will be saved} + +\item{scripts_path}{string: Path where benchmark scripts will be saved} \item{starting_from_prj_path}{string: Optional:} \item{skip_prj_paths}{character: Optional: .prj paths to skip} -\item{read_in_vtus}{flag: Optional: Should .vtu file just be copied or read +\item{read_in_vtus}{flag: Optional: Should .vtu files just be copied or read in too?} -\item{test_mode}{flag: Optional: In test mode, if `path` is missing, -internal function `get_default_benchmark_path()` will be called} +\item{read_in_gmls}{flag: Optional: Should .gml files just be copied or read +in too?} } \description{ Wrapper function to generate benchmark scripts from all .prj diff --git a/man/generate_benchmark_script.Rd b/man/generate_benchmark_script.Rd index 8b5e9f84c91c776773776b6e0466cd16cef355c0..03126b37ab49b07c25160bbde2c3fb99ce403b50 100644 --- a/man/generate_benchmark_script.Rd +++ b/man/generate_benchmark_script.Rd @@ -6,16 +6,21 @@ \usage{ generate_benchmark_script( prj_path, - script_path = "D:/OGS_scripts/", + sim_path, + ogs_bin_path, + script_path, read_in_vtu = FALSE, read_in_gml = TRUE ) } \arguments{ -\item{prj_path}{The path to the project file the script will be based on} +\item{prj_path}{string: .prj file the script will be based on} -\item{script_path}{string: Optional: Path where benchmark script will be -saved. Change this to fit your system!} +\item{sim_path}{string: Path where all simulation files will be saved} + +\item{ogs_bin_path}{string: OpenGeoSys bin folder path} + +\item{script_path}{string: Path where benchmark script will be saved} \item{read_in_vtu}{flag: Optional: Should .vtu file(s) just be copied or read in too?} diff --git a/man/run_all_benchmarks.Rd b/man/run_all_benchmarks.Rd index 894ad85090ad96ed61be81ac0d428a99f89aae20..bae51934b6c08aa3a00e6fff21dad38d4d6f9ee4 100644 --- a/man/run_all_benchmarks.Rd +++ b/man/run_all_benchmarks.Rd @@ -7,7 +7,7 @@ run_all_benchmarks( path, ogs_bin_path, - sim_path = "D:/OGS_all_simulations/", + sim_path, starting_from_prj_path = "", print_failed_prj_paths = TRUE ) @@ -19,9 +19,9 @@ run_all_benchmarks( \item{sim_path}{string:} -\item{starting_from_prj_path}{string:} +\item{starting_from_prj_path}{string: .prj path to start from} -\item{print_failed_prj_paths}{flag:} +\item{print_failed_prj_paths}{flag: Output paths where `read_in_prj()` failed?} } \description{ Utility function, for quick benchmark runs. Calls diff --git a/man/run_benchmark.Rd b/man/run_benchmark.Rd index 0a4e00a0f8e12a18c2df36a9bf6b3fbd9cd2e04b..f668ee37584d0420082c14c41ddbc7c67a2c578f 100644 --- a/man/run_benchmark.Rd +++ b/man/run_benchmark.Rd @@ -4,15 +4,14 @@ \alias{run_benchmark} \title{run_benchmark} \usage{ -run_benchmark(prj_path, ogs_bin_path, sim_path = "D:/OGS_all_simulations/") +run_benchmark(prj_path, ogs_bin_path, sim_path) } \arguments{ \item{prj_path}{string:} \item{ogs_bin_path}{string:} -\item{sim_path}{string: Optional: Path where simulation files will be saved. -Change this to fit your system!} +\item{sim_path}{string: Path where simulation files will be saved.} } \description{ Utility function for quick benchmark runs diff --git a/man/validate_all.Rd b/man/validate_all.Rd index 9072c1c72c2e997c3837f5fdf9f3c6fa40e87fc0..63e8c655c286a981abbcba96501ecf3fe1c4ed91 100644 --- a/man/validate_all.Rd +++ b/man/validate_all.Rd @@ -7,7 +7,7 @@ validate_all(ogs6_obj) } \arguments{ -\item{ogs6_obj}{A OGS6 class object} +\item{ogs6_obj}{OGS6: Simulation object} } \description{ Validates all necessary parameters