Skip to content

Commit

Permalink
Update README installation instructions (#172)
Browse files Browse the repository at this point in the history
* Update README.md with development install

---------

Co-authored-by: Tommy Odland <tommy.odland>
  • Loading branch information
tommyod authored Nov 20, 2023
1 parent 6599b27 commit 56ab349
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,20 @@ This algorithm is particularly effective for problems with a large number of par
pip install iterative_ensemble_smoother
```

## Usage

**iterative_ensemble_smoother** mainly implements `SIES` and `ESMDA` classes. Check out
the examples section to see how to use them.


## Building from source

To build **iterative_ensemble_smoother** from source:
If you want to do development, then run:

```bash
```text
git clone https://github.com/equinor/iterative_ensemble_smoother.git
cd iterative_ensemble_smoother
pip install .
<create environment>
pip install --editable '.[doc,dev]'
```

## Usage

**iterative_ensemble_smoother** mainly implements the two classes `SIES` and `ESMDA`.
Check out the examples section to see how to use them.

## Building the documentation

```bash
Expand Down

0 comments on commit 56ab349

Please sign in to comment.