Skip to content

Commit b1c672f

Browse files
committed
add references for ASI
1 parent 458e3b2 commit b1c672f

2 files changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ If you use any of the following Featurizers, also cite the respective papers:
9292
* `FeaturizeCharges`: R. Nelson, C. Ertural, P. C. Müller, R. Dronskowski, in Comprehensive Inorganic Chemistry III, *Elsevier*, **2023**, pp. 141–201. [https://doi.org/10.1016/B978-0-12-823144-9.00120-5](https://doi.org/10.1016/B978-0-12-823144-9.00120-5)
9393
* `FeaturizeIcoxxlist`: V. L. Deringer, W. Zhang, M. Lumeij, S. Maintz, M. Wuttig, R. Mazzarello, R. Dronskowski, *Angewandte Chemie International Edition 2014*, *53*, 10817–10820. [https://doi.org/10.1002/anie.201404223](https://doi.org/10.1002/anie.201404223)
9494

95+
Cite the following paper as well if using aysmmetry index:
96+
97+
F. Belli, E. Zurek, I. Errea, 2025 [https://arxiv.org/abs/2501.14420](https://arxiv.org/abs/2501.14420).
98+
9599
Please cite [pymatgen](https://github.com/materialsproject/pymatgen), [Lobster](https://schmeling.ac.rwth-aachen.de/cohp/index.php?menuID=1), and [ChemEnv](https://doi.org/10.1107/S2052520620007994) correctly as well.
96100

97101

docs/fundamentals/index.ipynb

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -281,8 +281,9 @@
281281
]
282282
},
283283
{
284-
"metadata": {},
285284
"cell_type": "markdown",
285+
"id": "a2f623edafa5efc9",
286+
"metadata": {},
286287
"source": [
287288
"### ICOXX based features (ICOXX: ICOHP / ICOBI / ICOOP)\n",
288289
"\n",
@@ -292,9 +293,18 @@
292293
"\n",
293294
"In the formula above, $\\delta$ is the Dirac delta function, $r$ is the distance between atoms A and B, and $B_{\\mathrm{AB}}$ is the bond strength between atoms A and B. The bond strength can be ICOHPs, ICOBIs, or ICOOPs. The BWDF is thus a histogram of bond strengths as a function of bond length. One can compute this for entire structure, for each unique atom pair in the structure, per site or per bond label.\n",
294295
"\n",
295-
"Here, from the BWDF mainly statistical features like mean, standard deviation, skewness, kurtosis, weighted mean, and weighted standard deviation are computed.\n"
296-
],
297-
"id": "a2f623edafa5efc9"
296+
"Here, from the BWDF mainly statistical features like mean, standard deviation, skewness, kurtosis, weighted mean, and weighted standard deviation are computed.\n",
297+
"\n",
298+
"As proposed by [F. Belli, E. Zurek, I. Errea, 2025](https://arxiv.org/abs/2501.14420), one can also generate the asymmetry index (ASI) of the local bonding environment using ICOBI / ICOHP / ICOOP for a site using following formulation\n",
299+
"\n",
300+
"$$\n",
301+
"\\boldsymbol{V}_{x} = \\frac{1}{B_{x}} \\sum_{\\alpha=1}^{B_{x}} \\mathrm{iCOXX}(x, \\alpha) \\, \\boldsymbol{i}_{x \\alpha}\n",
302+
"$$\n",
303+
"\n",
304+
"$V_x$, is computed for each atom $x$ in the structure. The vector is the sum of the iCOXX values for all of the interactions between an atom and its neighboring atoms $\\alpha$ (iCOXX(x, $\\alpha$)) weighted by a unit vector, $i_{xα}$, which denotes the direction of each interaction. This summation is performed over all neighbors for which the iCOXX values fall above a user-defined threshold, and divided by the number of interactions considered, $B_x$.\n",
305+
"\n",
306+
"One can then get statistics of ASI from all sites in the structure."
307+
]
298308
}
299309
],
300310
"metadata": {

0 commit comments

Comments
 (0)