add the convex hull of LeMat-Bulk PBE (hull.hdf5)
Browse files- .gitattributes +1 -0
- README.md +56 -0
- hull.hdf5 +3 -0
- hull_index.parquet +3 -0
.gitattributes
CHANGED
|
@@ -69,3 +69,4 @@ lematerial_metastables.cif filter=lfs diff=lfs merge=lfs -text
|
|
| 69 |
lematerial_metastables_w_energies.cif filter=lfs diff=lfs merge=lfs -text
|
| 70 |
all.hdf5 filter=lfs diff=lfs merge=lfs -text
|
| 71 |
unique.hdf5 filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
| 69 |
lematerial_metastables_w_energies.cif filter=lfs diff=lfs merge=lfs -text
|
| 70 |
all.hdf5 filter=lfs diff=lfs merge=lfs -text
|
| 71 |
unique.hdf5 filter=lfs diff=lfs merge=lfs -text
|
| 72 |
+
hull.hdf5 filter=lfs diff=lfs merge=lfs -text
|
README.md
CHANGED
|
@@ -19,6 +19,7 @@ forms:
|
|
| 19 |
|---|---|---|---|---|
|
| 20 |
| `all.hdf5` | 5,335,299 | complete LeMat-Bulk `compatible_pbe`, unfiltered | total energy, energy above hull | [Complete LeMat-Bulk PBE in HDF5](#complete-lemat-bulk-pbe-in-hdf5-allhdf5-uniquehdf5) |
|
| 21 |
| `unique.hdf5` | 4,927,038 | same, one structure per fingerprint | total energy, energy above hull | same |
|
|
|
|
| 22 |
| `lematerial.cif` and its subsets | 2,838,953 | curated from LeMat-BulkUnique `unique_pbe` (no rare gas, no f-block element, no close atoms, StructureMatcher duplicates removed) | energies only in `lematerial_metastables_w_energies.cif` | [Datasets curated from LeMat-BulkUnique](#datasets-curated-from-lematerial-lematbulkunique---unique_pbe-version-11) |
|
| 23 |
|
| 24 |
The HDF5 files and the CIF files come from different releases and selections of LeMaterial: one
|
|
@@ -154,3 +155,58 @@ hull.
|
|
| 154 |
|
| 155 |
LeMat-Bulk is distributed under CC-BY-4.0; refer to it for the terms of use and the references
|
| 156 |
of its sources.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|---|---|---|---|---|
|
| 20 |
| `all.hdf5` | 5,335,299 | complete LeMat-Bulk `compatible_pbe`, unfiltered | total energy, energy above hull | [Complete LeMat-Bulk PBE in HDF5](#complete-lemat-bulk-pbe-in-hdf5-allhdf5-uniquehdf5) |
|
| 21 |
| `unique.hdf5` | 4,927,038 | same, one structure per fingerprint | total energy, energy above hull | same |
|
| 22 |
+
| `hull.hdf5` | 109,112 | structures of `all.hdf5` on the convex hull, composition and energy only | energy per atom | [Convex hull of LeMat-Bulk PBE](#convex-hull-of-lemat-bulk-pbe-hullhdf5) |
|
| 23 |
| `lematerial.cif` and its subsets | 2,838,953 | curated from LeMat-BulkUnique `unique_pbe` (no rare gas, no f-block element, no close atoms, StructureMatcher duplicates removed) | energies only in `lematerial_metastables_w_energies.cif` | [Datasets curated from LeMat-BulkUnique](#datasets-curated-from-lematerial-lematbulkunique---unique_pbe-version-11) |
|
| 24 |
|
| 25 |
The HDF5 files and the CIF files come from different releases and selections of LeMaterial: one
|
|
|
|
| 155 |
|
| 156 |
LeMat-Bulk is distributed under CC-BY-4.0; refer to it for the terms of use and the references
|
| 157 |
of its sources.
|
| 158 |
+
|
| 159 |
+
# Convex hull of LeMat-Bulk PBE (`hull.hdf5`)
|
| 160 |
+
|
| 161 |
+
`hull.hdf5` holds the composition and the energy of the 109,112 structures of LeMat-Bulk
|
| 162 |
+
`compatible_pbe` that are on the convex hull, computed from the total energies of the 5,335,299
|
| 163 |
+
structures of the dataset. It is enough to compute the energy above the hull of any other
|
| 164 |
+
structure: the hull of a chemical system only depends on its stable structures and the ones of
|
| 165 |
+
its sub-systems.
|
| 166 |
+
|
| 167 |
+
| Dataset | Shape | Type | Content |
|
| 168 |
+
|---|---|---|---|
|
| 169 |
+
| `elements` | (357,069,) | int64 | atomic number of the elements of each structure, sorted within a structure |
|
| 170 |
+
| `counts` | (357,069,) | int64 | number of atoms of this element in the cell |
|
| 171 |
+
| `ptr` | (109,113,) | int64 | index of the first element of each structure: structure *i* owns `elements[ptr[i]:ptr[i+1]]` |
|
| 172 |
+
| `energy_per_atom` | (109,112,) | float64 | total energy divided by the number of atoms, in eV |
|
| 173 |
+
|
| 174 |
+
Unlike `all.hdf5`, `ptr` has one more entry than the number of structures, and the energy is
|
| 175 |
+
per atom, in 64 bits, from the energies of LeMat-Bulk. There is no lattice and no atomic
|
| 176 |
+
position: `hull_index.parquet` gives the `immutable_id` of each row, to find the structure in
|
| 177 |
+
`all.hdf5` or in LeMat-Bulk.
|
| 178 |
+
|
| 179 |
+
The hull covers 89 elements and has stable compounds in 61,127 chemical systems: 90 structures
|
| 180 |
+
of one element (two structures of the same element have exactly the same energy), 6,954 binary,
|
| 181 |
+
67,231 ternary, 32,923 quaternary and 1,914 with five to seven elements. 81,031 come from
|
| 182 |
+
Alexandria, 14,396 from the Materials Project and 13,685 from OQMD.
|
| 183 |
+
|
| 184 |
+
## Usage
|
| 185 |
+
|
| 186 |
+
```python
|
| 187 |
+
from huggingface_hub import hf_hub_download
|
| 188 |
+
from pycrystalgen.data.hull import energy_above_reference, load_hull
|
| 189 |
+
|
| 190 |
+
hull = load_hull(hf_hub_download("materials-toolkits/lematerial", "hull.hdf5", repo_type="dataset"))
|
| 191 |
+
|
| 192 |
+
# z: atomic numbers of all atoms, num_atoms and total_energy (eV): one value per structure
|
| 193 |
+
above = energy_above_reference(hull, z, num_atoms, total_energy)
|
| 194 |
+
```
|
| 195 |
+
|
| 196 |
+
The result is in eV/atom: 0 on the hull, positive above, **negative for a structure more stable
|
| 197 |
+
than the hull**, NaN for a structure with an element absent from the hull.
|
| 198 |
+
|
| 199 |
+
**Energies must be comparable with the ones of LeMat-Bulk `compatible_pbe`** (PBE, same
|
| 200 |
+
calculation settings). The energy of a structure relaxed with another functional or with a
|
| 201 |
+
machine learning potential gives a number that is not an energy above this hull.
|
| 202 |
+
|
| 203 |
+
## Checks
|
| 204 |
+
|
| 205 |
+
- Comparing the 5,335,299 structures of the dataset to the saved hull gives back the energy
|
| 206 |
+
above the hull computed on the whole dataset within 1e-14 eV/atom, with the same 109,112
|
| 207 |
+
structures at zero.
|
| 208 |
+
- It matches the `energy_above_hull` stored in `all.hdf5` (values of LeMat-Bulk-DFT-Hull-All)
|
| 209 |
+
within 0.0003 eV/atom, and within 1e-4 except for two structures of the As-H-Hg-O-Zn system
|
| 210 |
+
(see above: `mp-24216` is on this hull but has no published value). `all.hdf5` keeps the
|
| 211 |
+
published values, so one structure on this hull (`mp-24216`) and one structure off it
|
| 212 |
+
(`agm003244657`, 0.0003 eV/atom above) are marked differently in the two files.
|
hull.hdf5
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:6e3e41dffe7873b1293d3734edd8e3c99c3b1a0ec5fe79df3f9a59eaaf8859c5
|
| 3 |
+
size 7463000
|
hull_index.parquet
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:af81f8d585a1996b106ff5f1ece356be7bddcd811b9051dfc4ede7c84edc7cc0
|
| 3 |
+
size 584173
|