Skip to content

Commit e7152fb

Browse files
committed
Added a docstring describing the atomType naming convention
1 parent 80e613a commit e7152fb

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

rmgpy/molecule/atomtype.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,15 @@ def getFeatures(self):
223223
224224
For making sample atoms, we use the first atomtype under specific,
225225
therefore the first one in the list should always be an element.
226+
227+
The atomTypes naming convention is:
228+
<element> <valence> <characteristic bonds> <charge(optional)>
229+
For example:
230+
- N3d is nitrogen with valence=3 (i.e., 3 electronce are able to form bonds or remain as radicals) with one double bond
231+
- S4tc is sulfur with valence=4 with one triple bond and charged
232+
- S2sp is sulfur with valence=2 with only single bonds and charged positively
233+
- S2sn is similar to S2sp, only charged negatively
234+
- Oa is atomic oxygen, i.e., a closed shell atom
226235
"""
227236

228237
atomTypes = {}

0 commit comments

Comments
 (0)