Skip to content

Commit b636532

Browse files
shinaokashinaoka
authored
Merge pull request #20 from SpM-lab/docs/ecosystem-nav
Link the tutorial into the sparse-ir ecosystem navigation
2 parents 51a32da + 0bf0f0a commit b636532

10 files changed

Lines changed: 80 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# sparse-ir-tutorial
22

3+
Source of the Python and Julia tutorials at <https://spm-lab.github.io/sparse-ir-tutorial/>.
4+
This repository was called `sparse-ir-tutorial-v2` until October 2026; the old URLs redirect here.
5+
Overview of the sparse-ir ecosystem: <https://spm-lab.github.io/sparse-ir-doc/>.
6+
37
## Author guideline
48

59
* In Markdown cells, use the `$$`, `$$ $$` environments for equations.

‎_config.yml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
#######################################################################################
22
# Book settings
3-
title : sparse-ir
3+
title : sparse-ir tutorial
44
author: sparse-ir developers
55
copyright: "2022"
66

77
# Information about where the book exists on the web
88
description: >-
9-
Online document for sparse-ir
9+
Python and Julia tutorials for the sparse-ir libraries
1010
1111
#######################################################################################
1212
# Execution settings
@@ -63,6 +63,14 @@ sphinx:
6363
# kernel that register_julia_kernel.jl installs.
6464
nb_kernel_rgx_aliases:
6565
"julia-.*": julia
66+
# Navigation banner shared by the sparse-ir documentation sites; the links
67+
# are maintained in SpM-lab/SpM-lab.github.io.
68+
html_js_files:
69+
- ["https://spm-lab.github.io/assets/ecosystem-banner.js", {"defer": "defer"}]
70+
# Copied verbatim into the site: redirects for pages of the v1 tutorial that
71+
# was served at this URL until 2026-10 and has no counterpart here.
72+
html_extra_path:
73+
- _extra
6674

6775
parse:
6876
myst_substitutions:

‎_extra/404.html‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!doctype html>
2+
<html lang="en"><head><meta charset="utf-8">
3+
<meta name="viewport" content="width=device-width, initial-scale=1">
4+
<title>Page not found: sparse-ir tutorial</title>
5+
<style>body{font:16px/1.6 system-ui,sans-serif;max-width:720px;margin:48px auto;padding:0 16px}</style>
6+
</head><body>
7+
<h1>Page not found</h1>
8+
<p>This page is not part of the current <a href="/sparse-ir-tutorial/">sparse-ir tutorial</a>.</p>
9+
<ul>
10+
<li>Theory pages (IR, sparse sampling, DLR, Matsubara sums) are in the
11+
<a href="https://spm-lab.github.io/sparse-ir-doc/">sparse-ir documentation</a>.</li>
12+
<li>The tutorial for sparse-ir v1 is archived at
13+
<a href="https://spm-lab.github.io/sparse-ir-tutorial-v1/">sparse-ir-tutorial-v1</a>.</li>
14+
<li>Everything else: <a href="https://spm-lab.github.io/">SpM-lab home</a>.</li>
15+
</ul>
16+
</body></html>

‎_extra/src/DLR.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!doctype html>
2+
<html lang="en"><head><meta charset="utf-8">
3+
<title>Moved</title>
4+
<link rel="canonical" href="https://spm-lab.github.io/sparse-ir-doc/src/DLR.html">
5+
<meta http-equiv="refresh" content="0; url=https://spm-lab.github.io/sparse-ir-doc/src/DLR.html">
6+
<script>location.replace("https://spm-lab.github.io/sparse-ir-doc/src/DLR.html" + location.hash);</script>
7+
</head><body>
8+
<p>This page moved to the sparse-ir documentation: <a href="https://spm-lab.github.io/sparse-ir-doc/src/DLR.html">https://spm-lab.github.io/sparse-ir-doc/src/DLR.html</a></p>
9+
</body></html>

‎_extra/src/IR_py.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!doctype html>
2+
<html lang="en"><head><meta charset="utf-8">
3+
<title>Moved</title>
4+
<link rel="canonical" href="https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html">
5+
<meta http-equiv="refresh" content="0; url=https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html">
6+
<script>location.replace("https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html" + location.hash);</script>
7+
</head><body>
8+
<p>This page moved to the sparse-ir documentation: <a href="https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html">https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html</a></p>
9+
</body></html>

‎_extra/src/magnetic_susceptibility_py.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!doctype html>
2+
<html lang="en"><head><meta charset="utf-8">
3+
<title>Moved</title>
4+
<link rel="canonical" href="https://spm-lab.github.io/sparse-ir-tutorial-v1/src/magnetic_susceptibility_py.html">
5+
<meta http-equiv="refresh" content="0; url=https://spm-lab.github.io/sparse-ir-tutorial-v1/src/magnetic_susceptibility_py.html">
6+
<script>location.replace("https://spm-lab.github.io/sparse-ir-tutorial-v1/src/magnetic_susceptibility_py.html" + location.hash);</script>
7+
</head><body>
8+
<p>This page was part of the tutorial for sparse-ir v1 and is kept in its archive: <a href="https://spm-lab.github.io/sparse-ir-tutorial-v1/src/magnetic_susceptibility_py.html">https://spm-lab.github.io/sparse-ir-tutorial-v1/src/magnetic_susceptibility_py.html</a></p>
9+
</body></html>

‎_extra/src/matsubarasum.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!doctype html>
2+
<html lang="en"><head><meta charset="utf-8">
3+
<title>Moved</title>
4+
<link rel="canonical" href="https://spm-lab.github.io/sparse-ir-doc/src/matsubarasum.html">
5+
<meta http-equiv="refresh" content="0; url=https://spm-lab.github.io/sparse-ir-doc/src/matsubarasum.html">
6+
<script>location.replace("https://spm-lab.github.io/sparse-ir-doc/src/matsubarasum.html" + location.hash);</script>
7+
</head><body>
8+
<p>This page moved to the sparse-ir documentation: <a href="https://spm-lab.github.io/sparse-ir-doc/src/matsubarasum.html">https://spm-lab.github.io/sparse-ir-doc/src/matsubarasum.html</a></p>
9+
</body></html>

‎_extra/src/sparse_sampling_py.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!doctype html>
2+
<html lang="en"><head><meta charset="utf-8">
3+
<title>Moved</title>
4+
<link rel="canonical" href="https://spm-lab.github.io/sparse-ir-doc/src/sparse_sampling_py.html">
5+
<meta http-equiv="refresh" content="0; url=https://spm-lab.github.io/sparse-ir-doc/src/sparse_sampling_py.html">
6+
<script>location.replace("https://spm-lab.github.io/sparse-ir-doc/src/sparse_sampling_py.html" + location.hash);</script>
7+
</head><body>
8+
<p>This page moved to the sparse-ir documentation: <a href="https://spm-lab.github.io/sparse-ir-doc/src/sparse_sampling_py.html">https://spm-lab.github.io/sparse-ir-doc/src/sparse_sampling_py.html</a></p>
9+
</body></html>

‎_toc.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ parts:
66
#- file: src/migration.md
77
- caption: Basic theory
88
chapters:
9+
- url: https://spm-lab.github.io/sparse-ir-doc/
10+
title: sparse-ir ecosystem overview
11+
- url: https://spm-lab.github.io/sparse-ir-doc/src/history_comparison.html
12+
title: "IR, DLR and MiniPole: history and comparison"
913
- url: https://spm-lab.github.io/sparse-ir-doc/src/notation.html
1014
title: Notation and conventions
1115
- url: https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html

‎index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Please refer to [the migration guide](src/migration.md) for details.
1818

1919
This online document provides comprehensive tutorials of the Python library [sparse-ir](https://github.com/SpM-lab/sparse-ir) library and Julia library [SparseIR.jl](https://github.com/SpM-lab/SparseIR.jl).
2020

21-
**For information on the whole sparse-ir ecosystem (including Rust, C-API, and Fortran bindings), please refer to [the sparse-ir documentation](https://spm-lab.github.io/sparse-ir-doc).**
21+
**This tutorial is part of the [sparse-ir ecosystem](https://spm-lab.github.io/sparse-ir-doc/).** Start there for an overview of the libraries (including Rust, the C API and the Fortran bindings) and for the [history and comparison of IR, DLR and MiniPole](https://spm-lab.github.io/sparse-ir-doc/src/history_comparison.html). The Rust versions of these tutorials are in the [Rust guide](https://spm-lab.github.io/sparse-ir-rs/).
2222

2323
The tutorials follow the notation defined on the [notation and conventions page](https://spm-lab.github.io/sparse-ir-doc/src/notation.html) of the sparse-ir documentation.
2424
The basic theory is explained there as well: the [intermediate representation](https://spm-lab.github.io/sparse-ir-doc/src/IR_py.html), [sparse sampling](https://spm-lab.github.io/sparse-ir-doc/src/sparse_sampling_py.html), the [discrete Lehmann representation](https://spm-lab.github.io/sparse-ir-doc/src/DLR.html), and [summation over the Matsubara axis](https://spm-lab.github.io/sparse-ir-doc/src/matsubarasum.html).

0 commit comments

Comments
 (0)