Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Rastislav Turanyi committed Nov 4, 2024
1 parent 94239d5 commit 8efa0c4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/source/user_guide/command_line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ Calculate phonons with a 2x2x2 supercell, after geometry optimization (using the

.. code-block:: bash
janus phonons --struct tests/data/NaCl.cif --supercell 2 2 2 --minimize --arch mace_mp --model-path small
janus phonons --struct tests/data/NaCl.cif --supercell "2 2 2" --minimize --arch mace_mp --model-path small
This will save the Phonopy parameters, including displacements and force constants, to ``NaCl-phonopy.yml`` and ``NaCl-force_constants.hdf5``,
Expand All @@ -324,7 +324,7 @@ Additionally, the ``--bands`` option can be added to calculate the band structur

.. code-block:: bash
janus phonons --struct tests/data/NaCl.cif --supercell 2 2 2 --minimize --arch mace_mp --model-path small --bands
janus phonons --struct tests/data/NaCl.cif --supercell "2 2 2" --minimize --arch mace_mp --model-path small --bands
If you need eigenvectors and group velocities written, add the ``--write-full`` option. This will generate a much larger file, but can be used to visualise phonon modes.
Expand All @@ -333,7 +333,7 @@ Further calculations, including thermal properties, DOS, and PDOS, can also be c

.. code-block:: bash
janus phonons --struct tests/data/NaCl.cif --supercell 2 3 4 --dos --pdos --thermal --temp-start 0 --temp-end 300 --temp-step 50
janus phonons --struct tests/data/NaCl.cif --supercell "2 3 4" --dos --pdos --thermal --temp-start 0 --temp-end 300 --temp-step 50
This will create additional output files: ``NaCl-thermal.dat`` for the thermal properties (heat capacity, entropy, and free energy)
Expand Down
6 changes: 2 additions & 4 deletions janus_core/cli/phonons.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,8 @@ def phonons(
supercell = supercell[0]
elif supercell_length not in [3, 9]:
raise ValueError(
"Please pass one, three or nine lattice vectors in the form '1', '1 2 3' "
"or '1 2 3 4 5 6 7 8 9'. In the latter case first three values are the "
"first row of the supercell matrix, the second three are the second row, "
"etc."
"Please pass lattice vectors as space-separated integers in quotes. "
"For example, '1 2 3'."
)

calcs = []
Expand Down

0 comments on commit 8efa0c4

Please sign in to comment.