Skip to content
Snippets Groups Projects
Commit fe65c652 authored by Ruben Heinrich's avatar Ruben Heinrich
Browse files

[docs] deleted .Rds from non exported functions

parent 9434d11a
No related branches found
No related tags found
1 merge request!20Resolve "Prepare package for installation"
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sim_utils.R
\name{get_benchmark_paths}
\alias{get_benchmark_paths}
\title{get_benchmark_paths}
\usage{
get_benchmark_paths(ogs6_processlib_path)
}
\arguments{
\item{ogs6_processlib_path}{string: Path to OpenGeoSys 6 ProcessLib folder
which contains relevant Tests.cmake files}
}
\description{
Gets paths to all benchmarks that should work
}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sim_utils.R
\name{run_all_benchmarks}
\alias{run_all_benchmarks}
\title{run_all_benchmarks}
\usage{
run_all_benchmarks(
path,
ogs6_processlib_path,
ogs6_bin_path,
sim_path,
starting_from_prj_path = "",
print_results = TRUE
)
}
\arguments{
\item{path}{string: Path to benchmark folder}
\item{ogs6_processlib_path}{string: Path to OpenGeoSys 6 ProcessLib folder
which contains relevant Tests.cmake files}
\item{ogs6_bin_path}{string:}
\item{sim_path}{string: Path where simulation files will be saved}
\item{starting_from_prj_path}{string: \code{.prj} path to start from}
\item{print_results}{flag: Print results in the end?}
}
\description{
Utility function, for quick benchmark runs. Calls
run_benchmark internally.
}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sim_utils.R
\name{run_benchmark}
\alias{run_benchmark}
\title{run_benchmark}
\usage{
run_benchmark(prj_path, ogs6_bin_path, sim_path)
}
\arguments{
\item{prj_path}{string:}
\item{ogs6_bin_path}{string:}
\item{sim_path}{string: Path where simulation files will be saved}
}
\description{
Utility function for quick benchmark runs
}
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