Skip to content

Commit b93de9f

Browse files
authored
Add chemical properties description to csd-1000r dataset documentation (#249)
1 parent cfbf536 commit b93de9f

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

src/skmatter/datasets/descr/csd-1000r.rst

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ The representations were computed with [C1]_ using the hyperparameters:
2525

2626
+---------------------------+------------+
2727
| key | value |
28-
+---------------------------+------------+
28+
+===========================+============+
2929
| interaction_cutoff: | 3.5 |
3030
+---------------------------+------------+
3131
| max_radial: | 6 |
3232
+---------------------------+------------+
3333
| max_angular: | 6 |
3434
+---------------------------+------------+
35-
| gaussian_sigma_constant": | 0.4 |
35+
| gaussian_sigma_constant: | 0.4 |
3636
+---------------------------+------------+
3737
| gaussian_sigma_type: | "Constant"|
3838
+---------------------------+------------+
@@ -43,11 +43,31 @@ The representations were computed with [C1]_ using the hyperparameters:
4343

4444
Of the 2'520 resulting features, 100 were selected via FPS using [C2]_.
4545

46+
Chemical Properties
47+
-------------------
48+
49+
The CSD-1000R dataset consists of 100 atomic environments selected from crystal
50+
structures in the Cambridge Structural Database (CSD) [C3]_. These environments
51+
represent a diverse set of chemical compositions and bonding types, including:
52+
53+
- Metals, metalloids, and non-metals
54+
- Covalent, ionic, and metallic bonding environments
55+
- Various coordination numbers and geometries
56+
57+
The dataset captures local chemical environments relevant for modeling properties
58+
such as nuclear magnetic resonance (NMR) chemical shieldings, aiding in the
59+
understanding of structure-property relationships in materials chemistry.
60+
61+
For more detailed chemical information, users can refer to the original Cambridge
62+
Structural Database [C3]_ or the publication by Ceriotti et al. (2019) [C4]_.
63+
4664
References
4765
----------
4866

4967
.. [C1] https://github.com/lab-cosmo/librascal commit ade202a6
5068
.. [C2] https://github.com/lab-cosmo/scikit-matter commit 4ed1d92
69+
.. [C3] https://www.ccdc.cam.ac.uk/structures/
70+
.. [C4] https://www.nature.com/articles/s41597-019-0224-1
5171
5272
Reference Code
5373
--------------

0 commit comments

Comments
 (0)