From 0e75ff664c909e0ae45800e04e4e7223ec253f2b Mon Sep 17 00:00:00 2001 From: Ludovico Bianchi Date: Thu, 25 Apr 2024 12:48:42 -0500 Subject: [PATCH] Update installation instructions --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c3fafd9..2050a9c7 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,15 @@ These are *not* tested and *not* in the docs, and should generally be ignored by This repository can be installed with *pip*: ```shell -# RECOMMENDED: this will install the IDEAS examples, accessory code, -# plus the Graphical User Interface (GUI) to browse them (see section below) -pip install "idaes-examples[gui]" +# install the IDAES examples with a core set of dependencies +pip install idaes-examples + +# install the IDAES examples with additional dependencies needed to run specific examples, +# e.g. `omlt` for surrogate modeling with OMLT +pip install "idaes-examples[omlt]" + +# install the IDAES examples with dependencies need to build the documentation +pip install "idaes-examples[docs]" ``` We recommend you use a virtual environment tool such as