92 lines
2.2 KiB
Plaintext
92 lines
2.2 KiB
Plaintext
---
|
||
title: BosonicDriver (v0.31)
|
||
description: API reference for qiskit.chemistry.drivers.BosonicDriver in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.chemistry.drivers.BosonicDriver
|
||
---
|
||
|
||
# BosonicDriver
|
||
|
||
<Class id="qiskit.chemistry.drivers.BosonicDriver" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/drivers/bosonic_driver.py" signature="BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)" modifiers="class">
|
||
Bases: `qiskit.chemistry.drivers.base_driver.BaseDriver`
|
||
|
||
Base class for Qiskit’s chemistry bosonic drivers.
|
||
|
||
**Parameters**
|
||
|
||
* **molecule** (`Optional`\[`Molecule`]) – molecule
|
||
* **basis** (`str`) – basis set
|
||
* **hf\_method** (`str`) – Hartree-Fock Method type
|
||
* **supports\_molecule** (`bool`) – Indicates if driver supports molecule
|
||
|
||
**Raises**
|
||
|
||
[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it.
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-chemistry-drivers-bosonicdriver-run" />
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.chemistry.drivers.BosonicDriver.run" signature="BosonicDriver.run()" modifiers="abstract">
|
||
Runs driver to produce a WatsonHamiltonian output.
|
||
|
||
**Return type**
|
||
|
||
`WatsonHamiltonian`
|
||
|
||
**Returns**
|
||
|
||
A WatsonHamiltonian comprising the bosonic data.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### basis
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.BosonicDriver.basis">
|
||
return basis
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### hf\_method
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.BosonicDriver.hf_method">
|
||
return Hartree-Fock method
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### molecule
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.BosonicDriver.molecule">
|
||
return molecule
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`Molecule`]
|
||
</Attribute>
|
||
|
||
### supports\_molecule
|
||
|
||
<Attribute id="qiskit.chemistry.drivers.BosonicDriver.supports_molecule">
|
||
True for derived classes that support Molecule.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
True if Molecule is supported.
|
||
</Attribute>
|
||
</Class>
|
||
|