Skip to content

Commit d7d53ec

Browse files
timmenstimmens
authored
Add videos to documentation (#481)
1 parent 55f05ca commit d7d53ec

File tree

8 files changed

+144
-14
lines changed

8 files changed

+144
-14
lines changed

‎.gitignore

+3-3
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ instance/
7373
docs/_build/
7474
docs/build/
7575
docs/source/_build/
76-
docs/source/getting_started/*.db
77-
docs/source/getting_started/*.db-shm
78-
docs/source/getting_started/*.db-wal
76+
docs/source/**/*.db
77+
docs/source/**/*.db-shm
78+
docs/source/**/*.db-wal
7979
docs/source/refs.bib.bak
8080

8181
# PyBuilder

‎docs/source/_static/images/video.svg

+5
Loading

‎docs/source/conf.py

-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@
4747
"myst_nb",
4848
"sphinxcontrib.bibtex",
4949
"sphinx_panels",
50-
"sphinx_copybutton",
5150
]
5251

5352
myst_enable_extensions = [

‎docs/source/development/eep-00-governance-model.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
| | `Hans-Martin von Gaudecker <https://github.com/hmgaudecker>`_, |
1010
| | `Annica Gehlen <https://github.com/amageh>`_, |
1111
| | `Sebastian Gsell <https://github.com/segsell>`_, |
12-
| | `Tim Mensinger <https://github.com/timmens>_, |
12+
| | `Tim Mensinger <https://github.com/timmens>`_, |
1313
| | `Mariam Petrosyan <https://github.com/mpetrosian>`_, |
1414
| | `Tobias Raabe <https://github.com/tobiasraabe>`_, |
1515
| | `Klara Röhrl <https://github.com/roecla>`_ |

‎docs/source/getting_started/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,21 @@ reference for more experienced users.
6767
</div>
6868
</a>
6969
</div>
70+
<div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
71+
<a href="../videos.html" id="index-link">
72+
<div class="card text-center intro-card shadow" style="width: 100%;">
73+
<img src="../_static/images/video.svg" class="card-img-top"
74+
alt="video icon" height="60"
75+
>
76+
<div class="card-body flex-fill">
77+
<h5 class="card-title">Videos</h5>
78+
<p class="card-text">
79+
Collection of tutorials, talks, and screencasts on estimagic.
80+
</p>
81+
</div>
82+
</div>
83+
</a>
84+
</div>
7085
</div>
7186
</div>
7287
```

‎docs/source/how_to_guides/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,21 @@ an introduction to its basic functionality, check out our tutorials.
6767
</div>
6868
</a>
6969
</div>
70+
<div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
71+
<a href="../videos.html" id="index-link">
72+
<div class="card text-center intro-card shadow" style="width: 100%;">
73+
<img src="../_static/images/video.svg" class="card-img-top"
74+
alt="video icon" height="60"
75+
>
76+
<div class="card-body flex-fill">
77+
<h5 class="card-title">Videos</h5>
78+
<p class="card-text">
79+
Collection of tutorials, talks, and screencasts on estimagic.
80+
</p>
81+
</div>
82+
</div>
83+
</a>
84+
</div>
7085
</div>
7186
</div>
7287
```

‎docs/source/index.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,21 @@ For a complete introduction to optimization in estimagic, check out the
109109
</div>
110110
</a>
111111
</div>
112+
<div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
113+
<a href="videos.html" id="index-link">
114+
<div class="card text-center intro-card shadow" style="width: 100%;">
115+
<img src="_static/images/video.svg" class="card-img-top"
116+
alt="video icon" height="60"
117+
>
118+
<div class="card-body flex-fill">
119+
<h5 class="card-title">Videos</h5>
120+
<p class="card-text">
121+
Collection of tutorials, talks, and screencasts on estimagic.
122+
</p>
123+
</div>
124+
</div>
125+
</a>
126+
</div>
112127
</div>
113128
</div>
114129
```
@@ -122,6 +137,9 @@ getting_started/index
122137
how_to_guides/index
123138
explanations/index
124139
reference_guides/index
140+
development/index
141+
videos
142+
algorithms
125143
```
126144

127145
## Highlights
@@ -163,15 +181,6 @@ reference_guides/index
163181
164182
**Useful links for search:** {ref}`genindex` | {ref}`modindex` | {ref}`search`
165183
166-
```{toctree}
167-
---
168-
hidden: true
169-
maxdepth: 1
170-
---
171-
development/index
172-
algorithms
173-
```
174-
175184
[how to do multistart]: how_to_guides/optimization/how_to_do_multistart_optimizations
176185
[how to use logging]: how_to_guides/optimization/how_to_use_logging
177186
[msm tutorial]: getting_started/estimation/first_msm_estimation_with_estimagic

‎docs/source/videos.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
(list_of_videos)=
2+
3+
# Videos
4+
5+
Check out our tutorials, talks and screencasts about estimagic.
6+
7+
## Talks and tutorials
8+
9+
### EuroSciPy 2023 (Talk)
10+
11+
```{raw} html
12+
<iframe
13+
src="https://www.youtube.com/embed/5xYn0v1zEsY"
14+
style="width: 100%; aspect-ratio: 16 / 9;"
15+
allowfullscreen>
16+
</iframe>
17+
```
18+
19+
### EuroSciPy 2023 (Tutorial)
20+
21+
```{raw} html
22+
<iframe
23+
src="https://www.youtube.com/embed/LQo5NDFKH1Q"
24+
style="width: 100%; aspect-ratio: 16 / 9;"
25+
allowfullscreen>
26+
</iframe>
27+
```
28+
29+
### SciPy 2022 (Tutorial)
30+
31+
```{raw} html
32+
<iframe
33+
src="https://www.youtube.com/embed/ftlw0rARrtI"
34+
style="width: 100%; aspect-ratio: 16 / 9;"
35+
allowfullscreen>
36+
</iframe>
37+
```
38+
39+
## Screencasts
40+
41+
The screencasts are part of the course _Effective Programming Practices for Economists_,
42+
taught at the University of Bonn by
43+
[Hans-Martin von Gaudecker](https://www.wiwi.uni-bonn.de/gaudecker/), and previously
44+
also [Janoś Gabler](https://github.com/janosg). You can find all screencasts of the
45+
course on the
46+
[course webite](https://effective-programming-practices.vercel.app/landing-page.html).
47+
Here, we show the screencasts about numerical optimization and estimagic.
48+
49+
### Introduction to numerical optimization
50+
51+
```{raw} html
52+
<iframe
53+
src="https://www.youtube.com/embed/hOZueB4Cn1Y"
54+
style="width: 100%; aspect-ratio: 16 / 9;"
55+
allowfullscreen>
56+
</iframe>
57+
```
58+
59+
### Using estimagic’s minimize and maximize
60+
61+
```{raw} html
62+
<iframe
63+
src="https://www.youtube.com/embed/QqTGE3nq0q8"
64+
style="width: 100%; aspect-ratio: 16 / 9;"
65+
allowfullscreen>
66+
</iframe>
67+
```
68+
69+
### Visualizing optimizer histories
70+
71+
```{raw} html
72+
<iframe
73+
src="https://www.youtube.com/embed/wQWWW8rlxmY"
74+
style="width: 100%; aspect-ratio: 16 / 9;"
75+
allowfullscreen>
76+
</iframe>
77+
```
78+
79+
### Choosing optimization algorithms
80+
81+
```{raw} html
82+
<iframe
83+
src="https://www.youtube.com/embed/tJ7Xba3wcxY"
84+
style="width: 100%; aspect-ratio: 16 / 9;"
85+
allowfullscreen>
86+
</iframe>
87+
```

0 commit comments

Comments
 (0)