Merge branch 'main' into feature/fast-pauli-docstrings

qognitive · Oct 4, 2024 · a4dc8ef · a4dc8ef
2 parents 418d6d7 + 613337e
commit a4dc8ef
Show file tree

Hide file tree

Showing 48 changed files with 683 additions and 19 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,3 +1,17 @@
+# ##############################################################################
+# This code is part of Fast Pauli.
+#
+# (C) Copyright Qognitive Inc 2024.
+#
+# This code is licensed under the BSD 2-Clause License. You may obtain a copy of
+# this license in the LICENSE.txt file in the root directory of this source
+# tree.
+#
+# Any modifications or derivative works of this code must retain this copyright
+# notice, and modified files need to carry a notice indicating that they have
+# been altered from the originals.
+# ##############################################################################
+
 #
 # Boilerplate CMakeLists.txt for C++ projects
 #

diff --git a/Makefile b/Makefile
@@ -1,3 +1,18 @@
+#############################################################################
+# This code is part of Fast Pauli.
+#
+# (C) Copyright Qognitive Inc 2024.
+#
+# This code is licensed under the BSD 2-Clause License. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+#############################################################################
+
+
 ###############################################################################
 # BUILD
 ###############################################################################

diff --git a/README.md b/README.md
@@ -10,7 +10,10 @@
   </tr>
   <tr>
     <td>Usage</td>
-    <td>TODO RTD INFO
+    <td>
+      <a href='https://qognitive-fast-pauli.readthedocs-hosted.com/en/latest/?badge=latest'>
+    <img src='https://readthedocs.com/projects/qognitive-fast-pauli/badge/?version=latest' alt='Documentation Status' />
+</a>
     <a href="https://github.com/qognitive/fast-pauli/tree/develop?tab=readme-ov-file#installation"><img src="https://img.shields.io/badge/Docs-Installation-blue" alt="Installation"></a>
      </td>
   </tr>

diff --git a/docs/getting_started.rst b/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
 ------------------------

diff --git a/docs/index.rst b/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
diff --git a/docs/install.rst b/docs/install.rst
diff --git a/fast_pauli/__init__.py b/fast_pauli/__init__.py
@@ -1,3 +1,18 @@
+#############################################################################
+# This code is part of Fast Pauli.
+#
+# (C) Copyright Qognitive Inc 2024.
+#
+# This code is licensed under the BSD 2-Clause License. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+#############################################################################
+
+
 """:code:`fast_pauli` is a Python package with C++ backend, optimized for operations on Pauli Matrices and Pauli Strings."""  # noqa: E501
 
 from ._fast_pauli import (  # noqa: F401

diff --git a/fast_pauli/cpp/examples/01_pauli_op.cpp b/fast_pauli/cpp/examples/01_pauli_op.cpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #include <algorithm>
 #include <random>
 

diff --git a/fast_pauli/cpp/examples/02_pauli_op_multistate.cpp b/fast_pauli/cpp/examples/02_pauli_op_multistate.cpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #include <algorithm>
 #include <experimental/mdspan>
 #include <random>

diff --git a/fast_pauli/cpp/examples/03_summed_pauli_op.cpp b/fast_pauli/cpp/examples/03_summed_pauli_op.cpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #include <algorithm>
 #include <experimental/mdspan>
 #include <random>

diff --git a/fast_pauli/cpp/examples/CMakeLists.txt b/fast_pauli/cpp/examples/CMakeLists.txt
@@ -1,3 +1,17 @@
+# ##############################################################################
+# This code is part of Fast Pauli.
+#
+# (C) Copyright Qognitive Inc 2024.
+#
+# This code is licensed under the BSD 2-Clause License. You may obtain a copy of
+# this license in the LICENSE.txt file in the root directory of this source
+# tree.
+#
+# Any modifications or derivative works of this code must retain this copyright
+# notice, and modified files need to carry a notice indicating that they have
+# been altered from the originals.
+# ##############################################################################
+
 # Grab all *.cpp files in the directory
 file(GLOB EXAMPLE CONFIGURE_DEPENDS "*.cpp")
 

diff --git a/fast_pauli/cpp/include/__factory.hpp b/fast_pauli/cpp/include/__factory.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __FAST_PAULI_FACTORY_HPP
 #define __FAST_PAULI_FACTORY_HPP
 

diff --git a/fast_pauli/cpp/include/__nb_helpers.hpp b/fast_pauli/cpp/include/__nb_helpers.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __NB_HELPERS_HPP
 #define __NB_HELPERS_HPP
 

diff --git a/fast_pauli/cpp/include/__pauli.hpp b/fast_pauli/cpp/include/__pauli.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __PAULI_HPP
 #define __PAULI_HPP
 

diff --git a/fast_pauli/cpp/include/__pauli_helpers.hpp b/fast_pauli/cpp/include/__pauli_helpers.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __PAULI_HELPERS_HPP
 #define __PAULI_HELPERS_HPP
 

diff --git a/fast_pauli/cpp/include/__pauli_op.hpp b/fast_pauli/cpp/include/__pauli_op.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __PAULI_OP_HPP
 #define __PAULI_OP_HPP
 

diff --git a/fast_pauli/cpp/include/__pauli_string.hpp b/fast_pauli/cpp/include/__pauli_string.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __PAULI_STRING_HPP
 #define __PAULI_STRING_HPP
 

diff --git a/fast_pauli/cpp/include/__summed_pauli_op.hpp b/fast_pauli/cpp/include/__summed_pauli_op.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __SUMMED_PAULI_OP_HPP
 #define __SUMMED_PAULI_OP_HPP
 

diff --git a/fast_pauli/cpp/include/__type_traits.hpp b/fast_pauli/cpp/include/__type_traits.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef __FP_TYPE_TRAITS_HPP
 #define __FP_TYPE_TRAITS_HPP
 

diff --git a/fast_pauli/cpp/include/fast_pauli.hpp b/fast_pauli/cpp/include/fast_pauli.hpp
@@ -1,3 +1,17 @@
+/**
+ * This code is part of Fast Pauli.
+ *
+ * (C) Copyright Qognitive Inc 2024.
+ *
+ * This code is licensed under the BSD 2-Clause License. You may
+ * obtain a copy of this license in the LICENSE.txt file in the root directory
+ * of this source tree.
+ *
+ * Any modifications or derivative works of this code must retain this
+ * copyright notice, and modified files need to carry a notice indicating
+ * that they have been altered from the originals.
+ */
+
 #ifndef FAST_PAULI_HPP
 #define FAST_PAULI_HPP