Xu lin commited on
Commit
15efa2b
·
verified ·
1 Parent(s): c37e117

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +102 -0
README.md CHANGED
@@ -9,4 +9,106 @@ tags:
9
  - Potential function
10
  - OneScience
11
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
 
9
  - Potential function
10
  - OneScience
11
  ---
12
+ <div>
13
+ <p style="margin-bottom: 0; margin-top: 0;">
14
+ <strong>Learn how to use OneScience for model training and development - <a href="https://gitee.com/onescience-ai/onescience-doc">Read Docs (Gitee)</a> | <a href="https://github.com/onescience-ai/OneScience-doc">GitHub Docs</a>.</strong>
15
+ </p>
16
+ <p style="margin-bottom: 0;">
17
+ Project links:
18
+ <a href="https://gitee.com/onescience-ai/onescience">OneScience Gitee</a> |
19
+ <a href="https://github.com/onescience-ai/OneScience">OneScience GitHub</a> |
20
+ <a href="https://gitee.com/onescience-ai/oneskills">OneSkills Gitee</a> |
21
+ <a href="https://github.com/onescience-ai/oneskills">OneSkills GitHub</a>
22
+ </p>
23
+ <div style="display: flex; gap: 5px; align-items: center;">
24
+ <a href="https://gitee.com/onescience-ai/onescience">
25
+ <img src="https://gitee.com/onescience-ai/onescience/raw/main/docs/logo.png?raw=true" width="133" alt="OneScience Logo" style="border-radius: 8px;">
26
+ </a>
27
+ </div>
28
+ <h1 style="margin-top:0rem; margin-bottom: 0rem;">💧 MACE-water Usage Guidelines</h1>
29
+ </div>
30
+
31
+ ## Quick Start Guide
32
+
33
+ - **OneScience Pre‑built Environment**: The platform provides a ready‑to‑use full‑stack image. No manual environment setup is required – start model development immediately.
34
+ - **Recommended Hyperparameters**:
35
+ - Cutoff radius `r_max`: typically 5.0–6.0 Å
36
+ - Batch size `batch_size`: adjust according to GPU memory (e.g., 32 or 64)
37
+ - Learning rate `lr`: 1e-3 – 1e-2
38
+ - **Data Format**: Extended XYZ files (`.xyz`) containing energies, atomic forces, and optionally virial stresses.
39
+ - **Quick Single‑DCU Training**:
40
+ git clone https://gitee.com/hpccube/onescience.git
41
+ cd onescience/examples/MaterialsChemistry/mace/
42
+ bash ./scripts/train.sh
43
+
44
+
45
+ # 1. Model Overview
46
+
47
+ **MACE (Multi‑Atomic Cluster Expansion)** is a state‑of‑the‑art machine learning force field that combines high‑order equivariant message‑passing neural networks (Equivariant MP‑GNNs) with the mathematical rigor of atomic cluster expansion (ACE). Its core features include:
48
+
49
+ - **High‑accuracy predictions**: Predict energies, atomic forces, and virial stresses with near‑DFT/xTB accuracy.
50
+ - **Equivariant architecture**: Built‑in rotational and translational equivariance provides strong physical expressiveness.
51
+ - **Broad applicability**: Suitable for molecular dynamics of small molecules as well as large‑scale simulations of crystalline materials – a powerful tool for materials design and screening.
52
+
53
+ The **OneScience platform** provides a ready‑to‑use full‑stack image:
54
+
55
+ ✅ No manual environment installation required.
56
+ ✅ Start model development and deployment immediately.
57
+
58
+ # 2. Environment Setup and Execution
59
+
60
+ ## (1) Underlying Build Process
61
+
62
+ The runtime environment is built on **Python 3.11** and deeply optimized for **Hygon DCU** hardware. The core build steps are:
63
+
64
+ 1. **Load the DTK environment**
65
+ Load the appropriate DTK (Developer Tool Kit) via the cluster module system to provide low‑level GPU acceleration support.
66
+
67
+ 2. **Install PyTorch (DCU edition)**
68
+ Obtain the DCU‑optimized PyTorch wheel (`.whl`) from the Guanghe Developer Community to ensure perfect compatibility with the hardware instruction set.
69
+
70
+ 3. **Integrate OneScience services**
71
+ Install the core OneScience platform components from source to connect data pipelines and model interfaces.
72
+
73
+ ## (2) Build Script Example
74
+
75
+ ### 1). Create and activate a dedicated Python 3.11 environment in Conda
76
+ ```bash
77
+ conda create -n onescience_matchem python=3.11 -y
78
+ conda activate onescience_matchem
79
+ ### 2). Load the underlying compiler and DTK environment (adjust module name as needed for your cluster)
80
+ module load compiler/dtk/25.04.2
81
+ ### 3). Install the DCU‑compatible PyTorch ecosystem (DAS 1.7 / DTK 25.04 / Python 3.10)
82
+ Install core libraries: PyTorch, torchvision
83
+ pip install https://download.sourcefind.cn:65024/directlink/4/pytorch/DAS1.7/torch-2.5.1+das.opt1.dtk25042-cp310-cp310-manylinux_2_28_x86_64.whl
84
+ pip install https://download.sourcefind.cn:65024/directlink/4/vision/DAS1.7/torchvision-0.20.1+das.opt1.dtk25042-cp310-cp310-manylinux_2_28_x86_64.whl
85
+ ### 4). Install OneScience framework and domain environment from source
86
+ git clone https://gitee.com/hpccube/onescience.git
87
+ cd onescience
88
+ pip install .
89
+
90
+ # 4. License
91
+ This code repository is licensed under the MIT License. The use of MACE‑water models is also subject to the MIT License. OneScience series (including Base and Chat) supports commercial use and distillation.
92
+
93
+ # 5. Citation
94
+
95
+ If you use MACE‑water or the OneScience platform in your research, please cite:
96
+ @misc{onescience2025mace,
97
+ title={MACE-water: A Multi-Atomic Cluster Expansion Force Field for Molecular Dynamics},
98
+ author={OneScience Team},
99
+ year={2025},
100
+ howpublished={\url{https://gitee.com/onescience-ai/onescience}},
101
+ note={Accessed: 2025-04-07}
102
+ }
103
+ # 6. Contact
104
+
105
+ If you have any questions, please contact us at:
106
+
107
+ Email: xushl3@sugon.com
108
+
109
+
110
+
111
+
112
+
113
+
114