Skip to content

Document covariance features #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
The9Cat wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Document covariance features #41

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
708b847
Begin documenting the covariance computation
Dec 24, 2025
a587ca5
Preliminary implementation of covariance documentation
Dec 24, 2025
f31373f
A complete draft of the covariance documentation
Dec 25, 2025
6919716
Add warning about bug fix to main
Dec 26, 2025
ae4e95a
Put T=0, 20 panels on the same y scale
Dec 26, 2025
de7f6b9
Update index.rst
The9Cat Dec 28, 2025
b8da92d
Update index.rst
The9Cat Dec 28, 2025
262aac9
Some minor copy editing
Dec 29, 2025
7382d48
Merge branch 'covariance' of github.com:EXP-code/EXP-docs into covari…
Dec 29, 2025
4eff92e
A few more typo fixes
Dec 30, 2025
24bd781
Describe axes in caption
Dec 30, 2025
d0a09fa
Remove warning message
Dec 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@
# -- project information -----------------------------------------------------
#
project = 'EXP'
copyright = '2023-2025, EXP-code collaboration'
copyright = '2023-2026, EXP-code collaboration'
author = 'EXP-code collaboration'
release = '0.172'
release = '0.173'
version = '7.x'

# -- General configuration ---------------------------------------------------
Expand Down
8 changes: 7 additions & 1 deletion index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ EXP concepts
topics/centering
topics/yamlconfig
topics/howtosim
topics/covariance

These topics provide some background detail on the software and
mathematics used in EXP.
Expand Down Expand Up @@ -122,6 +123,11 @@ mathematics used in EXP.
:doc:`topics/howtosim`
A guide for running EXP simulations

:doc:`topics/covariance
Comment thread
The9Cat marked this conversation as resolved.
Outdated
How to think about and compute significance of coefficients using
exp and pyEXP


.. toctree::
:caption: Frequently Asked Questions (FAQ)

Expand Down Expand Up @@ -162,7 +168,7 @@ How to solve specific problems

:doc:`topics/visualizing-fields`
Learn how to convert your coefficients to physical fields and
visualize them with Python and pyEXP
visualize them with Python and pyEXP
Comment thread
The9Cat marked this conversation as resolved.
Outdated

:doc:`topics/make-movies`
Make some movies from your fields in Python
Expand Down
Loading