114 lines
4.1 KiB
Plaintext
114 lines
4.1 KiB
Plaintext
---
|
||
title: HDF5Driver
|
||
description: API reference for qiskit.chemistry.drivers.HDF5Driver
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.chemistry.drivers.HDF5Driver
|
||
---
|
||
|
||
# qiskit.chemistry.drivers.HDF5Driver
|
||
|
||
<Class id="qiskit.chemistry.drivers.HDF5Driver" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/hdf5d/hdf5driver.py" signature="HDF5Driver(hdf5_input='molecule.hdf5')" modifiers="class">
|
||
Qiskit chemistry driver reading an HDF5 file.
|
||
|
||
The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance.
|
||
|
||
**Parameters**
|
||
|
||
**hdf5\_input** (`str`) – Path to HDF5 file
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.chemistry.drivers.HDF5Driver.__init__" signature="__init__(hdf5_input='molecule.hdf5')">
|
||
**Parameters**
|
||
|
||
**hdf5\_input** (`str`) – Path to HDF5 file
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
|
||
| [`__init__`](#qiskit.chemistry.drivers.HDF5Driver.__init__ "qiskit.chemistry.drivers.HDF5Driver.__init__")(\[hdf5\_input]) | **type hdf5\_input**`str` |
|
||
| [`run`](#qiskit.chemistry.drivers.HDF5Driver.run "qiskit.chemistry.drivers.HDF5Driver.run")() | Runs driver to produce a QMolecule output. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
|
||
| [`basis`](#qiskit.chemistry.drivers.HDF5Driver.basis "qiskit.chemistry.drivers.HDF5Driver.basis") | return basis |
|
||
| [`hf_method`](#qiskit.chemistry.drivers.HDF5Driver.hf_method "qiskit.chemistry.drivers.HDF5Driver.hf_method") | return Hartree-Fock method |
|
||
| [`molecule`](#qiskit.chemistry.drivers.HDF5Driver.molecule "qiskit.chemistry.drivers.HDF5Driver.molecule") | return molecule |
|
||
| [`supports_molecule`](#qiskit.chemistry.drivers.HDF5Driver.supports_molecule "qiskit.chemistry.drivers.HDF5Driver.supports_molecule") | True for derived classes that support Molecule. |
|
||
| [`work_path`](#qiskit.chemistry.drivers.HDF5Driver.work_path "qiskit.chemistry.drivers.HDF5Driver.work_path") | Returns work path. |
|
||
|
||
### basis
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.HDF5Driver.basis">
|
||
return basis
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### hf\_method
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.HDF5Driver.hf_method">
|
||
return Hartree-Fock method
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### molecule
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.HDF5Driver.molecule">
|
||
return molecule
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`Molecule`]
|
||
</Attribute>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.chemistry.drivers.HDF5Driver.run" signature="run()">
|
||
Runs driver to produce a QMolecule output.
|
||
|
||
**Return type**
|
||
|
||
`QMolecule`
|
||
|
||
**Returns**
|
||
|
||
A QMolecule containing the molecular data.
|
||
|
||
**Raises**
|
||
|
||
**LookupError** – file not found.
|
||
</Function>
|
||
|
||
### supports\_molecule
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.HDF5Driver.supports_molecule">
|
||
True for derived classes that support Molecule.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
True if Molecule is supported.
|
||
</Attribute>
|
||
|
||
### work\_path
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.HDF5Driver.work_path">
|
||
Returns work path.
|
||
</Attribute>
|
||
</Class>
|
||
|