Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
R
r2ogs6
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ogs
OpenGeoSys Tools
r2ogs6
Commits
b15deec9
Commit
b15deec9
authored
10 months ago
by
Johannes Boog
Browse files
Options
Downloads
Patches
Plain Diff
[doc] add example in README
parent
2c80e7b1
No related branches found
No related tags found
1 merge request
!65
Resolve "bugfix test failures"
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+37
-0
37 additions, 0 deletions
README.md
with
37 additions
and
0 deletions
README.md
+
37
−
0
View file @
b15deec9
...
@@ -158,6 +158,43 @@ environment that you configured.
...
@@ -158,6 +158,43 @@ environment that you configured.
## Usage
## Usage
To quickly test if your set up works just run a benchmark shipped with the
package.
Remember that if you closed your R session in between you may have to reset the
`ogs_bin_path`
by
```set_ogs6_bin_path()```
.
Now you can setup an example by:
```
sim_path <- tempdir()
# Create new ogs object
ogs6_obj <- OGS6$new(
sim_name = "my_simulation",
sim_path = sim_path
)
# Read in a project setup file
prj_path <- system.file(
"extdata/benchmarks/flow_no_strain/flow_no_strain.prj",
package = "r2ogs6"
)
read_in_prj(ogs6_obj, prj_path = prj_path, read_in_gml = T)
```
Just start the simulation, check if it succeeds (returns a "0" exit status) and
hav a look at the output.
```
ogs6_run_simulation(ogs6_obj)
ogs6_read_output_files(ogs6_obj)
result_df <- ogs6_obj$pvds[[1]]$get_point_data(keys = c("pressure"))
result_df
```
## Further Reading
For tutorials on how to use the
`r2ogs6`
package, have a look at its vignettes:
For tutorials on how to use the
`r2ogs6`
package, have a look at its vignettes:
*
[
User Guide
](
vignettes/user_workflow_vignette.Rmd
)
*
[
User Guide
](
vignettes/user_workflow_vignette.Rmd
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment