From 3cd83a3511ae63bbc7096fde3944922238e74a96 Mon Sep 17 00:00:00 2001 From: peekxc Date: Wed, 4 Dec 2024 12:40:07 -0500 Subject: [PATCH] Updated docs --- docs/_quarto.yml | 30 +- docs/_sidebar.yml | 26 +- docs/_site/basic/install.html | 125 +- docs/_site/basic/integration.html | 364 +++- docs/_site/basic/quickstart.html | 273 ++- docs/_site/guides/intro.html | 1430 +++++++++++++ docs/_site/guides/intro_trace.html | 1807 +++++++++++++++++ docs/_site/guides/matrix_functions.html | 1661 +++++++++++++++ docs/_site/imate_compare.html | 1230 +++++++++++ docs/_site/index.html | 125 +- docs/_site/quickstart.html | 1416 +++++++++++++ docs/_site/reference/ConfidenceCriterion.html | 49 +- .../_site/reference/ConvergenceCriterion.html | 8 +- docs/_site/reference/Covariance.html | 1226 +++++++++++ docs/_site/reference/Estimator.html | 49 +- docs/_site/reference/MatrixFunction.html | 134 +- docs/_site/reference/confidence_interval.html | 1105 ++++++++++ docs/_site/reference/diag.html | 90 +- docs/_site/reference/hutch.html | 112 +- docs/_site/reference/index.html | 136 +- docs/_site/reference/quadrature.html | 1249 ++++++++++++ docs/_site/reference/xtrace.html | 49 +- docs/_site/search.json | 462 ++++- docs/_site/table.html | 1245 ++++++++++++ docs/basic/quickstart.qmd | 39 +- docs/guides/intro_trace.qmd | 300 +++ docs/{basic => }/imate_compare.qmd | 13 +- docs/index.qmd | 16 - docs/objects.json | 2 +- docs/reference/ConfidenceCriterion.qmd | 10 +- docs/reference/ConvergenceCriterion.qmd | 2 +- docs/reference/Covariance.qmd | 50 + docs/reference/Estimator.qmd | 6 +- docs/reference/MatrixFunction.qmd | 6 - docs/reference/confidence_interval.qmd | 7 + docs/reference/diag.qmd | 15 +- docs/reference/hutch.qmd | 2 +- docs/reference/index.qmd | 17 +- docs/reference/quadrature.qmd | 51 + docs/reference/xtrace.qmd | 35 +- docs/references.bib | 34 + docs/table.qmd | 24 + src/primate/diagonal.py | 3 +- src/primate/integrate.py | 2 +- src/primate/operators.py | 3 - src/primate/plotting.py | 73 +- src/primate/trace.py | 2 +- tests/test_trace.py | 9 +- 48 files changed, 14542 insertions(+), 580 deletions(-) create mode 100644 docs/_site/guides/intro.html create mode 100644 docs/_site/guides/intro_trace.html create mode 100644 docs/_site/guides/matrix_functions.html create mode 100644 docs/_site/imate_compare.html create mode 100644 docs/_site/quickstart.html create mode 100644 docs/_site/reference/Covariance.html create mode 100644 docs/_site/reference/confidence_interval.html create mode 100644 docs/_site/reference/quadrature.html create mode 100644 docs/_site/table.html create mode 100644 docs/guides/intro_trace.qmd rename docs/{basic => }/imate_compare.qmd (69%) create mode 100644 docs/reference/Covariance.qmd create mode 100644 docs/reference/confidence_interval.qmd create mode 100644 docs/reference/quadrature.qmd create mode 100644 docs/references.bib create mode 100644 docs/table.qmd diff --git a/docs/_quarto.yml b/docs/_quarto.yml index fa710fc..80bf7a4 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -45,8 +45,10 @@ quartodoc: package: lanczos - name: rayleigh_ritz package: lanczos - - name: lanczos_quadrature - package: quadrature + - title: Integrate + contents: + - name: quadrature + package: integrate - title: Trace contents: - name: hutch @@ -104,8 +106,10 @@ quartodoc: package: estimators - title: Stats contents: - - stats.Covariance - - stats.confidence_interval + - name: Covariance + package: stats + - name: confidence_interval + package: stats sidebar: file: "_sidebar.yml" search: true @@ -115,14 +119,24 @@ quartodoc: contents: - href: index.qmd text: Overview - - text: Quickstart - href: basic/quickstart.qmd + - href: table.qmd + text: Table of matrix functions + - text: Comparison to *imate* + href: imate_compare.qmd - section: Basics contents: - text: Installing href: basic/install.qmd - - text: Comparison to *imate* - href: basic/imate_compare.qmd + - text: Integration + href: basic/integration.qmd + - text: Quickstart + href: basic/quickstart.qmd + - section: Guides + contents: + - text: Introduction + href: guides/intro_trace.qmd + - text: Matrix functions + href: guides/matrix_functions.qmd - section: "API Reference" contents: - "{{ contents }}" diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml index 6ff6b79..814be76 100644 --- a/docs/_sidebar.yml +++ b/docs/_sidebar.yml @@ -5,21 +5,33 @@ website: contents: - href: index.qmd text: Overview - - href: basic/quickstart.qmd - text: Quickstart + - href: table.qmd + text: Table of matrix functions + - href: imate_compare.qmd + text: Comparison to *imate* - contents: - href: basic/install.qmd text: Installing - - href: basic/imate_compare.qmd - text: Comparison to *imate* + - href: basic/integration.qmd + text: Integration + - href: basic/quickstart.qmd + text: Quickstart section: Basics + - contents: + - href: guides/intro_trace.qmd + text: Introduction + - href: guides/matrix_functions.qmd + text: Matrix functions + section: Guides - contents: - reference/index.qmd - contents: - reference/lanczos.qmd - reference/rayleigh_ritz.qmd - - reference/lanczos_quadrature.qmd section: Lanczos + - contents: + - reference/quadrature.qmd + section: Integrate - contents: - reference/hutch.qmd - reference/hutchpp.qmd @@ -50,8 +62,8 @@ website: - reference/KneeCriterion.qmd section: Estimators - contents: - - reference/stats.Covariance.qmd - - reference/stats.confidence_interval.qmd + - reference/Covariance.qmd + - reference/confidence_interval.qmd section: Stats section: API Reference id: reference diff --git a/docs/_site/basic/install.html b/docs/_site/basic/install.html index 74b4300..6197c54 100644 --- a/docs/_site/basic/install.html +++ b/docs/_site/basic/install.html @@ -64,8 +64,8 @@ - - + + @@ -103,6 +103,7 @@ "search-label": "Search" } } + @@ -179,6 +180,18 @@ Overview + +
  • +
    + + Table of matrix functions +
    +
    • +
  • +
    + + Comparison to imate +
  • @@ -197,8 +210,14 @@
  • - - Comparison to imate + + Integration +
    +
    • +
  • +
    + + Quickstart
    • @@ -206,7 +225,7 @@
  • - API Reference + Guides @@ -214,19 +233,42 @@ +
    • +
  • +
    + + API Reference + + + +
    +