Skip to content

Commit

Permalink
docs: remove interactivity
Browse files Browse the repository at this point in the history
In html, interactivity is not straightforward.
For simplicity remove all interactive features in the documentation.
  • Loading branch information
nicrie committed Jul 30, 2023
1 parent 33d040b commit 6e99b8e
Show file tree
Hide file tree
Showing 11 changed files with 545 additions and 227 deletions.
Binary file modified docs/auto_examples/auto_examples_jupyter.zip
Binary file not shown.
Binary file modified docs/auto_examples/auto_examples_python.zip
Binary file not shown.
137 changes: 0 additions & 137 deletions docs/benefits.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
# documentation.
#
html_theme_options = {
"show_nav_level": 2,
"show_nav_level": 1,
"icon_links": [
{
# Label for this link
Expand Down
1 change: 0 additions & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ dependencies:
- seaborn
- cartopy
- ipython
- ipywidgets
- pip:
- pydata-sphinx-theme
- sphinx-gallery
Expand Down
328 changes: 327 additions & 1 deletion docs/model_pca.ipynb

Large diffs are not rendered by default.

74 changes: 66 additions & 8 deletions docs/models.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,71 @@
Models
---------
.. _methods:

======================
Methods
======================

.. toctree::
:maxdepth: 3
:hidden:

model_pca
model_rpca
model_cpca
Core Models
-----------------

The supported models in ``xeofs`` currently include:

.. grid:: 2

.. grid-item-card:: EOF Analysis
:link: model_pca
:link-type: doc


Unveils dominant patterns of variabililty in your data.

.. grid-item-card:: Maximum Covariance Analysis (MCA)
:link: model_mca
:link-type: doc

Uncovers co-varying patterns between two sets of data.


Enhanced Interpretability
---------------------------

.. grid:: 2

.. grid-item-card:: Varimax Rotation
:link: model_rpca
:link-type: doc

Breaks orthogonal constrain for easier interpretation.

.. grid-item-card:: Promax Rotation
:link: model_rpca
:link-type: doc

Allow oblique rotation to identify correlated patterns.


Advanced Techniques
--------------------

.. grid:: 2

.. grid-item-card:: Complex/Hilbert Extensions
:link: model_cpca
:link-type: doc

Identify oscillatory patterns in your data.



Model Validation
--------------------

.. grid:: 2

.. grid-item-card:: Bootstrapper
:link: bootstrapper
:link-type: doc

Bootstrap your model to assess its robustness.


Loading

0 comments on commit 6e99b8e

Please sign in to comment.