diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 684a236..fa9a7b0 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -8,7 +8,7 @@ based on `PauliComposer `_. In this guide, we'll introduce some of the important operations to help users get started. For more details, see the API documentation. -For tips on installing the library, check out the guide: :doc:`install`. +For tips on installing the library, check out the guide: :doc:`index`. Pauli Matrices ------------------------ diff --git a/docs/index.rst b/docs/index.rst index 9c108cd..e1f4286 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,6 @@ fast_pauli documentation :maxdepth: 1 :caption: Contents - install examples getting_started benchmarks @@ -20,8 +19,46 @@ fast_pauli documentation cpp_api -Introduction +Installation ============ +Welcome to ``fast_pauli``! This package provides fast and efficient implementations of pauli operators and strings, +with a focus on performance and usability. In order to get started, we'll need to install the package and its dependencies. -Our Goals -========= \ No newline at end of file +Here are a few options for installing ``fast_pauli``: + +Install using ``pip`` +------------------ +.. code-block:: bash + + pip install fast_pauli + +Install from source with Python +------------------------------- +.. code-block:: bash + + git clone git@github.com:qognitive/fast-pauli.git + cd fast_pauli + python -m pip install -e ".[dev]" + + +Build From Source with CMake +---------------------------- +.. code-block:: bash + + git clone git@github.com: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 + +Verify / Test Build +------------------- + +.. code-block:: bash + + pytest -v tests/fast_pauli # + other pytest flags diff --git a/docs/install.rst b/docs/install.rst deleted file mode 100644 index fe4a2da..0000000 --- a/docs/install.rst +++ /dev/null @@ -1,13 +0,0 @@ -Installation -============ - -Build From Source ------------------ - -.. code-block:: bash - - cmake -B build -DCMAKE_CXX_COMPILER=clang++ - cmake --build build --target install --parallel - ctest --test-dir build - - python -m pip install -e . \ No newline at end of file