Merge pull request #57 from qognitive/docs/install-guide

add install guide

docs/getting_started.rst

@@ -8,7 +8,7 @@ based on `PauliComposer <https://arxiv.org/abs/2301.00560>`_. 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
 ------------------------

docs/index.rst

@@ -12,16 +12,53 @@ fast_pauli documentation
    :maxdepth: 1
    :caption: Contents
 
-   install
    examples
    getting_started
    benchmarks
    python_api
    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
-=========
+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 [email protected]:qognitive/fast-pauli.git
+   cd fast_pauli
+   python -m pip install -e ".[dev]"
+
+
+Build From Source with CMake
+----------------------------
+.. code-block:: bash
+
+   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
+
+Verify / Test Build
+-------------------
+
+.. code-block:: bash
+
+   pytest -v tests/fast_pauli # + other pytest flags