From 56ab349341ceb71dd35fad8fd3658d5784f1763a Mon Sep 17 00:00:00 2001 From: Tommy <10076072+tommyod@users.noreply.github.com> Date: Mon, 20 Nov 2023 11:51:12 +0100 Subject: [PATCH] Update README installation instructions (#172) * Update README.md with development install --------- Co-authored-by: Tommy Odland --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 554b13c2..1bcd4f27 100644 --- a/README.md +++ b/README.md @@ -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 . + +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