Upload folder using huggingface_hub
Browse files- CITATION.cff +10 -0
- LICENSE +3 -0
- README.md +50 -0
- data/records.jsonl +3 -0
- data/structures/ABO3_0001.xyz +7 -0
- data/structures/ABO3_0002.xyz +7 -0
- data/structures/ABO3_0003.xyz +7 -0
- data/table.csv +4 -0
- metadata/schema.jsonschema +37 -0
CITATION.cff
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
cff-version: 1.2.0
|
| 3 |
+
message: Please cite this dataset as below.
|
| 4 |
+
title: Ai4Materials demo FAIR dataset
|
| 5 |
+
authors:
|
| 6 |
+
- family-names: Parida
|
| 7 |
+
given-names: Chiku
|
| 8 |
+
date-released: 2025-10-01
|
| 9 |
+
version: 0.1.0
|
| 10 |
+
license: MIT
|
LICENSE
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Creative Commons Attribution 4.0 International
|
| 2 |
+
|
| 3 |
+
For full license text, see: https://creativecommons.org/licenses/by/4.0/
|
README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
task_categories:
|
| 3 |
+
- tabular-regression
|
| 4 |
+
language:
|
| 5 |
+
- en
|
| 6 |
+
tags:
|
| 7 |
+
- physics
|
| 8 |
+
- chemistry
|
| 9 |
+
- materials
|
| 10 |
+
- ASE
|
| 11 |
+
- Perovskites
|
| 12 |
+
pretty_name: AI4Materials Demo FAIR Perovskites
|
| 13 |
+
license: mit
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
# AI4Materials Demo FAIR Perovskites
|
| 17 |
+
|
| 18 |
+
This is a **teaching** dataset demonstrating F.A.I.R. hosting on the Hugging Face Hub.
|
| 19 |
+
It contains a small table of oxide perovskites with band gaps and toy EXTXYZ structures.
|
| 20 |
+
|
| 21 |
+
## Contents
|
| 22 |
+
- `data/table.csv` — main tabular data
|
| 23 |
+
- `data/records.jsonl` — line-delimited JSON mirror
|
| 24 |
+
- `data/structures/*.xyz` — example structures (EXTXYZ)
|
| 25 |
+
- `metadata/schema.json` — JSON Schema for validation
|
| 26 |
+
- `CITATION.cff`, `LICENSE` — citation & reuse terms
|
| 27 |
+
|
| 28 |
+
## Provenance
|
| 29 |
+
Synthetic examples generated for classroom demonstration on {datetime.utcnow().date()}.
|
| 30 |
+
|
| 31 |
+
## How to load
|
| 32 |
+
```python
|
| 33 |
+
from datasets import load_dataset
|
| 34 |
+
ds = load_dataset("cparidaAI/fair_dataset_demo", data_files={"train": "data/table.csv"})
|
| 35 |
+
print(ds)
|
| 36 |
+
```
|
| 37 |
+
Or download a structure file:
|
| 38 |
+
```python
|
| 39 |
+
from huggingface_hub import hf_hub_download
|
| 40 |
+
path = hf_hub_download(repo_id="cparidaAI/fair_dataset_demo", filename="data/structures/ABO3_0001.xyz")
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
## License
|
| 44 |
+
MIT. Please cite using `CITATION.cff`.
|
| 45 |
+
|
| 46 |
+
## F.A.I.R. checklist
|
| 47 |
+
- **F**indable: metadata, tags, README, (add DOI later via Zenodo)
|
| 48 |
+
- **A**ccessible: public repo, open formats
|
| 49 |
+
- **I**nteroperable: CSV/JSON/EXTXYZ, schema describes fields/units
|
| 50 |
+
- **R**eusable: license, clear citation, validation, examples
|
data/records.jsonl
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{"id": "ABO3_0001", "formula": "SrTiO3", "system": "perovskite", "bandgap_eV": 3.2, "structure_path": "data/structures/ABO3_0001.xyz"}
|
| 2 |
+
{"id": "ABO3_0002", "formula": "BaZrO3", "system": "perovskite", "bandgap_eV": 5.0, "structure_path": "data/structures/ABO3_0002.xyz"}
|
| 3 |
+
{"id": "ABO3_0003", "formula": "LaAlO3", "system": "perovskite", "bandgap_eV": 5.6, "structure_path": "data/structures/ABO3_0003.xyz"}
|
data/structures/ABO3_0001.xyz
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
5
|
| 2 |
+
Lattice="3.905 0.0 0.0 0.0 3.905 0.0 0.0 0.0 3.905" Properties=species:S:1:pos:R:3 id=ABO3_0001 formula=SrTiO3 system=perovskite bandgap_eV=3.2 pbc="T T T"
|
| 3 |
+
Ca 0.00000000 0.00000000 0.00000000
|
| 4 |
+
Ti 1.95250000 1.95250000 1.95250000
|
| 5 |
+
O 1.95250000 0.00000000 0.00000000
|
| 6 |
+
O 0.00000000 1.95250000 0.00000000
|
| 7 |
+
O 0.00000000 0.00000000 1.95250000
|
data/structures/ABO3_0002.xyz
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
5
|
| 2 |
+
Lattice="3.905 0.0 0.0 0.0 3.905 0.0 0.0 0.0 3.905" Properties=species:S:1:pos:R:3 id=ABO3_0002 formula=BaZrO3 system=perovskite bandgap_eV=5.0 pbc="T T T"
|
| 3 |
+
Ca 0.00000000 0.00000000 0.00000000
|
| 4 |
+
Ti 1.95250000 1.95250000 1.95250000
|
| 5 |
+
O 1.95250000 0.00000000 0.00000000
|
| 6 |
+
O 0.00000000 1.95250000 0.00000000
|
| 7 |
+
O 0.00000000 0.00000000 1.95250000
|
data/structures/ABO3_0003.xyz
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
5
|
| 2 |
+
Lattice="3.905 0.0 0.0 0.0 3.905 0.0 0.0 0.0 3.905" Properties=species:S:1:pos:R:3 id=ABO3_0003 formula=LaAlO3 system=perovskite bandgap_eV=5.6 pbc="T T T"
|
| 3 |
+
Ca 0.00000000 0.00000000 0.00000000
|
| 4 |
+
Ti 1.95250000 1.95250000 1.95250000
|
| 5 |
+
O 1.95250000 0.00000000 0.00000000
|
| 6 |
+
O 0.00000000 1.95250000 0.00000000
|
| 7 |
+
O 0.00000000 0.00000000 1.95250000
|
data/table.csv
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
id,formula,system,bandgap_eV,structure_path
|
| 2 |
+
ABO3_0001,SrTiO3,perovskite,3.2,data/structures/ABO3_0001.xyz
|
| 3 |
+
ABO3_0002,BaZrO3,perovskite,5.0,data/structures/ABO3_0002.xyz
|
| 4 |
+
ABO3_0003,LaAlO3,perovskite,5.6,data/structures/ABO3_0003.xyz
|
metadata/schema.jsonschema
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
| 3 |
+
"title": "SimpleMaterialsRow",
|
| 4 |
+
"type": "object",
|
| 5 |
+
"required": [
|
| 6 |
+
"id",
|
| 7 |
+
"formula",
|
| 8 |
+
"system",
|
| 9 |
+
"bandgap_eV",
|
| 10 |
+
"structure_path"
|
| 11 |
+
],
|
| 12 |
+
"properties": {
|
| 13 |
+
"id": {
|
| 14 |
+
"type": "string"
|
| 15 |
+
},
|
| 16 |
+
"formula": {
|
| 17 |
+
"type": "string"
|
| 18 |
+
},
|
| 19 |
+
"system": {
|
| 20 |
+
"type": "string",
|
| 21 |
+
"enum": [
|
| 22 |
+
"perovskite",
|
| 23 |
+
"spinel",
|
| 24 |
+
"rocksalt",
|
| 25 |
+
"other"
|
| 26 |
+
]
|
| 27 |
+
},
|
| 28 |
+
"bandgap_eV": {
|
| 29 |
+
"type": "number",
|
| 30 |
+
"minimum": 0
|
| 31 |
+
},
|
| 32 |
+
"structure_path": {
|
| 33 |
+
"type": "string"
|
| 34 |
+
}
|
| 35 |
+
},
|
| 36 |
+
"additionalProperties": false
|
| 37 |
+
}
|