Update README.md
#1
by
Ramlaoui
- opened
README.md
CHANGED
@@ -250,3 +250,121 @@ configs:
|
|
250 |
- split: train
|
251 |
path: non_compatible/train-*
|
252 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
250 |
- split: train
|
251 |
path: non_compatible/train-*
|
252 |
---
|
253 |
+
|
254 |
+
## Dataset Description
|
255 |
+
|
256 |
+
- **Homepage:** https://www.lematerial.org/
|
257 |
+
- **Repository:** https://github.com/lematerial/lematerial
|
258 |
+
- **Point of Contact:** [email protected]
|
259 |
+
|
260 |
+
|
261 |
+
**Motivation**: check out the blog post [https://huggingface.co/blog/lematerial](https://huggingface.co/blog/lematerial) to hear more about the motivation behind the creation of our datasets.
|
262 |
+
|
263 |
+
## Download and use within Python
|
264 |
+
```python
|
265 |
+
from datasets import load_dataset
|
266 |
+
|
267 |
+
dataset = load_dataset('LeMaterial/LeMat-Traj', 'compatible_pbe')
|
268 |
+
```
|
269 |
+
|
270 |
+
## Data fields
|
271 |
+
|
272 |
+
| **Feature name** | **Data type** | **Description** | **[Optimade](https://www.optimade.org/optimade) required field** |
|
273 |
+
| --- | --- | --- | --- |
|
274 |
+
| **elements** | Sequence[String] | A list of elements in the structure. For example a structure with composition Li2O7 will have `[”Li”,”O”]` in its elements. Notes: Currently not necessarily sorted but future iteration will be sorted by alphabetic order. | ✅ |
|
275 |
+
| **nsites** | Integer | The total number of sites in the structure. For example a structure with an un-reduced composition of Li4O2 will have a total of `6` sites. | ✅ |
|
276 |
+
| **chemical_formula_anonymous** | String | Anonymous formula for a chemical structure, sorted by largest contributing species, and reduced by greatest common divisor. For example a structure with a O2Li4 un-reduced composition will have a anonymous formula of `A2B`. “1”’s at the end of an element composition are dropped (ie not A2B1) | ✅ |
|
277 |
+
| **chemical_formula_reduced** | String | Reduced by the greatest common divisor chemical composition. For example a structure with a un-reduced composition of O2Li4 will have a reduced composition of `Li2O`. Elements with a reduced composition of 1 have the “1” dropped. Elements are sorted by alphabetic ordering. Notes: Not using the same method of Pymatgen’s composition reduction method which takes into account certain elements existing in diatomic states. | ✅ |
|
278 |
+
| **chemical_formula_descriptive** | String | A more descriptive chemical formula for the structure, for example a fictive structure of a 6-fold hydrated Na ion might have a descriptive chemical formula of Na(H2O)6, or a Titanium chloride organic dimer might have a descriptive formula of [(C5H5)2TiCl]2. Note: this field is absolutely not standardized across the database. Where possible if available we scrapped as is from the respective databases. Where not possible this may be the same as the chemical formula reduced. | ✅ Note: not standardized in naming approach. |
|
279 |
+
| **nelements** | Integer | Total number of different elements in a structure. For example Li4O2 has only `2` separate elements. | ✅ |
|
280 |
+
| **dimension_types** | Sequence[Integer], shape = 3x1 | Periodic boundary conditions for a given structure. Because all of our materials are bulk materials for this database it is `[1, 1, 1]`, meaning it is periodic in x, y, and z dimensions. | ✅ |
|
281 |
+
| **nperiodic_dimensions** | Integer | The number of repeating periodic boundary conditions, because all our structures in this database are bulk structures, they are repeating in x, y, and z dimensions and thus they have `3` periodic dimensions. | ✅ |
|
282 |
+
| **lattice_vectors** | Sequence[Sequence[Floats]], shape = 3x3 | The matrix of the structures. For example a cubic system with a lattice a=4.5 will have a `[[4.5,0,0],[0,4.5,0],[0,0,4.5]]` lattice vector entry. | ✅ |
|
283 |
+
| **immutable_id** | String | The material ID associated with the structure from the respective database. Note: OQMD IDs are simply integers, thus we converted them to be “oqmd-YYY” | ✅ |
|
284 |
+
| **cartesian_site_positions** | Sequence[Sequence[Floats]], shape = Nx3 | In cartesian units (not fractional units) the coordinates of the species. These match the ordering of all site based properties such as `species_at_sites`, `magneitc_moments` and `forces`. For example a material with a single element placed at a fractional coordinate of [0.5, 0.5, 0.5] with a cubic lattice with a=2, will have a cartesian_site_positions of `[1, 1, 1]`. | ✅ |
|
285 |
+
| **species** | JSON | An [Optimade](https://www.optimade.org/optimade) field that includes information about the species themselves, such as their mass, their name, their labels, etc. Note: we have not currently filled out the mass portion of the species. Additionally, none of our inputted structures should be solid solution thus the on-site concentration for all our species should be [1]. This is an Optimade field. | ✅ |
|
286 |
+
| **species_at_sites** | Sequence[String] | An array of the chemical elements belonging to each site, for example a structure with an un-reduced composition of Li2O2 may have an entry of `[”Li”, “Li”, “O”, “O”]` for this field, where each species should match the other site based properties such as `cartesian_site_positions`. | ✅ |
|
287 |
+
| **last_modified** | Date/time | The date that the entry was last modified from the respective database it was pulled from. Note: we could not find this information in OQMD so we used the date of the latest database release as the input for this field. | ✅ |
|
288 |
+
| **elements_ratios** | Dictionary | The fractional composition for a given structure in dictionary format. For example a structure with an unreduced composition of Li2O4 would have an entry of `{’Li’:0.3333, ‘O’:0.6667}` | ✅ |
|
289 |
+
| **stress_tensor** | Sequence[Sequence[Float]], shape = 3x3 | The full 3x3 vector for stress tensor in units of kB. Note: for OQMD stress tensor were given in Voigt notation, and were converted to the full tensor. | |
|
290 |
+
| **energy** | Float | The uncorrected energy from VASP in eV. | |
|
291 |
+
| **magnetic_moments** | Sequence[Floats] | The magnetic moment per site given in µB. | |
|
292 |
+
| **forces** | Sequence[Sequence[Floats]], shape = 3xN | The force per site, in the proper order of the sites based on other site specific fields for each site in the x, y and z directions, given in eV/A. | |
|
293 |
+
| **functional** | String, either ‘pbe’, ‘pbesol’ or ‘scan’ | What functional was used to calculate the data point in the row. | |
|
294 |
+
| **cross_compatibility** | Boolean | Whether or not this data can be mixed with other rows from a DFT calculation parameter perspective. More information on our approach below. | |
|
295 |
+
| **relaxation_step** | Integer | The current step along the trajectory. For double relaxation calculations for example, where the previous calculation took 3 total steps, the first image of the next relaxation should be relaxation_step=3. | |
|
296 |
+
| **relaxation_number** | Integer | The step along the trajectory for example for Alexandria with triple relaxations, this might be relaxation_step=0, 1 or 2. | |
|
297 |
+
|
298 |
+
## Available subsets
|
299 |
+
|
300 |
+
To better support the diverse communities that may utilize this dataset, we are providing the following subsets of our database:
|
301 |
+
|
302 |
+
- **Compatible, PBE (default)**: This subset includes rows filtered to ensure cross-compatibility from a DFT perspective. For details on the filtering methodology, see the section below. Only PBE records are included. We designate this as the default subset to prevent accidental training of models on non-compatible data.
|
303 |
+
- **All**: This includes all records formatted as described above. **Disclaimer**: Researchers must carefully evaluate the suitability of individual rows for their specific applications.
|
304 |
+
|
305 |
+
|
306 |
+
| **Database** | **Number of materials** | **Number of structures*** |
|
307 |
+
| --- | --- | --- |
|
308 |
+
| Materials Project | 178,627 | 3,019,141 |
|
309 |
+
| Alexandria | 3,281,593 | 108,432,649 |
|
310 |
+
|
311 |
+
|
312 |
+
## Method for compatibility compliance
|
313 |
+
|
314 |
+
To ensure compatibility of rows from a DFT perspective, we implemented the following compatibility scheme:
|
315 |
+
|
316 |
+
- **Pseudopotentials**: Calculations were verified to use consistent pseudopotentials. Notably, most pseudopotentials were aligned between MP and Alexandria, except for vanadium (where Alexandria used V_sv and MP used V_pv) and cesium (where Alexandria used a later version of the generic pseudopotential). For OQMD, this resulted in incompatibilities across records involving the following elements: `Ca, Ti, V, Cr, Mn, Ru, Rh, Ce, Eu, Yb`. We note that at the time of this release Materials Project deprecated all Yb containing materials due to the use of a pseudopotential that led to different than expected results. Thus no Yb containing materials from MP are in our database.
|
317 |
+
- **Hubbard U Parameters**: To ensure uniformity in Hubbard U parameters, we excluded records containing oxygen (O) and any of the following elements: `V, Cr, Mn, Fe, Ni, Cu, Th, U, Np, Pu, Mo, W`. Similarly, records containing fluorine (F) and any of the following elements: Co, Cr, Fe, Mn, Mo, Ni, V, W were also excluded. This exclusion applied specifically to OQMD, which used different Hubbard U parameters compared to MP and Alexandria. However, records from OQMD containing `O` and `Co` were retained, as their Hubbard U parameter differed by only 0.02 eV.
|
318 |
+
- **Spin Polarization**: OQMD only considered spin-polarized calculations for structures with d or f electrons. While non-spin-polarized calculations are not inherently incompatible (as they represent higher-energy magnetic phases compared to the ground state), we decided to exclude non-spin-polarized calculations for this release. This led to the removal of structures containing only the following elements: `H, Li, Be, Na, Mg, K, Ca, Rb, Sr, Cs, Ba, Fr, Ra, B, C, N, O, F, Ne, He, Al, Si, P, S, Cl, Ar, Ga, Ge, As, Se, Br, Kr, In, Sn, Sb, Te, I, Xe, Tl, Pb, Bi, Po, At, Rn` from OQMD.
|
319 |
+
- **Convergence Criteria**: OQMD typically used a larger plane-wave cutoff but a less dense k-point grid. Despite these differences, we did not exclude records based on these parameters, assuming that OQMD, Alexandria, and MP operated within acceptable convergence zones for energy calculations. A similar approach was applied to other VASP parameters, though we welcome feedback on this assumption.
|
320 |
+
- **Convergence**: Across all databases, we identified numerous records with potentially non-convergent calculations or high-energy configurations, often evidenced by significant atomistic forces. We chose not to exclude these records, as users can filter them easily using the “forces” tag if needed.
|
321 |
+
|
322 |
+
The “all” split does not contain any filtering based on this approach, so all records can be downloaded.
|
323 |
+
|
324 |
+
|
325 |
+
## Stay tuned for future updates
|
326 |
+
In the longer run we plan to release additional datasets including surface, adsorbates, and molecules.
|
327 |
+
|
328 |
+
And more! Stay tuned.
|
329 |
+
|
330 |
+
## **Support**
|
331 |
+
|
332 |
+
If you run into any issues regarding feel free to post your questions or comments on any of the following platforms:
|
333 |
+
|
334 |
+
- [**HF Discussions**](https://huggingface.co/datasets/LeMaterial/LeMat-Bulk/discussions)
|
335 |
+
- [**Github Issues**](https://github.com/LeMaterial/lematerial/issues)
|
336 |
+
- [**Slack**](https://lematerial.slack.com)
|
337 |
+
|
338 |
+
|
339 |
+
## Citation Information
|
340 |
+
|
341 |
+
We are currently in the process of creating a pre-print to describe our methods for compatibility. For now however the following can be cited:
|
342 |
+
|
343 |
+
```
|
344 |
+
@misc {lematerial_2025_traj,
|
345 |
+
author = { {Martin Siron}, {Inel Djafar}, {Ali Ramlaoui}, {Lucile Ritchie}, {Etienne Du-Fayet}, {Amandine Rossello}, {Leandro von Werra}, {Thomas Wolf}, {Alexandre Duval} },
|
346 |
+
title = { LeMat-Traj Dataset },
|
347 |
+
year = 2024,
|
348 |
+
url = { https://huggingface.co/datasets/LeMaterial/LeMat-Traj },
|
349 |
+
doi = { },
|
350 |
+
publisher = { Hugging Face }
|
351 |
+
}
|
352 |
+
```
|
353 |
+
|
354 |
+
[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) (license used for Materials Project, Alexandria, OQMD) requires proper acknowledgement.
|
355 |
+
|
356 |
+
Thus, if you use materials data which include (”mp-”) in the immutable_id, please cite the [Materials Project](https://pubs.aip.org/aip/apm/article/1/1/011002/119685/Commentary-The-Materials-Project-A-materials).
|
357 |
+
|
358 |
+
If you use materials data which include (”agm-”) in the immutable_id, please cite [Alexandria, PBE](https://www.science.org/doi/10.1126/sciadv.abi7948) or [Alexandria PBESol, SCAN](https://www.nature.com/articles/s41597-022-01177-w).
|
359 |
+
|
360 |
+
If you use materials data which include (”oqmd-”) in the immutable_id, please cite [OQMD](https://link.springer.com/article/10.1007/s11837-013-0755-4).
|
361 |
+
|
362 |
+
If you make use of Optimade in your research, please cite [Optimade](https://doi.org/10.1038/s41597-021-00974-z)
|
363 |
+
|
364 |
+
Finally, if you make use of the Phase Diagram for visualization purposes, or the crystal viewer in the Materials Explorer, please acknowledge [Crystal Toolkit](https://github.com/materialsproject/crystaltoolkit).
|
365 |
+
|
366 |
+
## License
|
367 |
+
|
368 |
+
This database is licensed by [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).
|
369 |
+
|
370 |
+
Disclaimer: it is made up of Alexandria, Materials Project and OQMD materials, which are all licensed by [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).
|