Upload README.md with huggingface_hub

README.md

@@ -1,53 +1,97 @@
 ---
-dataset_info:
-  features:
-  - name: material_id
-    dtype: string
-  - name: formula
-    dtype: string
-  - name: nsites
-    dtype: int64
-  - name: space_group
-    dtype: int64
-  - name: volume
-    dtype: float64
-  - name: structure
-    dtype: string
-  - name: cif
-    dtype: string
-  - name: poscar
-    dtype: string
-  - name: elastic_anisotropy
-    dtype: float64
-  - name: G_Reuss
-    dtype: float64
-  - name: G_VRH
-    dtype: float64
-  - name: G_Voigt
-    dtype: float64
-  - name: K_Reuss
-    dtype: float64
-  - name: K_VRH
-    dtype: float64
-  - name: K_Voigt
-    dtype: float64
-  - name: poisson_ratio
-    dtype: float64
-  - name: compliance_tensor
-    dtype: string
-  - name: elastic_tensor
-    dtype: string
-  - name: elastic_tensor_original
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 5741290
-    num_examples: 1181
-  download_size: 1691321
-  dataset_size: 5741290
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+license: cc-by-4.0
+task_categories:
+  - tabular-regression
+  - tabular-classification
+tags:
+  - materials-science
+  - chemistry
+  - foundry-ml
+  - scientific-data
+size_categories:
+  - 1K<n<10K
 ---
+
+# Charting the complete elastic properties of inorganic crystalline compounds
+
+Dataset containing DFT-calculated elastic properties for 1181 materials
+
+## Dataset Information
+
+- **Source**: [Foundry-ML](https://github.com/MLMI2-CSSI/foundry)
+- **DOI**: [10.18126/9fg1-528u](https://doi.org/10.18126/9fg1-528u)
+- **Year**: 2022
+- **Authors**: de Jong, Maarten, Chen, Wei, Angsten, Thomas, Jain, Anubhav, Notestine, Randy, Gamst, Anthong, Sluiter, Marcel, Ande, Chaitanya Krishna, van der Zwaag, Sybrand, Plata, Jose J., Toher, Cormac, Curtarolo, Stefano, Ceder, Gerbrand, Persson, Kristin A., Asta, Mark
+- **Data Type**: tabular
+
+### Fields
+
+| Field | Role | Description | Units |
+|-------|------|-------------|-------|
+| material_id | input | Materials Project ID |  |
+| formula | input | Material composition |  |
+| nsites | input | Number of sites in the unit cell |  |
+| space_group | input | Space group number |  |
+| volume | input | Volume of relaxed structure | Cubic Angstroms |
+| structure | input | Pymatgen structure representation of material |  |
+| elastic_anisotropy | target | Description of elastic anisotropy |  |
+| G_Reuss | target | Shear modulus, lower bound for polycrystal | GPa |
+| G_VRH | target | Average shear modulus | GPa |
+| G_Voigt | target | Shear modulus, upper bound for polycrystal | GPa |
+| K_Reuss | target | Bulk modulus, lower bound for polycrystal | GPa |
+| K_VRH | target | Average bulk modulus | GPa |
+| K_Voigt | target | Bulk modulus, upper bound for polycrystal | GPa |
+| poisson_ratio | target | Describes lateral response to loading |  |
+| compliance_tensor | target | Tensor, describing elastic behavior | GPa |
+| elastic_tensor | target | Tensor, describing elastic behavior in IEEE-format | GPa |
+| elastic_tensor_original | target | Tensor, describing elastic behavior, corresponding | GPa |
+| cif | input | Material structure in CIF format |  |
+| kpoint_density | N/A | K-point density used in DFT calculation |  |
+| poscar | input | Material structure in POSCAR format |  |
+
+
+### Splits
+
+- **train**: train
+
+
+## Usage
+
+### With Foundry-ML (recommended for materials science workflows)
+
+```python
+from foundry import Foundry
+
+f = Foundry()
+dataset = f.get_dataset("10.18126/9fg1-528u")
+X, y = dataset.get_as_dict()['train']
+```
+
+### With HuggingFace Datasets
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("elastic_tensor_v1.1")
+```
+
+## Citation
+
+```bibtex
+@misc{https://doi.org/10.18126/9fg1-528u
+doi = {10.18126/9fg1-528u}
+url = {https://doi.org/10.18126/9fg1-528u}
+author = {de Jong, Maarten and Chen, Wei and Angsten, Thomas and Jain, Anubhav and Notestine, Randy and Gamst, Anthong and Sluiter, Marcel and Ande, Chaitanya Krishna and van der Zwaag, Sybrand and Plata, Jose J. and Toher, Cormac and Curtarolo, Stefano and Ceder, Gerbrand and Persson, Kristin A. and Asta, Mark}
+title = {Charting the complete elastic properties of inorganic crystalline compounds}
+keywords = {machine learning, foundry}
+publisher = {Materials Data Facility}
+year = {root=2022}}
+```
+
+## License
+
+CC-BY 4.0
+
+---
+
+*This dataset was exported from [Foundry-ML](https://github.com/MLMI2-CSSI/foundry), a platform for materials science datasets.*