Skip to content

Commit

Permalink
[docs/cleanup] Changing install instructions to drive everything thro…
Browse files Browse the repository at this point in the history
…ugh pip (including configurable builds).
  • Loading branch information
jamesETsmith committed Oct 8, 2024
1 parent 23c8cdb commit 66416c0
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 18 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,7 @@ pytest -v tests/fast_pauli

#### Configurable Build (Developers)
```bash
cmake -B build -G Ninja # + other cmake flags
cmake --build build --target install --parallel
ctest --test-dir build

python -m pip install --no-build-isolation -ve.
python -m pip install --no-build-isolation -ve ".[dev]" -C cmake.args="-DCMAKE_CXX_COMPILER=<compiler> + <other cmake flags>"
pytest -v tests/fast_pauli # + other pytest flags
```
Compiled `_fast_pauli` python module gets installed into `fast_pauli` directory.
Expand Down
4 changes: 2 additions & 2 deletions docs/benchmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ Again, we saw significant performance improvements for the same reasons stated a
Note that :code:`fast-pauli` performs better relative to :code:`qiskit` when the Pauli Operator is more sparse, i.e. when there are fewer Pauli Strings in the operator.


Expectation Value of a Pauli Operator
Expectation Values of a Pauli Operator
-------------------------------------------------------------------

Finally, we benchmarked the expectation value of a Pauli Operator applied to a **batch** of states:
Finally, we benchmarked the expectation values of a Pauli Operator applied to a **batch** of states:

.. math::
:label: pauli_op_expectation_value
Expand Down
13 changes: 2 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ inspired by `PauliComposer <https://arxiv.org/abs/2301.00560>`_ paper.
:code:`fast-pauli` aims to provide a fast and efficient alternative to existing libraries for working with Pauli matrices and strings,
with a focus on performance and usability.
For example, :code:`fast-pauli` provides optimized functions to apply Pauli strings and operators to a batch of states rather than just a single state vector.
See our :doc:`benchmarks` for more details about how :code:`fast-pauli` can speed up certain functions compared to Qiskit.

Our :doc:`getting_started` guide offers an introduction to some of the core functionality in :code:`fast-pauli`.
See our :doc:`getting_started` guide for an introduction to some of the core functionality in :code:`fast-pauli` and our :doc:`benchmarks` for more details about how :code:`fast-pauli` can speed up certain functions compared to Qiskit.

Installation
============
Expand Down Expand Up @@ -53,14 +51,7 @@ Build from Source (Custom Config)
git clone [email protected]:qognitive/fast-pauli.git
cd fast-pauli
# Configure/Compile the project
cmake -B build -G Ninja # <...custom cmake flags...>
cmake --build build --target install --parallel
ctest --test-dir build
# Install the python package
python -m pip install -e ".[dev]" --no-build-isolation
python -m pip install --no-build-isolation -ve ".[dev]" -C cmake.args="-DCMAKE_CXX_COMPILER=<compiler> + <other cmake flags>"
Verify / Test Build
-------------------
Expand Down

0 comments on commit 66416c0

Please sign in to comment.