Repository navigation
Expand file tree
/
Copy pathexample_ensemble_optimization.py
More file actions
269 lines (203 loc) · 10 KB
/
Copy pathexample_ensemble_optimization.py
File metadata and controls
269 lines (203 loc) · 10 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
#!/usr/bin/env python3
"""Example: Ensemble and Batch Optimization with GPUMA.
Demonstrates how to optimize SMILES-generated conformer ensembles and how to
batch-optimize structures from multi-XYZ files or directories. Examples cover
both the Fairchem UMA and ORB-v3 backends.
"""
import os
import sys
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
import gpuma
from gpuma.config import Config, load_config_from_file
HERE = os.path.dirname(__file__)
OUTPUT_DIR = os.path.join(HERE, "example_output")
os.makedirs(OUTPUT_DIR, exist_ok=True)
# ---------------------------------------------------------------------------
# Fairchem UMA examples
# ---------------------------------------------------------------------------
def example_ensemble_from_smiles():
"""Example 1: Conformer ensemble optimization (Fairchem UMA, batch)."""
print("=== Example 1: Ensemble optimization from SMILES (Fairchem UMA) ===")
smiles = "CCC(CC)CCOOC(CC)CCOC"
config = Config()
config.conformer_generation.max_num_conformers = 50
config.optimization.force_convergence_criterion = 5e-1
print(f"Generating conformers for {smiles} and optimizing...")
output_file = os.path.join(OUTPUT_DIR, "python_ensemble_from_smiles_optimized.xyz")
results = gpuma.optimize_ensemble_smiles(
smiles=smiles,
output_file=output_file,
config=config,
)
print(" Ensemble optimization successful!")
print(f" Generated conformers: {len(results)}")
for i, s in enumerate(results):
print(f" Conformer {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
def example_batch_from_multi_xyz():
"""Example 2: Batch optimize structures from a multi-structure XYZ file."""
print("\n=== Example 2: Batch optimization from multi-XYZ file ===")
input_file = os.path.join(HERE, "example_input_xyzs/butene_triplet_multi.xyz")
output_file = os.path.join(OUTPUT_DIR, "python_batch_from_multi_xyz_optimized.xyz")
config = load_config_from_file(os.path.join(HERE, "config.json"))
config.optimization.multiplicity = 3
results = gpuma.optimize_batch_multi_xyz_file(
input_file=input_file,
output_file=output_file,
config=config,
)
print(" Batch optimization successful!")
print(f" Successfully optimized: {len(results)}")
for i, s in enumerate(results):
print(f" Structure {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
def example_batch_from_xyz_directory():
"""Example 3: Batch optimize structures from a directory of XYZ files."""
print("\n=== Example 3: Batch optimization from XYZ directory ===")
input_dir = os.path.join(HERE, "example_input_xyzs/multi_xyz_dir")
output_file = os.path.join(OUTPUT_DIR, "python_batch_from_directory_optimized.xyz")
results = gpuma.optimize_batch_xyz_directory(
input_directory=input_dir,
output_file=output_file,
)
comments = [f"Optimized structure {i + 1} from directory" for i in range(len(results))]
gpuma.save_multi_xyz(results, output_file, comments)
print(" Batch optimization successful!")
print(f" Successfully optimized: {len(results)}")
for i, s in enumerate(results):
print(f" Structure {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
# ---------------------------------------------------------------------------
# ORB-v3 examples
# ---------------------------------------------------------------------------
def example_ensemble_from_smiles_orb():
"""Example 4: Conformer ensemble optimization (ORB-v3, batch mode).
Uses GPU-accelerated torch-sim batch optimization with the ORB-v3 model.
"""
print("\n=== Example 4: Ensemble optimization from SMILES (ORB-v3, batch) ===")
smiles = "CCC(CC)CCOOC(CC)CCOC"
config = load_config_from_file(os.path.join(HERE, "config_orb.json"))
config.conformer_generation.max_num_conformers = 50
config.optimization.force_convergence_criterion = 5e-1
# batch mode is the default in config_orb.json
print(f"Generating conformers for {smiles} and optimizing with ORB-v3 (batch)...")
output_file = os.path.join(OUTPUT_DIR, "python_ensemble_orb_batch.xyz")
results = gpuma.optimize_ensemble_smiles(
smiles=smiles,
output_file=output_file,
config=config,
)
print(" ORB-v3 batch ensemble optimization successful!")
print(f" Generated conformers: {len(results)}")
for i, s in enumerate(results):
print(f" Conformer {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
def example_batch_from_multi_xyz_orb():
"""Example 6: Batch optimize structures from a multi-XYZ file (ORB-v3)."""
print("\n=== Example 6: Batch optimization from multi-XYZ file (ORB-v3) ===")
input_file = os.path.join(HERE, "example_input_xyzs/butene_triplet_multi.xyz")
output_file = os.path.join(OUTPUT_DIR, "python_batch_from_multi_xyz_orb.xyz")
config = load_config_from_file(os.path.join(HERE, "config_orb.json"))
config.optimization.multiplicity = 3
results = gpuma.optimize_batch_multi_xyz_file(
input_file=input_file,
output_file=output_file,
config=config,
)
print(" ORB-v3 batch optimization from multi-XYZ successful!")
print(f" Successfully optimized: {len(results)}")
for i, s in enumerate(results):
print(f" Structure {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
def example_batch_from_xyz_directory_orb():
"""Example 7: Batch optimize structures from a directory of XYZ files (ORB-v3)."""
print("\n=== Example 7: Batch optimization from XYZ directory (ORB-v3) ===")
input_dir = os.path.join(HERE, "example_input_xyzs/multi_xyz_dir")
output_file = os.path.join(OUTPUT_DIR, "python_batch_from_directory_orb.xyz")
config = load_config_from_file(os.path.join(HERE, "config_orb.json"))
results = gpuma.optimize_batch_xyz_directory(
input_directory=input_dir,
output_file=output_file,
config=config,
)
print(" ORB-v3 batch optimization from directory successful!")
print(f" Successfully optimized: {len(results)}")
for i, s in enumerate(results):
print(f" Structure {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
def example_ensemble_from_smiles_orb_sequential():
"""Example 8: Conformer ensemble optimization (ORB-v3, sequential mode).
Falls back to ASE per-structure optimization. Useful when no GPU
is available or for small ensembles.
"""
print("\n=== Example 8: Ensemble optimization from SMILES (ORB-v3, sequential) ===")
smiles = "CCC(CC)CCOOC(CC)CCOC"
config = load_config_from_file(os.path.join(HERE, "config_orb.json"))
config.conformer_generation.max_num_conformers = 10
config.optimization.batch_optimization_mode = "sequential"
print(f"Generating conformers for {smiles} and optimizing with ORB-v3 (sequential)...")
output_file = os.path.join(OUTPUT_DIR, "python_ensemble_orb_sequential.xyz")
results = gpuma.optimize_ensemble_smiles(
smiles=smiles,
output_file=output_file,
config=config,
)
print(" ORB-v3 sequential ensemble optimization successful!")
print(f" Generated conformers: {len(results)}")
for i, s in enumerate(results):
print(f" Conformer {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
# ---------------------------------------------------------------------------
# AIMNet2 examples
# ---------------------------------------------------------------------------
def example_ensemble_from_smiles_aimnet():
"""Example 9: Conformer ensemble optimization (AIMNet2, batch mode)."""
print("\n=== Example 9: Ensemble optimization from SMILES (AIMNet2, batch) ===")
smiles = "CCC(CC)CCOOC(CC)CCOC"
config = load_config_from_file(os.path.join(HERE, "config_aimnet.json"))
config.conformer_generation.max_num_conformers = 50
print(f"Generating conformers for {smiles} and optimizing with AIMNet2 (batch)...")
output_file = os.path.join(OUTPUT_DIR, "python_ensemble_aimnet_batch.xyz")
results = gpuma.optimize_ensemble_smiles(
smiles=smiles,
output_file=output_file,
config=config,
)
print(" AIMNet2 batch ensemble optimization successful!")
print(f" Generated conformers: {len(results)}")
for i, s in enumerate(results):
print(f" Conformer {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
def example_batch_from_multi_xyz_aimnet_nse():
"""Example 10: Batch optimize triplets with the open-shell AIMNet2-NSE model."""
print("\n=== Example 10: Batch optimization of triplets (AIMNet2-NSE) ===")
input_file = os.path.join(HERE, "example_input_xyzs/butene_triplet_multi.xyz")
output_file = os.path.join(OUTPUT_DIR, "python_batch_from_multi_xyz_aimnet_nse.xyz")
# aimnet2 is closed-shell only; aimnet2-nse uses the multiplicity
config = load_config_from_file(os.path.join(HERE, "config_aimnet.json"))
config.model.model_name = "aimnet2-nse"
config.optimization.multiplicity = 3
results = gpuma.optimize_batch_multi_xyz_file(
input_file=input_file,
output_file=output_file,
config=config,
)
print(" AIMNet2-NSE batch optimization from multi-XYZ successful!")
print(f" Successfully optimized: {len(results)}")
for i, s in enumerate(results):
print(f" Structure {i + 1}: {s.energy:.6f} eV")
print(f" Output saved to: {output_file}")
if __name__ == "__main__":
print("GPUMA - Ensemble and Batch Optimization Examples")
print("=" * 70)
example_ensemble_from_smiles()
example_batch_from_multi_xyz()
example_batch_from_xyz_directory()
example_ensemble_from_smiles_orb()
example_batch_from_multi_xyz_orb()
example_batch_from_xyz_directory_orb()
example_ensemble_from_smiles_orb_sequential()
example_ensemble_from_smiles_aimnet()
example_batch_from_multi_xyz_aimnet_nse()
print("\n" + "=" * 70)
print("Examples completed! Check the generated XYZ files.")