Skip to content

Commit

Permalink
README: Install All Dependencies
Browse files Browse the repository at this point in the history
Fix the readme so it installs all dependencies by default.
Follow-up to optimas-org#156.

Use recommended/best practice pip syntax (as a module).
  • Loading branch information
ax3l committed Mar 28, 2024
1 parent 2c5a16d commit df1aadb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ Optimas is a Python library designed for highly scalable optimization, from lapt
## Installation
You can install Optimas from PyPI (recommended):
```sh
pip install optimas
python3 -m pip install optimas[all]
```
from conda-forge:
```sh
conda install optimas --channel conda-forge
```
or directly from GitHub:
```sh
pip install git+https://github.com/optimas-org/optimas.git
python3 -m pip install "optimas[all] @ git+https://github.com/optimas-org/optimas.git"
```
Make sure `mpi4py` is available in your environment before installing optimas. Fore more details, check out the full [installation guide](https://optimas.readthedocs.io/en/latest/user_guide/installation_local.html). We have also prepared dedicated installation instructions for some HPC systems such as
[JUWELS (JSC)](https://optimas.readthedocs.io/en/latest/user_guide/installation_juwels.html),
Expand Down

0 comments on commit df1aadb

Please sign in to comment.