Merge branch 'main' into docs/getting-started

README.md

@@ -36,6 +36,17 @@
 
 
 ---
+## Introduction
+
+Welcome to `fast-pauli` from [Qognitive](https://www.qognitive.io/), an open-source Python / C++ library for optimized operations on Pauli matrices and Pauli strings,
+inspired by [PauliComposer](https://arxiv.org/abs/2301.00560) paper.
+`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, `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 [benchmarks](https://qognitive-fast-pauli.readthedocs-hosted.com/en/latest/benchmarks.html) for more details about how `fast-pauli` can speed up certain functions compared to Qiskit.
+
+Our [Getting Started](https://qognitive-fast-pauli.readthedocs-hosted.com/en/latest/getting_started.html) guide offers an introduction to some of the core functionality in `fast-pauli`.
+
 ## Installation
 
 ### Pre-built Binaries
@@ -49,9 +60,10 @@ There are two strategies for building `fast_pauli` from source. One is a quick a
 
 #### Requirements
 
-- CMake >= 3.25
-- C++ compiler with OpenMP and C++20 support ([LLVM recommended](https://apt.llvm.org/))
-- Python >= 3.10
+- [CMake](https://pypi.org/project/cmake/) >= 3.25
+- [Ninja](https://pypi.org/project/ninja/) >= 1.11
+- C++ compiler with OpenMP and C++20 support ([LLVM](https://apt.llvm.org/) recommended)
+- [Python](https://www.python.org/downloads/) >= 3.10
 
 #### Quick Start (Users)
 ```bash
@@ -61,7 +73,7 @@ pytest -v tests/fast_pauli
 
 #### Configurable Build (Developers)
 ```bash
-cmake -B build # + other cmake flags
+cmake -B build -G Ninja # + other cmake flags
 cmake --build build --target install --parallel
 ctest --test-dir build
 

docs/conf.py

@@ -23,6 +23,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "furo"
+html_favicon = "logo/Sigma-logo-small.png"
 html_static_path = []  # type: ignore
 
 

docs/index.rst

@@ -15,13 +15,22 @@
    python_api
    cpp_api
 
+Introduction
+============
+Welcome to :code:`fast-pauli` from `Qognitive <https://www.qognitive.io/>`_, an open-source Python / C++ library for optimized operations on Pauli matrices and Pauli strings,
+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`.
 
 Installation
 ============
-Welcome to ``fast_pauli``! This package provides fast and efficient implementations of pauli strings and related operators,
-with a focus on performance and usability. In order to get started, we'll need to install the package and its dependencies.
+In order to get started, we'll need to install the package and its dependencies.
 
-Here are a few options for installing ``fast_pauli``:
+In the following subsections, we describe several options for installing ``fast_pauli``.
 
 Install the Latest Release
 --------------------------
@@ -38,7 +47,7 @@ Build from Source (Default Config)
    python -m pip install -e ".[dev]"
 
 
-Build From Source (Custom Config)
+Build from Source (Custom Config)
 ---------------------------------
 .. code-block:: bash