Skip to content

Commit 67efb7f

Browse files
Minor docs cleanup (#1047)
* cleanup docs on vasp / openmm * typo * change install command to pypi since OpenMM makers released in v0.0.16 https://github.com/materialsproject/atomate2/releases/tag/v0.0.16 --------- Co-authored-by: Janosh Riebesell <[email protected]>
1 parent 7761de4 commit 67efb7f

File tree

3 files changed

+29
-34
lines changed

3 files changed

+29
-34
lines changed

docs/user/codes/openmm.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,17 @@
66
>>> conda activate atomate2
77

88
# installing atomate2
9-
>>> pip install git+https://github.com/orionarcher/atomate2
10-
11-
# installing classical_md dependencies
12-
>>> conda install -c conda-forge --file .github/classical_md_requirements.txt
9+
>>> pip install "atomate2[openmm]"
1310
```
1411

1512
Alternatively, if you anticipate regularly updating
16-
atomate2 from source (which at this point, you should),
17-
you can clone the repository and install from source.
13+
atomate2 from source, you can clone the repository and install from source.
1814

1915
``` bash
2016
# installing atomate2
21-
>>> git clone https://github.com/orionarcher/atomate2
17+
>>> git clone https://github.com/materialsproject/atomate2
2218
>>> cd atomate2
23-
>>> git branch openff
24-
>>> git checkout openff
25-
>>> git pull origin openff
26-
>>> pip install -e .
19+
>>> pip install -e '.[openmm]'
2720
```
2821

2922
To test the openmm installation, you can run the following command. If
@@ -458,6 +451,7 @@ run_locally(flows[rank], ensure_success=True)
458451
For now, you'll need to make sure you have a particular emmet branch installed.
459452
Later the builders will be integrated into `main`.
460453

454+
<!-- TODO get emmet@md_builders merged -->
461455
```bash
462456
pip install git+https://github.com/orionarcher/emmet@md_builders
463457
```

docs/user/codes/vasp-workflows.csv

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
Name,Type,Maker
2-
`Static`_,job,:obj:`.StaticMaker`
3-
`Relax`_,job,:obj:`.RelaxMaker`
4-
`Tight Relax`_,job,:obj:`.TightRelaxMaker`
5-
`Dielectric`_,job,:obj:`.DielectricMaker`
6-
`Transmuter`_,job,:obj:`.TransmuterMaker`
7-
`HSE06 Static`_,job,:obj:`.HSEStaticMaker`
8-
`HSE06 Relax`_,job,:obj:`.HSERelaxMaker`
9-
`HSE06 Tight Relax`_,job,:obj:`.HSETightRelaxMaker`
10-
`Double Relax`_,flow,:obj:`.DoubleRelaxMaker`
11-
`Band Structure`_,flow,:obj:`.BandStructureMaker`
12-
`Uniform Band Structure`_,flow,:obj:`.UniformBandStructureMaker`
13-
`Line-Mode Band Structure`_,flow,:obj:`.LineModeBandStructureMaker`
14-
`HSE06 Band Structure`_,flow,:obj:`.HSEBandStructureMaker`
15-
`HSE06 Uniform Band Structure`_,flow,:obj:`.HSEUniformBandStructureMaker`
16-
`HSE06 Line-Mode Band Structure`_,flow,:obj:`.HSELineModeBandStructureMaker`
17-
`Relax and Band Structure`_,flow,:obj:`.RelaxBandStructureMaker`
18-
`Elastic Constant`_,flow,:obj:`.ElasticMaker`
19-
`Optics`_,flow,:obj:`.OpticsMaker`
20-
`HSE06 Optics`_,flow,:obj:`.HSEOpticsMaker`
21-
`Phonons`_,flow,:obj:`.PhononMaker`
22-
`Lobster`_,flow,:obj:`.VaspLobsterMaker`
2+
`Static`_,job,:obj:`~atomate2.vasp.jobs.core.StaticMaker`
3+
`Relax`_,job,:obj:`~atomate2.vasp.jobs.core.RelaxMaker`
4+
`Tight Relax`_,job,:obj:`~atomate2.vasp.jobs.core.TightRelaxMaker`
5+
`Dielectric`_,job,:obj:`~atomate2.vasp.jobs.core.DielectricMaker`
6+
`Transmuter`_,job,:obj:`~atomate2.vasp.jobs.core.TransmuterMaker`
7+
`HSE06 Static`_,job,:obj:`~atomate2.vasp.jobs.core.HSEStaticMaker`
8+
`HSE06 Relax`_,job,:obj:`~atomate2.vasp.jobs.core.HSERelaxMaker`
9+
`HSE06 Tight Relax`_,job,:obj:`~atomate2.vasp.jobs.core.HSETightRelaxMaker`
10+
`Double Relax`_,flow,:obj:`~atomate2.vasp.flows.core.DoubleRelaxMaker`
11+
`Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.BandStructureMaker`
12+
`Uniform Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.UniformBandStructureMaker`
13+
`Line-Mode Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.LineModeBandStructureMaker`
14+
`HSE06 Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.HSEBandStructureMaker`
15+
`HSE06 Uniform Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.HSEUniformBandStructureMaker`
16+
`HSE06 Line-Mode Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.HSELineModeBandStructureMaker`
17+
`Relax and Band Structure`_,flow,:obj:`~atomate2.vasp.flows.core.RelaxBandStructureMaker`
18+
`Elastic Constant`_,flow,:obj:`~atomate2.vasp.flows.elastic.ElasticMaker`
19+
`Optics`_,flow,:obj:`~atomate2.vasp.flows.core.OpticsMaker`
20+
`HSE06 Optics`_,flow,:obj:`~atomate2.vasp.flows.core.HSEOpticsMaker`
21+
`Phonons`_,flow,:obj:`~atomate2.vasp.flows.phonons.PhononMaker`
22+
`Lobster`_,flow,:obj:`~atomate2.vasp.flows.lobster.VaspLobsterMaker`

docs/user/codes/vasp.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ run_locally(lobster, create_folders=True, store=SETTINGS.JOB_STORE)
324324
```
325325

326326
It is, however, computationally very beneficial to define two different types of job scripts for the VASP and Lobster runs, as VASP and Lobster runs are parallelized differently (MPI vs. OpenMP).
327-
[FireWorks](https://github.com/materialsproject/fireworks) allows to run the VASP and Lobster jobs with different job scripts. Please check out the [jobflow documentation on FireWorks](https://materialsproject.github.io/jobflow/tutorials/8-fireworks.html#setting-the-manager-configs) for more information.
327+
[FireWorks](https://github.com/materialsproject/fireworks) allows one to run the VASP and Lobster jobs with different job scripts. Please check out the [jobflow documentation on FireWorks](https://materialsproject.github.io/jobflow/tutorials/8-fireworks.html#setting-the-manager-configs) for more information.
328328

329329
Specifically, you might want to change the `_fworker` for the LOBSTER runs and define a separate `lobster` worker within FireWorks:
330330

@@ -468,7 +468,8 @@ Finally, sometimes you have a workflow containing many VASP jobs. In this case i
468468
tedious to update the input sets for each job individually. Atomate2 provides helper
469469
functions called "powerups" that can apply settings updates to all VASP jobs in a flow.
470470
These powerups also contain filters for the name of the job and the maker used to
471-
generate them.
471+
generate them. These functions will apply updates *only* to VASP jobs, including those
472+
created dynamically - all other jobs in a flow will not be modified.
472473

473474
```py
474475
from atomate2.vasp.powerups import update_user_incar_settings

0 commit comments

Comments
 (0)