Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinsung committed Oct 8, 2024
1 parent ceab79e commit 6558859
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions qiskit_addon_dice_solver/dice_solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ def solve_hci(
float, np.ndarray, tuple[np.ndarray, np.ndarray], tuple[np.ndarray, np.ndarray]
]:
"""
Approximate the ground state of a molecular Hamiltonian given a bitstring matrix defining the Hilbert subspace.
This solver is designed for compatibility with `qiskit-addon-sqd <https://qiskit.github.io/qiskit-addon-sqd/>`_ workflows.
Approximate the ground state of a molecular Hamiltonian using the heat bath configuration interaction method.
In order to leverage the multi-processing nature of this tool, the user must specify
the CPU resources to use via the `mpirun_options` argument.
Expand All @@ -82,7 +80,7 @@ def solve_hci(
# OR
mpirun_opts = ["-quiet", "-n", "8"]
energy, sci_coeffs, avg_occs = solve_fermion(..., mpirun_options=mpirun_opts)
energy, sci_coeffs, sci_strings, avg_occs = solve_hci(..., mpirun_options=mpirun_opts)
For more information on the ``mpirun`` command line options, refer to the `man page <https://www.open-mpi.org/doc/current/man1/mpirun.1.php>`_.
Expand Down

0 comments on commit 6558859

Please sign in to comment.