Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lbianchi-lbl committed Apr 25, 2024
1 parent 036f05c commit 0e75ff6
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0e75ff6

Please sign in to comment.