Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more details to the installation guide #810

Merged
merged 3 commits into from
Apr 26, 2024
Merged

Add more details to the installation guide #810

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e801681
Update install.md
JaGeo Apr 17, 2024
ac0a0b2
Update docs/user/install.md
JaGeo Apr 17, 2024
c8df986
link to pyproject and document 2 more options
janosh Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/user/install.md
View file
Open in desktop
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
Loading