Ramlaoui commited on
Commit
2d0d41c
·
verified ·
1 Parent(s): 3083a70

Simplify dataset paths and sources section

Browse files
Files changed (1) hide show
  1. README.md +7 -21
README.md CHANGED
@@ -46,33 +46,19 @@ print(len(db))
46
  db.close()
47
  ```
48
 
49
- ## Available Dataset Paths
50
 
51
- The main public dataset paths currently exposed in this repository include:
52
 
53
- - `lematbulk/pbe`
54
- - `matpes/pbe`
55
- - `matpes/r2scan`
56
- - `mp_aloe`
57
- - `mptrj`
58
- - `omat/train`
59
- - `omat/val`
60
 
61
  These paths may be stored as one `.atp` file or as a shard directory.
62
  `atompack.hub.open(...)` handles both through the same read-only API.
63
 
64
- ## Upstream Dataset Sources
65
-
66
- The packaged datasets in this repository come from the following upstream sources:
67
-
68
- - `lematbulk/pbe`: [LeMat-Bulk](https://huggingface.co/datasets/LeMaterial/LeMat-Bulk). If you use this path, cite LeMat-Bulk.
69
- - `matpes/pbe`, `matpes/r2scan`: [MatPES](https://docs.materialsproject.org/collaborations/matpes). If you use these paths, cite MatPES.
70
- - `mp_aloe`: [MP-ALOE](https://www.nature.com/articles/s41524-025-01834-9). If you use this path, cite MP-ALOE.
71
- - `mptrj`: [MPtrj](https://docs.materialsproject.org/services/ml-and-ai-applications/mptrj). If you use this path, cite MPtrj.
72
- - `omat/train`, `omat/val`: [OMAT24](https://huggingface.co/datasets/facebook/OMAT24). If you use these paths, cite OMAT24.
73
-
74
- If you use one of these dataset paths, please cite the corresponding upstream dataset.
75
-
76
  ## Why Atompack
77
 
78
  Atompack is designed for the point where atomistic datasets stop behaving like small scientific
 
46
  db.close()
47
  ```
48
 
49
+ ## Dataset Paths and Sources
50
 
51
+ The main public dataset paths currently exposed in this repository are:
52
 
53
+ - `lematbulk/pbe`, from [LeMat-Bulk](https://huggingface.co/datasets/LeMaterial/LeMat-Bulk). If you use this path, cite LeMat-Bulk.
54
+ - `matpes/pbe` and `matpes/r2scan`, from [MatPES](https://docs.materialsproject.org/collaborations/matpes). If you use these paths, cite MatPES.
55
+ - `mp_aloe`, from [MP-ALOE](https://www.nature.com/articles/s41524-025-01834-9). If you use this path, cite MP-ALOE.
56
+ - `mptrj`, from [MPtrj](https://docs.materialsproject.org/services/ml-and-ai-applications/mptrj). If you use this path, cite MPtrj.
57
+ - `omat/train` and `omat/val`, from [OMAT24](https://huggingface.co/datasets/facebook/OMAT24). If you use these paths, cite OMAT24.
 
 
58
 
59
  These paths may be stored as one `.atp` file or as a shard directory.
60
  `atompack.hub.open(...)` handles both through the same read-only API.
61
 
 
 
 
 
 
 
 
 
 
 
 
 
62
  ## Why Atompack
63
 
64
  Atompack is designed for the point where atomistic datasets stop behaving like small scientific