md.calculators.OrcaCalculator

class md.calculators.OrcaCalculator(*args: Any, **kwargs: Any)[source]

Calculator for interfacing the ORCA code package [1] with SchNetPack molecular dynamics. Requires ORCA to be installed and an input file template. This template is a standard ORCA input file, with everything past the specification of coordinate format, charge and multiplicity removed (coordinates and final *). If desired, a Queuer can be give, which will attempt to send all jobs to a grid engine queue.

In general, the calculator will take the current System to generate inputs, perform the calculation with ORCA, extract data from the ouput file (using the OrcaParser class) and update the System.

Parameters:

  • required_properties (list) – List of the property names which will be passed to the simulator

  • force_key (str) – Name of the property corresponding to the forces.

  • compdir (str) – Directory in which computations are performed.

  • qm_executable (str) – Path to the ORCA executable.

  • orca_template (str) – Path to an ORCA template which will be used to generate input files. This should be a full ORCA input, where the geometry section between *xyz and * is replaced by the string {geometry}.

  • energy_unit (str, float) – Energy units returned by the internal computation model.

  • position_unit (str, float) – Unit conversion for the length used in the model computing all properties. E.g. if the model needs Angstrom, one has to provide the conversion factor converting from the atomic units used internally (Bohr) to Angstrom: 0.529177. Is used together with energy_unit to determine units of force and stress.

  • energy_key (str, optional) – Name of the property corresponding to the energy.

  • stress_key (str, optional) – Name of the property corresponding to the stress.

  • property_conversion (dict, optional) – Convert properties to requested units. If left empty, no conversion is performed.

  • overwrite (bool) – Overwrite previous computation results. Default is true.

  • adaptive (bool, optional) – Specify, whether the calculator should be used for adaptive sampling.

  • basename (str, optional) – Basename of the generated input files.

  • orca_parser (schnetpack.md.parsers.OrcaParser, optional) – Parser used to extract data from output files.

References