ase
ASE calculators for molecular properties.
AimNet2Calculator
dataclass
Bases: ASECalculator, MachineLearnedInteratomicPotentialCalculator, MSONable
flowchart TD
jfchemistry.calculators.ase.AimNet2Calculator[AimNet2Calculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator[ASECalculator]
jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator[MachineLearnedInteratomicPotentialCalculator]
jfchemistry.calculators.base.Calculator[Calculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator --> jfchemistry.calculators.ase.AimNet2Calculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.ase.ase_calculator.ASECalculator
jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator --> jfchemistry.calculators.ase.AimNet2Calculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator
click jfchemistry.calculators.ase.AimNet2Calculator href "" "jfchemistry.calculators.ase.AimNet2Calculator"
click jfchemistry.calculators.ase.ase_calculator.ASECalculator href "" "jfchemistry.calculators.ase.ase_calculator.ASECalculator"
click jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator href "" "jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator"
click jfchemistry.calculators.base.Calculator href "" "jfchemistry.calculators.base.Calculator"
AimNet2 neural network potential calculator.
AimNet2 is a neural network-based calculator for computing molecular energies and atomic partial charges. It provides fast predictions for molecules containing H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, and I atoms.
The calculator requires the 'aimnet' package from: https://github.com/cfarm6/aimnetcentral.git
| ATTRIBUTE | DESCRIPTION |
|---|---|
name |
Name of the calculator (default: "AimNet2 Calculator").
TYPE:
|
model |
AimNet2 model to use (default: "aimnet2").
TYPE:
|
charge |
Molecular charge override. If None, uses charge from structure. |
multiplicity |
Spin multiplicity override. If None, uses spin from structure. |
Source code in jfchemistry/calculators/ase/aimnet2_calculator.py
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 | |
FairChemCalculator
dataclass
Bases: ASECalculator, MachineLearnedInteratomicPotentialCalculator, MSONable
flowchart TD
jfchemistry.calculators.ase.FairChemCalculator[FairChemCalculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator[ASECalculator]
jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator[MachineLearnedInteratomicPotentialCalculator]
jfchemistry.calculators.base.Calculator[Calculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator --> jfchemistry.calculators.ase.FairChemCalculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.ase.ase_calculator.ASECalculator
jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator --> jfchemistry.calculators.ase.FairChemCalculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator
click jfchemistry.calculators.ase.FairChemCalculator href "" "jfchemistry.calculators.ase.FairChemCalculator"
click jfchemistry.calculators.ase.ase_calculator.ASECalculator href "" "jfchemistry.calculators.ase.ase_calculator.ASECalculator"
click jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator href "" "jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator"
click jfchemistry.calculators.base.Calculator href "" "jfchemistry.calculators.base.Calculator"
FairChemital Materials FairChem machine learning force field calculator.
FairChem models are graph neural network-based force fields developed by FairChem Materials for fast and accurate molecular property predictions. The calculator supports both conservative and direct versions of the FairChem-v3 model.
| ATTRIBUTE | DESCRIPTION |
|---|---|
name |
Name of the calculator (default: "FairChem Model Calculator").
TYPE:
|
model |
FairChem model variant to use. Options: - "FairChem-v3-conservative-omol": Conservative model (recommended) - "FairChem-v3-direct-omol": Direct model
TYPE:
|
charge |
Molecular charge override. If None, uses charge from structure. |
multiplicity |
Spin multiplicity override. If None, uses spin from structure. |
device |
Computation device ("cpu" or "cuda"). Default: "cpu".
TYPE:
|
precision |
Numerical precision for calculations. Options: - "float32-high": Standard precision (default) - "float32-highest": Higher precision float32 - "float64": Double precision
TYPE:
|
compile |
Whether to compile the model for faster inference (default: False).
TYPE:
|
Examples:
>>> from jfchemistry.calculators import FairChemModelCalculator
>>>
>>> # Create calculator with GPU acceleration
>>> calc = FairChemModelCalculator(
... model="FairChem-v3-conservative-omol",
... device="cuda",
... precision="float32-highest"
... )
>>>
>>> # Setup on structure
>>> atoms = molecule.to_ase_atoms()
>>> atoms = calc._set_calculator(atoms, charge=0, spin_multiplicity=1)
>>>
>>> # Get properties
>>> props = calc.get_properties(atoms)
>>> energy = props["Global"]["Total Energy [eV]"]
Source code in jfchemistry/calculators/ase/fairchem_calculator.py
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 | |
ORBCalculator
dataclass
Bases: ASECalculator, MachineLearnedInteratomicPotentialCalculator, MSONable
flowchart TD
jfchemistry.calculators.ase.ORBCalculator[ORBCalculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator[ASECalculator]
jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator[MachineLearnedInteratomicPotentialCalculator]
jfchemistry.calculators.base.Calculator[Calculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator --> jfchemistry.calculators.ase.ORBCalculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.ase.ase_calculator.ASECalculator
jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator --> jfchemistry.calculators.ase.ORBCalculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator
click jfchemistry.calculators.ase.ORBCalculator href "" "jfchemistry.calculators.ase.ORBCalculator"
click jfchemistry.calculators.ase.ase_calculator.ASECalculator href "" "jfchemistry.calculators.ase.ase_calculator.ASECalculator"
click jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator href "" "jfchemistry.calculators.base.MachineLearnedInteratomicPotentialCalculator"
click jfchemistry.calculators.base.Calculator href "" "jfchemistry.calculators.base.Calculator"
Orbital Materials ORB machine learning force field calculator.
ORB models are graph neural network-based force fields developed by Orbital Materials for fast and accurate molecular property predictions. The calculator supports both conservative and direct versions of the ORB-v3 model.
The calculator requires the 'orb-models' package from: https://github.com/orbital-materials/orb-models
| ATTRIBUTE | DESCRIPTION |
|---|---|
name |
Name of the calculator (default: "ORB Model Calculator").
TYPE:
|
model |
ORB model variant to use. Options: - "orb-v3-conservative-omol": Conservative model (recommended) - "orb-v3-direct-omol": Direct model
TYPE:
|
charge |
Molecular charge override. If None, uses charge from structure. |
multiplicity |
Spin multiplicity override. If None, uses spin from structure. |
device |
Computation device ("cpu" or "cuda"). Default: "cpu".
TYPE:
|
precision |
Numerical precision for calculations. Options: - "float32-high": Standard precision (default) - "float32-highest": Higher precision float32 - "float64": Double precision
TYPE:
|
compile |
Whether to compile the model for faster inference (default: False).
TYPE:
|
Examples:
>>> from jfchemistry.calculators import ORBModelCalculator
>>>
>>> # Create calculator with GPU acceleration
>>> calc = ORBModelCalculator(
... model="orb-v3-conservative-omol",
... device="cuda",
... precision="float32-highest"
... )
>>>
>>> # Setup on structure
>>> atoms = molecule.to_ase_atoms()
>>> atoms = calc._set_calculator(atoms, charge=0, spin_multiplicity=1)
>>>
>>> # Get properties
>>> props = calc.get_properties(atoms)
>>> energy = props["Global"]["Total Energy [eV]"]
Source code in jfchemistry/calculators/ase/orb_calculator.py
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 | |
TBLiteCalculator
dataclass
Bases: ASECalculator, SemiempiricalCalculator, MSONable
flowchart TD
jfchemistry.calculators.ase.TBLiteCalculator[TBLiteCalculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator[ASECalculator]
jfchemistry.calculators.base.SemiempiricalCalculator[SemiempiricalCalculator]
jfchemistry.calculators.base.Calculator[Calculator]
jfchemistry.calculators.ase.ase_calculator.ASECalculator --> jfchemistry.calculators.ase.TBLiteCalculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.ase.ase_calculator.ASECalculator
jfchemistry.calculators.base.SemiempiricalCalculator --> jfchemistry.calculators.ase.TBLiteCalculator
jfchemistry.calculators.base.Calculator --> jfchemistry.calculators.base.SemiempiricalCalculator
click jfchemistry.calculators.ase.TBLiteCalculator href "" "jfchemistry.calculators.ase.TBLiteCalculator"
click jfchemistry.calculators.ase.ase_calculator.ASECalculator href "" "jfchemistry.calculators.ase.ase_calculator.ASECalculator"
click jfchemistry.calculators.base.SemiempiricalCalculator href "" "jfchemistry.calculators.base.SemiempiricalCalculator"
click jfchemistry.calculators.base.Calculator href "" "jfchemistry.calculators.base.Calculator"
TBLite calculator for GFN-xTB semi-empirical methods.
TBLite provides implementations of the GFN (Geometrical-dependent Forcefield for Noncovalent interactions) extended tight-binding methods developed by the Grimme group. These methods offer a good balance between accuracy and computational efficiency for large molecular systems.
The calculator computes extensive molecular properties including energies, partial charges, bond orders, molecular orbitals, dipole/quadrupole moments, and HOMO-LUMO gaps.
| ATTRIBUTE | DESCRIPTION |
|---|---|
name |
Name of the calculator (default: "TBLite Calculator").
TYPE:
|
method |
Semi-empirical method to use. Options: - "GFN2-xTB": GFN2-xTB method (default, recommended for most cases) - "GFN1-xTB": GFN1-xTB method - "IPEA1-xTB": IPEA1-xTB method
TYPE:
|
charge |
Molecular charge override. If None, uses charge from structure. |
multiplicity |
Spin multiplicity override. If None, uses spin from structure. |
accuracy |
Numerical accuracy parameter (default: 1.0).
TYPE:
|
electronic_temperature |
Electronic temperature in Kelvin for Fermi smearing (default: 300.0).
TYPE:
|
max_iterations |
Maximum SCF iterations (default: 250).
TYPE:
|
initial_guess |
Initial guess for electronic structure. Options: - "sad": Superposition of atomic densities (default) - "eeq": Electronegativity equilibration
TYPE:
|
mixer_damping |
Damping parameter for SCF mixing (default: 0.4).
TYPE:
|
verbosity |
Output verbosity level (default: 0).
TYPE:
|
Examples:
>>> from jfchemistry.calculators import TBLiteCalculator
>>> from ase.build import molecule
>>> from pymatgen.core import Molecule
>>> mol = Molecule.from_ase_atoms(molecule("C2H6"))
>>> # Create calculator with custom settings
>>> calc = TBLiteCalculator(
... method="GFN2-xTB",
... accuracy=0.1, # Tighter convergence
... max_iterations=500
... )
>>>
>>> # Compute properties
>>> atoms = mol.to_ase_atoms()
>>> atoms = calc.set_calculator(atoms, charge=0, spin_multiplicity=1)
>>> props = calc.get_properties(atoms)
Source code in jfchemistry/calculators/ase/tblite_calculator.py
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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | |