Skip to content

Commit

Permalink
Minor adjustments to landing pages (#2)
Browse files Browse the repository at this point in the history
* Minor adjustments to landing pages

* Dont link refs in readme

* Update opening paragraph

* Finalize landing pages
  • Loading branch information
caleb-johnson authored Sep 13, 2024
1 parent 542da88 commit cae047d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@

Qiskit addons are a collection of modular tools for building utility-scale workloads powered by Qiskit.

This package contains the Qiskit addon for a [Dice-based eigensolver](https://sanshar.github.io/Dice/overview.html) [[1-2]](#references) which can be used to scale sample-based quantum diagonalization (SQD) [[3]](#references) workflows past 30 orbitals. No ``Dice`` executable is included in this package, but a build script is provided to assist users in properly setting up the package for installation.
This package contains a [Dice-based eigensolver [1-2]](https://sanshar.github.io/Dice/overview.html) that can be used to scale [sample-based quantum diagonalization (SQD) [3]](https://arxiv.org/abs/2405.05068) chemistry workflows past 30 orbitals. It is designed as a plugin to the [SQD Qiskit addon](https://qiskit.github.io/qiskit-addon-sqd/). No ``Dice`` executable is included in this package, but a build script is provided to assist users in properly setting up the package for installation. For an example of integrating ``qiskit-addon-dice-solver`` into SQD workflows, check out the [how-to](https://qiskit.github.io/qiskit-addon-sqd/how_tos/integrate_dice_solver.html).

This package uses the ``Dice`` command line application to perform the Davidson diagonalization method, which allows for diagonalization of systems of 30+ orbitals. The ``Dice`` application is designed to perform semistochastic heat-bath configuration interaction (SHCI) calculations which involves more than a single run of Davidson's method; however, this package restricts the inputs to ``Dice`` such that it is used only to perform a single diagonalization routine in the subspace defined by the input determinants.
This package uses the ``Dice`` command line application to perform the Davidson diagonalization method, which allows for diagonalization of systems of 30+ orbitals. The ``Dice`` application is designed to perform semistochastic heat-bath configuration interaction (SHCI) calculations that involves more than a single run of Davidson's method; however, this package restricts the inputs to ``Dice`` such that it is used only to perform a single diagonalization routine in the subspace defined by the input determinants.

We acknowledge Sandeep Sharma's support, suggestions, and conversations which made this package possible.
We acknowledge Sandeep Sharma's support, suggestions, and conversations that made this package possible.

----------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -57,7 +57,7 @@ To build the binaries required for this package:

And finally, to install the Python package:

``pip install .``
``pip install -e .``

----------------------------------------------------------------------------------------------------

Expand Down
9 changes: 5 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ Qiskit addon: Dice eigensolver

Qiskit addons are a collection of modular tools for building utility-scale workloads powered by Qiskit.

This package contains the Qiskit addon for a `Dice-based eigensolver <https://sanshar.github.io/Dice/overview.html>`_ [1-2] which can be used to scale sample-based quantum diagonalization (SQD) [3] workflows past 30 orbitals. No ``Dice`` executable is included in this package, but a build script is provided to assist users in properly setting up the package for installation.
This package uses the ``Dice`` command line application to perform the Davidson diagonalization method, which allows for diagonalization of systems of 30+ orbitals. The ``Dice`` application is designed to perform semistochastic heat-bath configuration interaction (SHCI) calculations which involves more than a single run of Davidson's method; however, this package restricts the inputs to ``Dice`` such that it is used only to perform a single diagonalization routine in the subspace defined by the input determinants.
This package contains a `Dice-based eigensolver [1-2] <https://sanshar.github.io/Dice/overview.html>`_ that can be used to scale sample-based quantum diagonalization (SQD) [3] chemistry workflows past 30 orbitals. It is designed as a plugin to the `SQD Qiskit addon <https://qiskit.github.io/qiskit-addon-sqd/>`_. No ``Dice`` executable is included in this package, but a build script is provided to assist users in properly setting up the package for installation. For an example of integrating ``qiskit-addon-dice-solver`` into SQD workflows, check out the `how-to <https://qiskit.github.io/qiskit-addon-sqd/how_tos/integrate_dice_solver.html>`_.

We acknowledge Sandeep Sharma's support, suggestions, and conversations which made this package possible.
This package uses the ``Dice`` command line application to perform the Davidson diagonalization method, which allows for diagonalization of systems of 30+ orbitals. The ``Dice`` application is designed to perform semistochastic heat-bath configuration interaction (SHCI) calculations that involves more than a single run of Davidson's method; however, this package restricts the inputs to ``Dice`` such that it is used only to perform a single diagonalization routine in the subspace defined by the input determinants.

We acknowledge Sandeep Sharma's support, suggestions, and conversations that made this package possible.

Documentation
-------------
Expand Down Expand Up @@ -45,7 +46,7 @@ And finally, to install the Python package:

.. code-block:: bash
pip install .
pip install -e .
Limitations
-----------
Expand Down

0 comments on commit cae047d

Please sign in to comment.