[doc] Tutorails update, BlockSparseSolver printout cleanup

Author: HugoStrand

README.md

@@ -7,7 +7,7 @@ added regularly. Until a stable release is announced, use at your own risk!
 
 ### Documentation
 
-For documentation and installation instructions see [triqs.github.io/xca](https://triqs.github.io/xca).
+For documentation and installation instructions see [triqs.github.io/xca/tree/block_sparse](https://triqs.github.io/xca/tree/block_sparse).
 
 ### References and citation
 

doc/about.rst

@@ -4,20 +4,20 @@
 About
 *****
 
-The TRIQS Sum-Of-Exponentials bold HYBridization expansion impurity solver was originally developed by Z. Huang, J. Kaye, and H. U.R. Strand. We thank N. Wentzell for contributions, support and guidance in using the `TRIQS library <https://github.com/TRIQS/triqs>`_ and its related packages.
+The TRIQS arbitrary Crossing Approximation (XCA) impurity solver has been developed by F. Rilloraza, Z. Huang, J. Kaye, and H. U.R. Strand. We thank N. Wentzell for contributions, support and guidance in using the `TRIQS library <https://github.com/TRIQS/triqs>`_ and its related packages.
 
-For compact representation of imaginary time propagators we use the C++ implementation of the Discrete Lehmann Representation provided by the ` ``cppdlr`` library <github.com/flatironinstitute/cppdlr/>`_. The TRIQS application structure is inherited from the `app4triqs <https://github.com/TRIQS/app4triqs>`_ framework.
+For compact representation of imaginary time propagators we use the C++ implementation of the Discrete Lehmann Representation provided by the `cppdlr library <github.com/flatironinstitute/cppdlr/>`_. The TRIQS application structure is inherited from the `app4triqs framework. <https://github.com/TRIQS/app4triqs>`_
 
 
 License
 =======
 
-The TPRF application is published under the `GNU General Public License, version 3. <http://www.gnu.org/licenses/gpl.html>`_
+The ``triqs_xca`` application is published under the `GNU General Public License, version 3. <http://www.gnu.org/licenses/gpl.html>`_
 
-Note that it implies that applications using TPRF must also be GPL.
+Note that it implies that applications using ``triqs_xca`` must also be GPL.
 
 
 Disclaimer
 ==========
 
-The program is provided as is, i.e. WITHOUT ANY WARRANTY of any kind, as stated in the license. In particular, its authors and contributors will take no responsability for any possible bugs or any improper use of these programs, including those resulting in incorrect scientific publications.
+The program is provided as is, i.e. WITHOUT ANY WARRANTY of any kind, as stated in the license. In particular, its authors and contributors will take no responsibility for any possible bugs or any improper use of these programs, including those resulting in incorrect scientific publications.

doc/background/ppsc.rst

@@ -9,15 +9,17 @@ In the bold formulation :math:`G(\tau)` is self-consistently computed using the
 
 .. math::
 
-   (1 - G_0 \ast \Sigma \ast) G = G_0 \\
+   (1 - G_0 \ast ( \Sigma + \eta) \ast) G = G_0 \\
    
 where :math:`G_0(\tau)` is the atomic many-body propagator and :math:`\Sigma(\tau)` is the pseudo-particle self-energy truncated at a finite expansion order :math:`n` in the hybridization function :math:`\Delta(\tau)`.
 
 .. math::
 
    \Sigma[G] = \Sigma_1[G] + \Sigma_2[G] + \dots + \Sigma_n[G]
 
-Once convergence is reached physical response functions like the single particle Green's function :math:`g(\tau) = \langle \mathcal{T} c(\tau) c^\dagger(0) \rangle` can be evaluted by a separate diagrammatic series (similar to :math:`\Sigma`).
+Once convergence is reached physical response functions like the single particle Green's function :math:`g(\tau) = -\langle \mathcal{T} c(\tau) c^\dagger(0) \rangle` can be evaluated by a separate diagrammatic series (similar to :math:`\Sigma`).
+
+To stabilize the self consistency the pseudo particle Green's function :math:`G(\tau)` is normalized in between each new evaluaton of the self-energy :math:`\Sigma` by enforcing that :math:`\textrm{Tr}[G(\beta)] = -1` by tuning the pseudo particle chemical potential :math:`\eta` in the Dyson equation. This is essential to avoid numerical overflow.
 
 The ``triqs_xca`` solver implements the bold hybridization expansion using the Discrete Lehmann Representation (DLR) [#dlr]_ [#cppdlr]_ for compact representation of propagators in imaginary time :math:`\tau` and a separate hybridization function compression approach [#xca]_ (based on the famous AAA algorithm) to evaluate the diagram series for :math:`\Sigma` with lower computational complexity than standard quadrature integration. [#dlrhyb]_
 

doc/conf.py.in

@@ -57,7 +57,7 @@ rst_epilog = """
 version = version,
 )
 
-copyright = '2022-2025 Z. Huang, H. U.R. Strand, The Simons Foundation, authors: Z. Huang, H. U.R. Strand, J. Kaye, N. Wentzell'
+copyright = '2022-2026 H. U.R. Strand, Z. Huang, F. Rilloraza, The Simons Foundation, authors: J. Kaye, N. Wentzell'
 
 mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=default"
 templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates']

doc/index.rst

@@ -1,22 +1,22 @@
 .. _welcome:
 
-The TRIQS Sum-Of-Exponentials bold HYBridization expansion impurity solver (triqs_xca)
+The TRIQS arbitrary Crossing Approximation (XCA) impurity solver
 *********
 
-.. sidebar:: triqs_xca |PROJECT_VERSION|
+.. sidebar:: triqs_xca/block_sparse |PROJECT_VERSION|
 
-   This is the homepage of triqs_xca |PROJECT_VERSION|.
+   This is the homepage of ``triqs_xca/block_sparse`` |PROJECT_VERSION|.
    For changes see the :doc:`changelog page <ChangeLog>`.
 
       .. image:: _static/logo_github.png
          :width: 75%
          :align: center
-         :target: https://github.com/triqs/xca
+         :target: https://github.com/triqs/xca/tree/block_sparse
 
 
-The TRIQS Sum-Of-Exponentials bold HYBridization expansion impurity solver (triqs_xca) can solve generic multiband Anderson impurity problems approximately by perturbative expansion in the coupling to the environment (a.k.a. the hybridization function :math:`\Delta(\tau)`).
+The TRIQS arbitrary Crossing Approximation (**XCA**) impurity solver ``triqs_xca`` can solve generic multiband Anderson impurity problems approximately by perturbative expansion in the coupling to the environment (a.k.a. the hybridization function :math:`\Delta(\tau)`).
 
-This implementation is leveraging the sum-of-exponentials (SOE) trick to acheive parametrically better computational complexity compared to direct integration and uses the Discrete Lehmann Representation (DLR) for representing response functions.
+This implementation is leveraging the sum-of-exponentials (SOE) trick to achieve parametrically better computational complexity compared to direct integration and uses the Discrete Lehmann Representation (DLR) for representing response functions.
 
 Learn how to use triqs_xca in the :ref:`documentation`.
 
@@ -31,8 +31,8 @@ We kindly ask you to cite the following method papers when using triqs_xca in yo
 .. [#cppdlr] `J. Kaye, H. U.R. Strand, N. Wentzell, J. Open Source Softw., 9(100), 6297, (2024) <https://doi.org/10.21105/joss.06297>`_
 .. [#dlr] `J. Kaye, K. Chen, O. Parcollet, Phys. Rev. B 105, 235115 (2021) <https://doi.org/10.1103/PhysRevB.105.235115>`_
 
-Note that this application uses the TRIQS library please also see its `citation page. <https://triqs.github.io/triqs/latest/about.html#citation>`_
-
+Note that this application uses the TRIQS library, please also see its `citation page <https://triqs.github.io/triqs/latest/about.html#citation>`_,
+as well as the Adapol package, see its `citation page. <https://flatironinstitute.github.io/adapol/latest/index.html#references>`_
 
 .. toctree::
    :maxdepth: 2

doc/install.rst

@@ -11,12 +11,11 @@ Compiling xca from source
 Prerequisites
 -------------
 
-#. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instruction <triqslibs:triqs_install>`.
+#. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instructions. <triqslibs:triqs_install>`   
+   We are currently depending on the ``unstable`` development branch of TRIQS that has to be compiled from source. (*Note that the packaged versions of TRIQS are not supported.*)
    In the following, we assume that TRIQS is installed in the directory ``path_to_triqs``.
 
-   We are currently depending on the `unstable` development branch of TRIQS that has to be compiled from source. (Note that the packaged versions of TRIQS are not supported.)
-   
-#. The `adapol <https://github.com/flatironinstitute/adapol>`_ package (Adaptive Pole Fitting for Quantum Many-Body Physics) has to be installed on the `triqs_xca` branch. This can be achieved using a local `pip` install, e.g.::
+#. The `Adapol <https://github.com/flatironinstitute/adapol>`_ package (Adaptive Pole Fitting for Quantum Many-Body Physics) has to be installed on the ``triqs_xca`` branch. This can be achieved using a local ``pip`` install, e.g.::
 
     $ git clone git@github.com:flatironinstitute/adapol.git --branch triqs_xca
     $ python -m pip install -e ./adapol
@@ -25,7 +24,7 @@ Prerequisites
 
     $ python -c "import pyed.TriqsExactDiagonalization"
 
-.. note:: The `pyed` python module has to be installed manually. Trying to install it using `pip` will not work since there is another python module with the same name (doing something completely different) registered in the PIP package index.
+.. note:: The ``pyed`` python module has to be installed manually. Trying to install it using ``pip`` will not work since there is another python module with the same name (doing something completely different) registered in the PIP package index.
 
 Installation steps
 ------------------
@@ -64,7 +63,7 @@ To use a particular version, go into the directory with the sources, and look at
 
 Checkout the version of the code that you want::
 
-     $ git checkout 2.1.0
+     $ git checkout block_sparse
 
 and follow steps 2 to 4 above to compile the code.
 
@@ -78,11 +77,13 @@ The compilation of ``xca`` can be configured using CMake-options::
 +-----------------------------------------------------------------+-----------------------------------------------+
 | Options                                                         | Syntax                                        |
 +=================================================================+===============================================+
-| Specify an installation path other than path_to_triqs           | -DCMAKE_INSTALL_PREFIX=path_to_xca         |
+| Specify an installation path other than path_to_triqs           | -DCMAKE_INSTALL_PREFIX=path_to_xca            |
 +-----------------------------------------------------------------+-----------------------------------------------+
 | Build in Debugging Mode                                         | -DCMAKE_BUILD_TYPE=Debug                      |
 +-----------------------------------------------------------------+-----------------------------------------------+
 | Disable testing (not recommended)                               | -DBuild_Tests=OFF                             |
 +-----------------------------------------------------------------+-----------------------------------------------+
 | Build the documentation                                         | -DBuild_Documentation=ON                      |
 +-----------------------------------------------------------------+-----------------------------------------------+
+| Update the Python bindings (developers only)                    | -DUpdate_Python_Bindings=ON                   |
++-----------------------------------------------------------------+-----------------------------------------------+