From 117372b8e6baeb8c323bde98fc016945132addd9 Mon Sep 17 00:00:00 2001 From: Hiroshi Shinaoka Date: Thu, 15 Oct 2026 09:01:00 +0900 Subject: [PATCH] docs: link into the sparse-ir ecosystem navigation - Load the shared navigation banner from spm-lab.github.io. - Point the tutorial links to the renamed sparse-ir-tutorial. - Link the ecosystem hub and SpM-lab from the README. Co-Authored-By: Claude Opus 5.5 (1M context) --- README.rst | 7 ++++++- doc/conf.py | 6 ++++++ doc/tutorial.rst | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 5bacd89..bb8227c 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,9 @@ intermediate representation of correlation functions. It provides: - basis functions and singular values are accurate to full precision - routines for sparse sampling +sparse-ir is part of the `sparse-ir ecosystem`_ (overview, history of IR and DLR, +notation, and the Julia, Rust, C and Fortran libraries), maintained by `SpM-lab`_. + Installation ------------ @@ -63,7 +66,9 @@ G(iν) = ∫₀^β dτ e^{iντ} G(τ); and G(τ) is evaluated for τ in [-β, There is also a `Julia library`_ and (currently somewhat restricted) `C library with Fortran bindings`_ available for the IR basis and sparse sampling. -.. _comprehensive tutorial: https://spm-lab.github.io/sparse-ir-tutorial-v2/ +.. _comprehensive tutorial: https://spm-lab.github.io/sparse-ir-tutorial/ +.. _sparse-ir ecosystem: https://spm-lab.github.io/sparse-ir-doc/ +.. _SpM-lab: https://spm-lab.github.io/ .. _API documentation: https://sparse-ir.readthedocs.io .. _notation page: https://spm-lab.github.io/sparse-ir-doc/src/notation.html .. _Julia library: https://github.com/SpM-lab/SparseIR.jl diff --git a/doc/conf.py b/doc/conf.py index ec7dcbe..0c1a4dc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -54,3 +54,9 @@ def get_version(): ] html_theme = "sphinx_rtd_theme" + +# Navigation banner shared by the sparse-ir documentation sites; the links are +# maintained in SpM-lab/SpM-lab.github.io. +html_js_files = [ + ("https://spm-lab.github.io/assets/ecosystem-banner.js", {"defer": "defer"}), + ] diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 39b0e0f..9209e5c 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -2,7 +2,7 @@ Getting started =============== A comprehensive introduction is available at -``_. +``_. It includes a set of self-contained notebooks for a variety of many-body applications using sparse-ir: