Skip to content

Commit

Permalink
Readme change
Browse files Browse the repository at this point in the history
  • Loading branch information
dom0015 committed May 28, 2024
1 parent 3837d4b commit 77cf246
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ $f_{U|Y}\left(u|y\right)\propto{f_{Z}\left(y-G\left(u\right)\right)}{f_{U}\left(
- a solver is typically a linked numerical library
- number of solvers is typically lower than number of chains

## Usage:
## Getting started:
- open repository in the Docker container (e.g. using the Dev Containers extension of Visual Studio Code)
- `pip install .`

Before running the sampling process, it is necessary to specify:
- configuration (basic settings, e.g. number of solvers, initial samples, ...)
- prior
Expand All @@ -41,7 +44,9 @@ Before running the sampling process, it is necessary to specify:
- surrogate model updater
- list of stages

See examples in the **/toy_examples** folder.
See examples in the **toy_examples** folder, e.g.:
- `cd toy_examples/`
- `mpiexec -n 4 python3 -m mpi4py minimal_example.py`

## Surrogate models:
The following non-intrusive surrogate models are implemented. They are constructed from snapshots $\left(u^{\left(k\right)},G\left(u^{\left(k\right)}\right)\right)$ and they can be adaptively refined during the sampling process.
Expand Down

0 comments on commit 77cf246

Please sign in to comment.