Docs update

CONTRIBUTIONS.rst

@@ -1,7 +1,7 @@
 Contributions guidelines
 ========================
 
-Thank you very much for considering contributing to this project ! 
+Thank you very much for considering contributing to this project !
 
 Do not feel intimidated by the guidelines and processes we describe in this document: we are here to assist you and help you take things to the finish line. We do not expect you to be an expert in software development or to get everything right on the first attempt: don’t hesitate to open an issue or a pull request, or simply contact us.
 
@@ -42,7 +42,7 @@ In your terminal, clone the repo on your local machine, and move into the newly
   git clone https://github.com/USERNAME/Tangelo.git
   cd Tangelo
 
-From the perspective of your local clone, your fork is called the ``origin`` remote. 
+From the perspective of your local clone, your fork is called the ``origin`` remote.
 Let's synchronize your fork with the main Tangelo repo by adding the latter as the upstream remote, and then update your local ``main`` branch:
 
 .. code-block:: shell
@@ -85,7 +85,7 @@ Every time you open a PR or push more code into an open one, several automated p
 
 
 Continuous integration
-======================
+----------------------
 
 When a pull request is created or updated, several automated processes are launched. You will find most of them in the "checks" tab of your pull request, and can look into the details. These processes check for a few things:
 
@@ -112,7 +112,7 @@ When a pull request is created or updated, several automated processes are launc
   We rely on a tool called pycodestyle. If you want to know exactly what this linting enforces and ignores, you can refer to this `file <./dev_tools/pycodestyle>`_ and `pycodestyle's documentation <https://pycodestyle.pycqa.org/en/latest/intro.html>`_.
 
 
-Developing notebooks 
-====================
+Developing notebooks
+--------------------
 
 Jupyter notebooks are great ! If you feel like making a notebook to show how to do something cool with Tangelo and educate others, don't hesitate to reach out. It counts as code, so it will go through the standard PR process and will need to meet a few requirements. The developer team has made several notebooks you can look at, for inspiration.

README.rst

@@ -47,7 +47,7 @@ published in scientific journals, co-authored by professionals from the chemical
 
 We hope to grow a healthy community around Tangelo, collaborate, and together leverage the best of what the field has to offer.
 
-- Our `release document on arXiv <https://arxiv.org/pdf/2206.12424.pdf>`_.
+- Our `release document on arXiv <https://arxiv.org/abs/2206.12424>`_.
 - Our `Sphinx documentation <http://tangelo-docs.goodchemistry.com>`_.
 - Our `examples repository <https://github.com/goodchemistryco/Tangelo-Examples>`_.
 
@@ -71,7 +71,7 @@ The easiest way to install Tangelo in your local environment. We recommend upgra
 
 .. code-block::
 
-   python -m pip install -–upgrade pip.
+   python -m pip install --upgrade pip.
    pip install tangelo-gc
 
 If you'd like to install via pip the code in a specific branch of this Github repository (let's say ``develop``)
@@ -156,7 +156,7 @@ them in whatever way your OS supports it, or even inside your python script usin
 Tutorials and examples
 ----------------------
 
-We have a `dedicated repository <https://github.com/goodchemistryco/Tangelo-Examples>`_ for examples and tutorials ! 
+We have a `dedicated repository <https://github.com/goodchemistryco/Tangelo-Examples>`_ for examples and tutorials !
 
 We wrote a number of them, and tried to provide material that doesn't just explain how to use the software, but provides insights into the complex topics of chemistry, quantum computing, and digs into the challenges we encountered in our previous hardware experiments.
 Nothing prevents users from contributing and showcasing what they have been doing with Tangelo.
@@ -192,7 +192,7 @@ find and run all tests (assuming you are in the ``tangelo`` subfolder that conta
 Contributions
 -------------
 
-Thank you very much for considering contributing to this project; we’d love to have you on board !
+Thank you very much for considering contributing to this project; we'd love to have you on board !
 You do not need to be a seasoned software developer or expert in your field to make contributions to this project: it will take various kinds of people and backgrounds to tackle the challenges that await us.
 
 However we need some guidelines and processes to ensure that we build something of quality for the community. We describe them in the `contributions <./CONTRIBUTIONS.rst>`_ file.

docs/source/CONTRIBUTIONS.rst

@@ -0,0 +1 @@
+../../CONTRIBUTIONS.rst

docs/source/TUTORIALS.rst

@@ -0,0 +1 @@
+../../TUTORIALS.rst

docs/source/conf.py

@@ -4,6 +4,9 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+from tangelo._version import __version__
+
+
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -18,11 +21,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'tangelo'
-copyright = '2022 Good Chemistry Company'
+copyright = '2023 Good Chemistry Company'
 author = 'Valentin senicourt, Alexandre Fleury, Ryan Day, James Brown'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.1'
+release = __version__
 
 
 # -- General configuration ---------------------------------------------------

docs/source/index.rst

@@ -11,6 +11,8 @@ Welcome to Tangelo's documentation!
    :caption: Contents:
 
    overview
+   TUTORIALS
+   CONTRIBUTIONS
    tangelo
 
 Indices and tables

tangelo/algorithms/variational/adapt_vqe_solver.py

@@ -135,7 +135,7 @@ def build(self):
         algorithm.
         """
 
-        # Building molecule data with a pyscf molecule.
+        # Building molecule data.
         if self.molecule:
 
             self.n_spinorbitals = self.molecule.n_active_sos

tangelo/toolboxes/circuits/qsp.py

@@ -46,7 +46,7 @@ def ham_sim_phases(tau: float, eps: float = 1.e-2, n_attempts: int = 10, method:
     try:
         import pyqsp
     except ModuleNotFoundError:
-        raise ModuleNotFoundError("pyqsp package is required to calculate QSP time-evolution phases using 'lauren' or 'tf' method.")
+        raise ModuleNotFoundError("pyqsp package is required to calculate QSP time-evolution phases using 'laurent' or 'tf' method.")
 
     from pyqsp import angle_sequence
     from pyqsp.angle_sequence import AngleFindingError

tangelo/toolboxes/qubit_mappings/hcb.py

@@ -65,7 +65,7 @@ def boson_to_qubit_mapping(bos_op):
     annihilation operators.
 
     In short, every creation operator b^{\dagger} (resp. annihilation b) are
-    mapped to X+iY strings (resp. X-iY), where X and Y are referring to the
+    mapped to X-iY strings (resp. X+iY), where X and Y are referring to the
     Pauli matrices.
 
     Args: