Skip to content

Commit 834e3ab

Browse files
committed
docs: integrate gallery into Sphinx site
Add Gallery card to the landing page, register gallery/index in the main toctree, and exclude the three gallery notebooks from notebook execution (each runs hundreds of TDS scenarios).
1 parent 7e87b5b commit 834e3ab

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

docs/source/_html_landing.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ANDES is an open-source Python library for power system modeling, computation, a
1010

1111
----
1212

13-
.. grid:: 1 2 2 2
13+
.. grid:: 1 2 3 3
1414
:gutter: 3
1515

1616
.. grid-item-card:: Tutorials
@@ -19,6 +19,12 @@ ANDES is an open-source Python library for power system modeling, computation, a
1919

2020
Complete learning path from installation through advanced analysis: power flow, time-domain simulation, eigenvalue analysis, parameter sweeps, and contingency studies.
2121

22+
.. grid-item-card:: Gallery
23+
:link: gallery/index
24+
:link-type: doc
25+
26+
Research-oriented application examples: forced oscillation analysis, frequency stability under low inertia, ML-based security assessment, and more.
27+
2228
.. grid-item-card:: Modeling Guide
2329
:link: modeling/index
2430
:link-type: doc

docs/source/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@
5252
nb_execution_excludepatterns = [
5353
'verification/*', # Skip verification notebooks (long-running)
5454
'tutorials/15-reinforcement-learning.ipynb', # Requires gymnasium (rl extra)
55+
'gallery/forced-oscillation.ipynb', # WECC 179-bus multi-stage TDS (long-running)
56+
'gallery/low-inertia-freq.ipynb', # WECC 179-bus 4 scenarios (long-running)
57+
'gallery/critical-clearing-time.ipynb', # 300 TDS scenarios via reinit (long-running)
5558
]
5659
nb_merge_streams = True # Merge stdout/stderr into single output
5760

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ ANDES Documentation
1111

1212
about
1313
tutorials/index
14+
gallery/index
1415
modeling/index
1516
reference/index
1617
verification/index

0 commit comments

Comments
 (0)