Skip to content

Commit

Permalink
Update docstrings for lammps fireworks
Browse files Browse the repository at this point in the history
  • Loading branch information
rashatwi committed Apr 18, 2024
1 parent 8fa2d23 commit 681d47f
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions mispr/lammps/fireworks/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,21 +142,23 @@ def __init__(
.. code-block:: python
{"Molecule": pymatgen_molecule,
"Labels": atom_labels,
"Masses": atomtype_masses,
"Nonbond": nonbond_params,
"Bonds": bond_params,
"Angles": angle_params,
"Dihedrals": dihedral_params,
"Impropers": improper_params,
"Improper Topologies": improper_topologies,
"Charges": charges}
{
"Molecule": pymatgen_molecule,
"Labels": atom_labels,
"Masses": atomtype_masses,
"Nonbond": nonbond_params,
"Bonds": bond_params,
"Angles": angle_params,
"Dihedrals": dihedral_params,
"Impropers": improper_params,
"Improper Topologies": improper_topologies,
"Charges": charges
}
5. 'get_from_file': If the input is a json file of the force field
parameters.
parameters.
6. 'get_from_db': If the input is a filter for the database to search
for the force field parameters.
for the force field parameters.
label (str, optional): Label for the molecule. This should be unique for
each different molecular species in the system. Defaults to an empty
Expand Down

0 comments on commit 681d47f

Please sign in to comment.