Skip to content

Commit

Permalink
Add more details to the installation guide (#810)
Browse files Browse the repository at this point in the history
* Update install.md

* Update docs/user/install.md

* link to pyproject and document 2 more options

---------

Co-authored-by: Janosh Riebesell <[email protected]>
  • Loading branch information
JaGeo and janosh authored Apr 26, 2024
1 parent 782abc1 commit 974b9cd
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/user/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,16 @@ To install the packages run:
pip install atomate2
```

If you would like to use more specialized capabilities of `atomate2` such as the phonon, Lobster or force field workflows, you would need to run one of

```bash
pip install atomate2[phonons]
pip install atomate2[lobster]
pip install atomate2[forcefields]
```

See [`pyproject.toml`](https://github.com/materialsproject/atomate2/blob/main/pyproject.toml) for all available optional dependency sets. More detailed instructions can be found under [dev installation](../dev/dev_install.md).

## Configure calculation output database

The next step is to configure your MongoDB database that will be used to store
Expand Down

0 comments on commit 974b9cd

Please sign in to comment.