Skip to content

Commit

Permalink
Add note to documentation for usage of CrystalNN (#3764)
Browse files Browse the repository at this point in the history
* Add note to documentation

* Update pymatgen/analysis/local_env.py

Signed-off-by: J. George <JaGeo@users.noreply.github.com>

* Update pymatgen/analysis/local_env.py

Signed-off-by: J. George <JaGeo@users.noreply.github.com>

* Update pymatgen/analysis/local_env.py

Signed-off-by: J. George <JaGeo@users.noreply.github.com>

---------

Signed-off-by: J. George <JaGeo@users.noreply.github.com>
  • Loading branch information
JaGeo authored Apr 18, 2024
1 parent 7f96ef2 commit 9b7fbcb
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions pymatgen/analysis/local_env.py
Original file line number Diff line number Diff line change
Expand Up @@ -3794,6 +3794,10 @@ class CrystalNN(NearNeighbors):
algorithm can also modify probability using smooth distance cutoffs as well as Pauling
electronegativity differences. The output can either be the most probable coordination
environment or a weighted list of coordination environments.
Please note that the default weights have been benchmarked for inorganic crystal structures.
For MOFs or molecular crystals, weights and cutoffs likely will need to be adapted.
A starting point could be:
CrystalNN(x_diff_weight = 1.5, search_cutoff = 4.5)
"""

NNData = namedtuple("NNData", ["all_nninfo", "cn_weights", "cn_nninfo"])
Expand Down

0 comments on commit 9b7fbcb

Please sign in to comment.