diff --git a/.gitignore b/.gitignore index 3c9d24c11..500939250 100644 --- a/.gitignore +++ b/.gitignore @@ -73,9 +73,9 @@ instance/ docs/_build/ docs/build/ docs/source/_build/ -docs/source/getting_started/*.db -docs/source/getting_started/*.db-shm -docs/source/getting_started/*.db-wal +docs/source/**/*.db +docs/source/**/*.db-shm +docs/source/**/*.db-wal docs/source/refs.bib.bak # PyBuilder diff --git a/docs/source/_static/images/video.svg b/docs/source/_static/images/video.svg new file mode 100644 index 000000000..b3cd0d87c --- /dev/null +++ b/docs/source/_static/images/video.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index 8d7a6a3c8..71c862d1b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -47,7 +47,6 @@ "myst_nb", "sphinxcontrib.bibtex", "sphinx_panels", - "sphinx_copybutton", ] myst_enable_extensions = [ diff --git a/docs/source/development/eep-00-governance-model.md b/docs/source/development/eep-00-governance-model.md index acbb3bf90..7cc215c7d 100644 --- a/docs/source/development/eep-00-governance-model.md +++ b/docs/source/development/eep-00-governance-model.md @@ -9,7 +9,7 @@ | | `Hans-Martin von Gaudecker `_, | | | `Annica Gehlen `_, | | | `Sebastian Gsell `_, | -| | `Tim Mensinger _, | +| | `Tim Mensinger `_, | | | `Mariam Petrosyan `_, | | | `Tobias Raabe `_, | | | `Klara Röhrl `_ | diff --git a/docs/source/getting_started/index.md b/docs/source/getting_started/index.md index 3c78d7e34..29ab42321 100644 --- a/docs/source/getting_started/index.md +++ b/docs/source/getting_started/index.md @@ -67,6 +67,21 @@ reference for more experienced users. +
+ +
+ video icon +
+
Videos
+

+ Collection of tutorials, talks, and screencasts on estimagic. +

+
+
+ +
``` diff --git a/docs/source/how_to_guides/index.md b/docs/source/how_to_guides/index.md index 5d39ae692..49d533c2f 100644 --- a/docs/source/how_to_guides/index.md +++ b/docs/source/how_to_guides/index.md @@ -67,6 +67,21 @@ an introduction to its basic functionality, check out our tutorials. +
+ +
+ video icon +
+
Videos
+

+ Collection of tutorials, talks, and screencasts on estimagic. +

+
+
+ +
``` diff --git a/docs/source/index.md b/docs/source/index.md index fd31a67b7..a0737b565 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -109,6 +109,21 @@ For a complete introduction to optimization in estimagic, check out the +
+ +
+ video icon +
+
Videos
+

+ Collection of tutorials, talks, and screencasts on estimagic. +

+
+
+ +
``` @@ -122,6 +137,9 @@ getting_started/index how_to_guides/index explanations/index reference_guides/index +development/index +videos +algorithms ``` ## Highlights @@ -163,15 +181,6 @@ reference_guides/index **Useful links for search:** {ref}`genindex` | {ref}`modindex` | {ref}`search` -```{toctree} ---- -hidden: true -maxdepth: 1 ---- -development/index -algorithms -``` - [how to do multistart]: how_to_guides/optimization/how_to_do_multistart_optimizations [how to use logging]: how_to_guides/optimization/how_to_use_logging [msm tutorial]: getting_started/estimation/first_msm_estimation_with_estimagic diff --git a/docs/source/videos.md b/docs/source/videos.md new file mode 100644 index 000000000..bb73e9606 --- /dev/null +++ b/docs/source/videos.md @@ -0,0 +1,87 @@ +(list_of_videos)= + +# Videos + +Check out our tutorials, talks and screencasts about estimagic. + +## Talks and tutorials + +### EuroSciPy 2023 (Talk) + +```{raw} html + +``` + +### EuroSciPy 2023 (Tutorial) + +```{raw} html + +``` + +### SciPy 2022 (Tutorial) + +```{raw} html + +``` + +## Screencasts + +The screencasts are part of the course _Effective Programming Practices for Economists_, +taught at the University of Bonn by +[Hans-Martin von Gaudecker](https://www.wiwi.uni-bonn.de/gaudecker/), and previously +also [Janoś Gabler](https://github.com/janosg). You can find all screencasts of the +course on the +[course webite](https://effective-programming-practices.vercel.app/landing-page.html). +Here, we show the screencasts about numerical optimization and estimagic. + +### Introduction to numerical optimization + +```{raw} html + +``` + +### Using estimagic’s minimize and maximize + +```{raw} html + +``` + +### Visualizing optimizer histories + +```{raw} html + +``` + +### Choosing optimization algorithms + +```{raw} html + +```