Skip to content

Commit

Permalink
Merge pull request brucefan1983#711 from brucefan1983/doc
Browse files Browse the repository at this point in the history
fix stress convention
  • Loading branch information
brucefan1983 authored Aug 21, 2024
2 parents e804543 + 7b59090 commit ffc9242
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/nep/input_files/train_test_xyz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Essentially any keyword is allowed, but we only read the following ones:
* :attr:`energy=energy_value` such as :attr:`energy=-123.4` is mandatory and gives the target energy of the structure, which is :math:`-123.4` eV in this example.
* :attr:`virial="vxx vxy vxz vyx vyy vyz vzx vzy vzz"` is optional and gives the :math:`3\times3` virial tensor of the structure in eV.
Positive and negative values represent compressed and stretched states, respectively.
* :attr:`stress="sxx sxy sxz syx syy syz szx szy szz"` is optional and gives the :math:`3\times3` stress tensor of the structure in eV/Å:math:`^3`.
Positive and negative values represent compressed and stretched states, respectively.
* :attr:`stress="sxx sxy sxz syx syy syz szx szy szz"` is optional and gives the :math:`3\times3` stress tensor of the structure in eV/Å\ :math:`^3`.
Positive and negative values represent stretched and compressed states, respectively.
If both :attr:`virial` and :attr:`stress` are present the former is used.
* :attr:`weight=relative_weight` is optional and gives the relative weight for the current structure in the total loss function.
* :attr:`properties=property_name:data_type:number_of_columns` is mandatory but only read the following items:
Expand Down

0 comments on commit ffc9242

Please sign in to comment.