Skip to content

Commit 4a70d97

Browse files
authored
Update DOCUMENTATION.md
Improve by giving step numbers
1 parent 4ac6680 commit 4a70d97

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

DOCUMENTATION.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Long story short, in order to get a spectra, one needs to:
2121

2222
## Usage
2323

24-
### Frequencies and normal modes
24+
### 1. Frequencies and normal modes
2525

2626
To get the force constant, you need to use [`Phonopy`](https://phonopy.github.io/phonopy/index.html) (which is installed since it is a dependency of this package) as usual.
2727

@@ -84,7 +84,7 @@ EDIFF = 1.0e-08 ! stricter criterion for energy convergence
8484
PREC = Accurate ! increase precision
8585
```
8686

87-
### Visualisation and interpretation of the normal modes
87+
### 2. Visualisation and interpretation of the normal modes (optional)
8888

8989
If you want, you can then create files to visualize the modes in [VESTA](http://jp-minerals.org/vesta/en/):
9090

@@ -106,9 +106,9 @@ It is also possible to "unwrap" the cell (i.e., move atoms close together), whic
106106

107107
**Note:** negative vibrational contributions are sometimes reported. Keep in mind that this is an estimate.
108108

109-
### Infrared spectrum
109+
### 3. Infrared spectrum
110110

111-
After obtaining the dynamic matrix, the frequencies and corresponding mode, you then need to run another calculation in order to compute the born effective charges and extract them using [a utility](https://phonopy.github.io/phonopy/auxiliary-tools.html#phonopy-vasp-born) provided by Phonopy:
111+
After obtaining the dynamic matrix, the frequencies and corresponding mode (step 1), you then need to run another calculation in order to compute the born effective charges and extract them using [a utility](https://phonopy.github.io/phonopy/auxiliary-tools.html#phonopy-vasp-born) provided by Phonopy:
112112

113113
```bash
114114
# 1. Run a calculation with `LEPSILON = .TRUE.` **on the unit cell**
@@ -154,9 +154,10 @@ phonopy-vs-ir -q="0.5 0 0" spectrum_0.5.csv
154154

155155
Note that Phonopy is generally not able to assign symmetry labels in that case.
156156

157-
## Raman spectrum
157+
### 4. Raman spectrum
158158

159-
The procedure is more complex, since one needs the derivatives of the BORN charge with respect to polarizability (*i.e.*, the polarizability):
159+
The procedure is more complex, since one needs the derivatives of the BORN charge with respect to polarizability (*i.e.*, the polarizability).
160+
Once you have completed step 1, do the following:
160161

161162
```bash
162163
# 1. Get displaced geometries and prepare a `raman.hdf5` file
@@ -181,9 +182,9 @@ The resulting output contains the same sections as with IR (except it gives rama
181182

182183
Contributions, either with [issues](https://github.com/pierre-24/phonopy-vibspec/issues) or [pull requests](https://github.com/pierre-24/phonopy-vibspec/pulls) are welcomed.
183184

184-
### Install
185+
### Install (for dev)
185186

186-
If you want to contribute, this is the usual deal:
187+
Rather than the installation procedure given on top if this document, if you want to contribute, this is the usual deal:
187188
start by [forking](https://guides.github.com/activities/forking/), then clone your fork and use the following install procedures instead.
188189

189190
```bash

0 commit comments

Comments
 (0)