Skip to content

Commit 9b6b178

Browse files
committed
Update ho-to-guides examples
1 parent e5765c7 commit 9b6b178

File tree

5 files changed

+269
-10
lines changed

5 files changed

+269
-10
lines changed

doc/source/guides/ab13dd_nb.ipynb

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,17 @@
77
"source": [
88
"# ab13dd Example\n",
99
"\n",
10-
"Johannes Kaisinger, 26 July 2023"
10+
"Johannes Kaisinger, 26 July 2023\n",
11+
"\n",
12+
"The `ab13dd` calculates the L-infinity norm of a state space system.\n",
13+
"For a stable system it is equal to the H-infintiy norm."
14+
]
15+
},
16+
{
17+
"cell_type": "markdown",
18+
"metadata": {},
19+
"source": [
20+
"## Create data"
1121
]
1222
},
1323
{
@@ -89,16 +99,16 @@
8999
" \"\"\"naive implementation of bisection algorithm for H-infinity norm\n",
90100
"\n",
91101
" Args:\n",
92-
" A (_type_): _description_\n",
93-
" B (_type_): _description_\n",
94-
" C (_type_): _description_\n",
95-
" D (_type_): _description_\n",
96-
" gam_l (_type_): _description_\n",
97-
" gam_h (_type_): _description_\n",
98-
" emin (_type_): _description_\n",
102+
" A (_type_): system matrix\n",
103+
" B (_type_): input matrix\n",
104+
" C (_type_): output matrix\n",
105+
" D (_type_): feedthrough matrix\n",
106+
" gam_l (_type_): low bound for norm\n",
107+
" gam_h (_type_): upper bound for norm\n",
108+
" emin (_type_): min difference between gam_l and gam_h\n",
99109
"\n",
100110
" Returns:\n",
101-
" _type_: _description_\n",
111+
" float: norm\n",
102112
" \"\"\"\n",
103113
" gam_last_stable = None\n",
104114
" while (gam_h - gam_l) > emin:\n",

doc/source/guides/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:orphan:
2+
3+
Examples
4+
========
5+
6+
The following notebooks show some use cases for Slycot.
7+
8+
.. toctree::
9+
:maxdepth: 1
10+
11+
system_norms
12+
sysid

doc/source/guides/sy10yd_nb.ipynb

Lines changed: 227 additions & 0 deletions
Large diffs are not rendered by default.

doc/source/guides/sysid.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
:orphan:
3+
4+
System identification
5+
=====================
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
sy10yd_nb

doc/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The Slycot library is organised by chapters. Each chapter can be identified by a
4646
:hidden:
4747
:caption: 🪄 How-to guides
4848

49-
/guides/system_norms
49+
/guides/index
5050

5151
.. toctree::
5252
:maxdepth: 2

0 commit comments

Comments
 (0)