Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README installation instructions #172

Merged
merged 3 commits into from
Nov 20, 2023
Merged

Update README installation instructions #172

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69fd0f8
Update README.md with development install
tommyod Nov 14, 2023
d5613e9
Update README.md
tommyod Nov 14, 2023
109b03e
small readme change
Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
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