Skip to content

Commit

Permalink
[doc] link to webpage vignettes in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joboog committed May 3, 2024
1 parent ed24e80 commit 597c19f
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

`r2ogs6` is an R-API to the multiphysics simulator [OpenGeoSys 6](https://gitlab.opengeosys.org/ogs/ogs).
`r2ogs6` allows pre-processing (preparing input files), executing simulation runs, retrieving, post-processing and visualizing output data in R.
Furthermore, the package comes with functionality to define [ensemble runs](vignettes/ensemble_workflow_vignette.Rmd).
Furthermore, the package comes with functionality to define [ensemble runs](https://joboog.github.io/r2ogs6/articles/ensemble_workflow_vignette.html).

## Setup

Expand Down Expand Up @@ -158,11 +158,10 @@ environment that you configured.

For tutorials on how to use the `r2ogs6` package, have a look at its vignettes:

* [User Guide](vignettes/user_workflow_vignette.Rmd)
* [Ensemble Guide](vignettes/ensemble_workflow_vignette.Rmd)
* [Developer Guide](vignettes/dev_workflow_vignette.Rmd)
* [User Guide](https://joboog.github.io/r2ogs6/articles/user_workflow_vignette.html)
* [Ensemble Guide](https://joboog.github.io/r2ogs6/articles/ensemble_workflow_vignette.html)
* [Developer Guide](https://joboog.github.io/r2ogs6/articles/dev_workflow_vignette.html)

Corresponding HTML versions can be found [here](inst/vignettes_built/).

## Links

Expand Down

0 comments on commit 597c19f

Please sign in to comment.