core
Core recipes for the NewtonNet code.
freq_job ¶
freq_job(
atoms: Atoms,
temperature: float = 298.15,
pressure: float = 1.0,
copy_files: (
SourceDirectory
| dict[SourceDirectory, Filenames]
| None
) = None,
**calc_kwargs
) -> VibThermoSchema
Perform a frequency calculation using the given atoms object.
Parameters:
-
atoms
(Atoms
) –The atoms object representing the system.
-
temperature
(float
, default:298.15
) –The temperature for the thermodynamic analysis.
-
pressure
(float
, default:1.0
) –The pressure for the thermodynamic analysis.
-
copy_files
(SourceDirectory | dict[SourceDirectory, Filenames] | None
, default:None
) –Files to copy (and decompress) from source to the runtime directory.
-
**calc_kwargs
–Custom kwargs for the NewtonNet calculator. Set a value to
quacc.Remove
to remove a pre-existing key entirely. For a list of available keys, refer to thenewtonnet.utils.ase_interface.MLAseCalculator
calculator.
Returns:
-
VibThermoSchema
–Dictionary of results. See the type-hint for the data structure.
Source code in quacc/recipes/newtonnet/core.py
relax_job ¶
relax_job(
atoms: Atoms,
opt_params: OptParams | None = None,
copy_files: (
SourceDirectory
| dict[SourceDirectory, Filenames]
| None
) = None,
**calc_kwargs
) -> OptSchema
Relax a structure.
Parameters:
-
atoms
(Atoms
) –Atoms object
-
opt_params
(OptParams | None
, default:None
) –Dictionary of custom kwargs for the optimization process. For a list of available keys, refer to quacc.runners.ase.run_opt.
-
copy_files
(SourceDirectory | dict[SourceDirectory, Filenames] | None
, default:None
) –Files to copy (and decompress) from source to the runtime directory.
-
**calc_kwargs
–Dictionary of custom kwargs for the NewtonNet calculator. Set a value to
quacc.Remove
to remove a pre-existing key entirely. For a list of available keys, refer to thenewtonnet.utils.ase_interface.MLAseCalculator
calculator.
Returns:
-
OptSchema
–Dictionary of results, specified in quacc.schemas.ase.summarize_opt_run. See the type-hint for the data structure.
Source code in quacc/recipes/newtonnet/core.py
static_job ¶
static_job(
atoms: Atoms,
copy_files: (
SourceDirectory
| dict[SourceDirectory, Filenames]
| None
) = None,
**calc_kwargs
) -> RunSchema
Carry out a single-point calculation.
Parameters:
-
atoms
(Atoms
) –Atoms object
-
copy_files
(SourceDirectory | dict[SourceDirectory, Filenames] | None
, default:None
) –Files to copy (and decompress) from source to the runtime directory.
-
**calc_kwargs
–Custom kwargs for the NewtonNet calculator. Set a value to
quacc.Remove
to remove a pre-existing key entirely. For a list of available keys, refer to thenewtonnet.utils.ase_interface.MLAseCalculator
calculator.
Returns:
-
RunSchema
–Dictionary of results, specified in quacc.schemas.ase.summarize_run. See the type-hint for the data structure.