From 10635d2babaecb215f5bda07947a9a119313bb4d Mon Sep 17 00:00:00 2001 From: Hans-Martin von Gaudecker Date: Tue, 10 Dec 2024 14:05:13 +0100 Subject: [PATCH 1/5] Remove copy/paste error. --- src/epp_topics/pandas/selection/screencast/slides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/epp_topics/pandas/selection/screencast/slides.md b/src/epp_topics/pandas/selection/screencast/slides.md index aaa0d8ea..d0ce759e 100644 --- a/src/epp_topics/pandas/selection/screencast/slides.md +++ b/src/epp_topics/pandas/selection/screencast/slides.md @@ -11,7 +11,7 @@ drawings: transition: fade title: Effective Programming Practices for Economists defaults: - layout: centerihm nochmal eine Email geschrieben und gef + layout: center --- ### Effective Programming Practices for Economists From f1b5d068ab9e41a35796acf70921e6c80e6aa63a Mon Sep 17 00:00:00 2001 From: Hans-Martin von Gaudecker Date: Thu, 12 Dec 2024 16:43:40 +0100 Subject: [PATCH 2/5] Add readme screencast, fix templates and make slides' source nicer by removing commented-out block. --- .../file_systems/screencast/slides.md | 2 - .../background/floats/screencast/slides.md | 2 - .../background/graphs/screencast/slides.md | 2 - .../os_history/screencast/slides.md | 2 - .../subchapter_1/screencast/script.md | 7 +- .../subchapter_1/screencast/slides.md | 4 +- .../avoiding_debugging/screencast/slides.md | 2 - .../debugging_intro/screencast/slides.md | 2 - .../debugging_psychology/screencast/slides.md | 2 - .../debugging_strategies/screencast/slides.md | 2 - .../gathering_data/screencast/slides.md | 2 - .../debugging/pdbp/screencast/slides.md | 2 - .../git/introduction/screencast/slides.md | 2 - .../git/pre_commits/screencast/slides.md | 2 - .../goals_workflow/screencast/slides.md | 2 - .../graph_objects/screencast/slides.md | 2 - .../plotting/quick_plots/screencast/slides.md | 2 - .../plotting/tweak_px/screencast/slides.md | 2 - .../what_to_plot/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../comprehensions/screencast/slides.md | 2 - .../python_basics/dicts/screencast/slides.md | 2 - .../for_loops/screencast/slides.md | 2 - .../functions_basics/screencast/slides.md | 2 - .../functions_principles/screencast/slides.md | 2 - .../if_conditions/screencast/slides.md | 2 - .../importing/screencast/slides.md | 2 - .../lists_tuples_sets/screencast/slides.md | 2 - .../pathlib/screencast/slides.md | 2 - .../strings/screencast/slides.md | 2 - .../tracebacks/screencast/slides.md | 2 - .../environments/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../executing_py_shell/screencast/slides.md | 2 - .../executing_py_vscode/screencast/slides.md | 2 - .../executing_pytask/screencast/slides.md | 2 - .../executing_pytest/screencast/slides.md | 2 - .../broadcasting/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../creating_arrays/screencast/slides.md | 2 - .../indexing/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../optimization_intro/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../randomness/screencast/slides.md | 2 - .../speedup_intro/screencast/slides.md | 2 - .../speedup_line_profile/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../speedup_numba/screencast/slides.md | 2 - .../speedup_numpy/screencast/slides.md | 2 - .../speedup_snakeviz/screencast/slides.md | 2 - .../what_is_numpy/screencast/slides.md | 2 - .../deciding_containers/screencast/slides.md | 2 - .../defining_containers/screencast/slides.md | 2 - .../error_handling_intro/screencast/slides.md | 2 - .../idea_of_testing/screencast/slides.md | 2 - .../naming/screencast/slides.md | 2 - .../partial/screencast/slides.md | 2 - .../pure_functions/screencast/slides.md | 2 - .../raising_errors/screencast/slides.md | 2 - .../style_guides/screencast/slides.md | 2 - .../screencast/slides.md | 2 - .../texts/writing_readme_files/__init__.py | 18 +++ .../texts/writing_readme_files/config.py | 9 ++ .../objectives_materials.ipynb | 106 ++++++++++++++++++ .../writing_readme_files/screencast/script.md | 6 + .../writing_readme_files/screencast/slides.md | 69 ++++++++++++ .../writing_readme_files/screencast/style.css | 1 + .../unix_navigation/screencast/slides.md | 2 - .../why_shells_today/screencast/slides.md | 2 - .../windows_navigation/screencast/slides.md | 2 - 75 files changed, 213 insertions(+), 141 deletions(-) create mode 100644 src/epp_topics/texts/writing_readme_files/__init__.py create mode 100644 src/epp_topics/texts/writing_readme_files/config.py create mode 100644 src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb create mode 100644 src/epp_topics/texts/writing_readme_files/screencast/script.md create mode 100644 src/epp_topics/texts/writing_readme_files/screencast/slides.md create mode 120000 src/epp_topics/texts/writing_readme_files/screencast/style.css diff --git a/src/epp_topics/background/file_systems/screencast/slides.md b/src/epp_topics/background/file_systems/screencast/slides.md index a5834537..abfc95de 100644 --- a/src/epp_topics/background/file_systems/screencast/slides.md +++ b/src/epp_topics/background/file_systems/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/background/floats/screencast/slides.md b/src/epp_topics/background/floats/screencast/slides.md index 7eceeffa..f601eafb 100644 --- a/src/epp_topics/background/floats/screencast/slides.md +++ b/src/epp_topics/background/floats/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/background/graphs/screencast/slides.md b/src/epp_topics/background/graphs/screencast/slides.md index 006035e0..b12763af 100644 --- a/src/epp_topics/background/graphs/screencast/slides.md +++ b/src/epp_topics/background/graphs/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/background/os_history/screencast/slides.md b/src/epp_topics/background/os_history/screencast/slides.md index 6ae23eed..840d4871 100644 --- a/src/epp_topics/background/os_history/screencast/slides.md +++ b/src/epp_topics/background/os_history/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/chapter_template/subchapter_1/screencast/script.md b/src/epp_topics/chapter_template/subchapter_1/screencast/script.md index 2b6d5ed9..b100b9e6 100644 --- a/src/epp_topics/chapter_template/subchapter_1/screencast/script.md +++ b/src/epp_topics/chapter_template/subchapter_1/screencast/script.md @@ -1,6 +1,5 @@ -# Script: Subchapter Name +# Script: Writing Readme Files -## First slide +## Readme.md -- Some bullet point -- Another bullet point +- Whatever the situation, very important thing diff --git a/src/epp_topics/chapter_template/subchapter_1/screencast/slides.md b/src/epp_topics/chapter_template/subchapter_1/screencast/slides.md index 92031651..0901502b 100644 --- a/src/epp_topics/chapter_template/subchapter_1/screencast/slides.md +++ b/src/epp_topics/chapter_template/subchapter_1/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists @@ -21,7 +19,7 @@ defaults: # Some Chapter -### Some Subchapter +### Subchapter Title
diff --git a/src/epp_topics/debugging/avoiding_debugging/screencast/slides.md b/src/epp_topics/debugging/avoiding_debugging/screencast/slides.md index 7436030b..13de3d03 100644 --- a/src/epp_topics/debugging/avoiding_debugging/screencast/slides.md +++ b/src/epp_topics/debugging/avoiding_debugging/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/debugging/debugging_intro/screencast/slides.md b/src/epp_topics/debugging/debugging_intro/screencast/slides.md index 7dd847db..b35b9fa9 100644 --- a/src/epp_topics/debugging/debugging_intro/screencast/slides.md +++ b/src/epp_topics/debugging/debugging_intro/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/debugging/debugging_psychology/screencast/slides.md b/src/epp_topics/debugging/debugging_psychology/screencast/slides.md index e0bd4ce3..8d7d99cb 100644 --- a/src/epp_topics/debugging/debugging_psychology/screencast/slides.md +++ b/src/epp_topics/debugging/debugging_psychology/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/debugging/debugging_strategies/screencast/slides.md b/src/epp_topics/debugging/debugging_strategies/screencast/slides.md index 576caf8b..73817643 100644 --- a/src/epp_topics/debugging/debugging_strategies/screencast/slides.md +++ b/src/epp_topics/debugging/debugging_strategies/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/debugging/gathering_data/screencast/slides.md b/src/epp_topics/debugging/gathering_data/screencast/slides.md index 04efac74..678abdb3 100644 --- a/src/epp_topics/debugging/gathering_data/screencast/slides.md +++ b/src/epp_topics/debugging/gathering_data/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/debugging/pdbp/screencast/slides.md b/src/epp_topics/debugging/pdbp/screencast/slides.md index 0a3a7fff..c3e7fc5b 100644 --- a/src/epp_topics/debugging/pdbp/screencast/slides.md +++ b/src/epp_topics/debugging/pdbp/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/git/introduction/screencast/slides.md b/src/epp_topics/git/introduction/screencast/slides.md index fc63c041..8456e6a1 100644 --- a/src/epp_topics/git/introduction/screencast/slides.md +++ b/src/epp_topics/git/introduction/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/git/pre_commits/screencast/slides.md b/src/epp_topics/git/pre_commits/screencast/slides.md index f7fe31db..ed1a49a2 100644 --- a/src/epp_topics/git/pre_commits/screencast/slides.md +++ b/src/epp_topics/git/pre_commits/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/plotting/goals_workflow/screencast/slides.md b/src/epp_topics/plotting/goals_workflow/screencast/slides.md index eba32480..218d4d5f 100644 --- a/src/epp_topics/plotting/goals_workflow/screencast/slides.md +++ b/src/epp_topics/plotting/goals_workflow/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/plotting/graph_objects/screencast/slides.md b/src/epp_topics/plotting/graph_objects/screencast/slides.md index b889739a..fcf2f57d 100644 --- a/src/epp_topics/plotting/graph_objects/screencast/slides.md +++ b/src/epp_topics/plotting/graph_objects/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/plotting/quick_plots/screencast/slides.md b/src/epp_topics/plotting/quick_plots/screencast/slides.md index 43105068..a6c628ef 100644 --- a/src/epp_topics/plotting/quick_plots/screencast/slides.md +++ b/src/epp_topics/plotting/quick_plots/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/plotting/tweak_px/screencast/slides.md b/src/epp_topics/plotting/tweak_px/screencast/slides.md index 38635d97..8e12d83b 100644 --- a/src/epp_topics/plotting/tweak_px/screencast/slides.md +++ b/src/epp_topics/plotting/tweak_px/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/plotting/what_to_plot/screencast/slides.md b/src/epp_topics/plotting/what_to_plot/screencast/slides.md index 4ea179ed..143ae410 100644 --- a/src/epp_topics/plotting/what_to_plot/screencast/slides.md +++ b/src/epp_topics/plotting/what_to_plot/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/plotting/why_plotly_prerequisites/screencast/slides.md b/src/epp_topics/plotting/why_plotly_prerequisites/screencast/slides.md index d06c08fe..f0995339 100644 --- a/src/epp_topics/plotting/why_plotly_prerequisites/screencast/slides.md +++ b/src/epp_topics/plotting/why_plotly_prerequisites/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/assignment_and_scalar_types/screencast/slides.md b/src/epp_topics/python_basics/assignment_and_scalar_types/screencast/slides.md index 3450846c..c9d2ab2d 100644 --- a/src/epp_topics/python_basics/assignment_and_scalar_types/screencast/slides.md +++ b/src/epp_topics/python_basics/assignment_and_scalar_types/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/comprehensions/screencast/slides.md b/src/epp_topics/python_basics/comprehensions/screencast/slides.md index 93a3e1a1..d80062b1 100644 --- a/src/epp_topics/python_basics/comprehensions/screencast/slides.md +++ b/src/epp_topics/python_basics/comprehensions/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/dicts/screencast/slides.md b/src/epp_topics/python_basics/dicts/screencast/slides.md index fa48bf75..9521202c 100644 --- a/src/epp_topics/python_basics/dicts/screencast/slides.md +++ b/src/epp_topics/python_basics/dicts/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/for_loops/screencast/slides.md b/src/epp_topics/python_basics/for_loops/screencast/slides.md index 67897f14..b5c1b2fc 100644 --- a/src/epp_topics/python_basics/for_loops/screencast/slides.md +++ b/src/epp_topics/python_basics/for_loops/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/functions_basics/screencast/slides.md b/src/epp_topics/python_basics/functions_basics/screencast/slides.md index 04748dc8..51a25aa1 100644 --- a/src/epp_topics/python_basics/functions_basics/screencast/slides.md +++ b/src/epp_topics/python_basics/functions_basics/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/functions_principles/screencast/slides.md b/src/epp_topics/python_basics/functions_principles/screencast/slides.md index f7164862..6b3eecd6 100644 --- a/src/epp_topics/python_basics/functions_principles/screencast/slides.md +++ b/src/epp_topics/python_basics/functions_principles/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/if_conditions/screencast/slides.md b/src/epp_topics/python_basics/if_conditions/screencast/slides.md index 5b1ab67a..d079db6f 100644 --- a/src/epp_topics/python_basics/if_conditions/screencast/slides.md +++ b/src/epp_topics/python_basics/if_conditions/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/importing/screencast/slides.md b/src/epp_topics/python_basics/importing/screencast/slides.md index d13028f3..f0fe134e 100644 --- a/src/epp_topics/python_basics/importing/screencast/slides.md +++ b/src/epp_topics/python_basics/importing/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/lists_tuples_sets/screencast/slides.md b/src/epp_topics/python_basics/lists_tuples_sets/screencast/slides.md index 22575dbe..b7bcc249 100644 --- a/src/epp_topics/python_basics/lists_tuples_sets/screencast/slides.md +++ b/src/epp_topics/python_basics/lists_tuples_sets/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/pathlib/screencast/slides.md b/src/epp_topics/python_basics/pathlib/screencast/slides.md index 4a9ce096..c713dbd1 100644 --- a/src/epp_topics/python_basics/pathlib/screencast/slides.md +++ b/src/epp_topics/python_basics/pathlib/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/strings/screencast/slides.md b/src/epp_topics/python_basics/strings/screencast/slides.md index 59a05f7d..e957d550 100644 --- a/src/epp_topics/python_basics/strings/screencast/slides.md +++ b/src/epp_topics/python_basics/strings/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_basics/tracebacks/screencast/slides.md b/src/epp_topics/python_basics/tracebacks/screencast/slides.md index 6009caa7..f3ac138d 100644 --- a/src/epp_topics/python_basics/tracebacks/screencast/slides.md +++ b/src/epp_topics/python_basics/tracebacks/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/environments/screencast/slides.md b/src/epp_topics/python_installation_execution/environments/screencast/slides.md index 39777687..f30785a7 100644 --- a/src/epp_topics/python_installation_execution/environments/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/environments/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/executing_notebook_browser/screencast/slides.md b/src/epp_topics/python_installation_execution/executing_notebook_browser/screencast/slides.md index 1d9e3e4b..285311b1 100644 --- a/src/epp_topics/python_installation_execution/executing_notebook_browser/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/executing_notebook_browser/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/executing_notebook_vscode/screencast/slides.md b/src/epp_topics/python_installation_execution/executing_notebook_vscode/screencast/slides.md index f7018eff..5b051564 100644 --- a/src/epp_topics/python_installation_execution/executing_notebook_vscode/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/executing_notebook_vscode/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/executing_py_shell/screencast/slides.md b/src/epp_topics/python_installation_execution/executing_py_shell/screencast/slides.md index 64977a7a..c08eb62d 100644 --- a/src/epp_topics/python_installation_execution/executing_py_shell/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/executing_py_shell/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/executing_py_vscode/screencast/slides.md b/src/epp_topics/python_installation_execution/executing_py_vscode/screencast/slides.md index fe910692..b3180ca3 100644 --- a/src/epp_topics/python_installation_execution/executing_py_vscode/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/executing_py_vscode/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/executing_pytask/screencast/slides.md b/src/epp_topics/python_installation_execution/executing_pytask/screencast/slides.md index 37a74e7a..d30b950a 100644 --- a/src/epp_topics/python_installation_execution/executing_pytask/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/executing_pytask/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/python_installation_execution/executing_pytest/screencast/slides.md b/src/epp_topics/python_installation_execution/executing_pytest/screencast/slides.md index 7a877256..1fc774b9 100644 --- a/src/epp_topics/python_installation_execution/executing_pytest/screencast/slides.md +++ b/src/epp_topics/python_installation_execution/executing_pytest/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/broadcasting/screencast/slides.md b/src/epp_topics/scientific_computing/broadcasting/screencast/slides.md index adc36a71..6adce896 100644 --- a/src/epp_topics/scientific_computing/broadcasting/screencast/slides.md +++ b/src/epp_topics/scientific_computing/broadcasting/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/calculations_between_arrays/screencast/slides.md b/src/epp_topics/scientific_computing/calculations_between_arrays/screencast/slides.md index 3bde91fa..1b9550d1 100644 --- a/src/epp_topics/scientific_computing/calculations_between_arrays/screencast/slides.md +++ b/src/epp_topics/scientific_computing/calculations_between_arrays/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/calculations_on_arrays/screencast/slides.md b/src/epp_topics/scientific_computing/calculations_on_arrays/screencast/slides.md index 973014ad..02de8f31 100644 --- a/src/epp_topics/scientific_computing/calculations_on_arrays/screencast/slides.md +++ b/src/epp_topics/scientific_computing/calculations_on_arrays/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/creating_arrays/screencast/slides.md b/src/epp_topics/scientific_computing/creating_arrays/screencast/slides.md index 8bf1875b..965867e4 100644 --- a/src/epp_topics/scientific_computing/creating_arrays/screencast/slides.md +++ b/src/epp_topics/scientific_computing/creating_arrays/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/indexing/screencast/slides.md b/src/epp_topics/scientific_computing/indexing/screencast/slides.md index 25f35c48..9e7584e0 100644 --- a/src/epp_topics/scientific_computing/indexing/screencast/slides.md +++ b/src/epp_topics/scientific_computing/indexing/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/optimization_algorithms/screencast/slides.md b/src/epp_topics/scientific_computing/optimization_algorithms/screencast/slides.md index 8a63df55..1e265325 100644 --- a/src/epp_topics/scientific_computing/optimization_algorithms/screencast/slides.md +++ b/src/epp_topics/scientific_computing/optimization_algorithms/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/optimization_histories/screencast/slides.md b/src/epp_topics/scientific_computing/optimization_histories/screencast/slides.md index e8828ffd..c29253ee 100644 --- a/src/epp_topics/scientific_computing/optimization_histories/screencast/slides.md +++ b/src/epp_topics/scientific_computing/optimization_histories/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/optimization_intro/screencast/slides.md b/src/epp_topics/scientific_computing/optimization_intro/screencast/slides.md index 92194994..29c16d47 100644 --- a/src/epp_topics/scientific_computing/optimization_intro/screencast/slides.md +++ b/src/epp_topics/scientific_computing/optimization_intro/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/optimization_mechanics/screencast/slides.md b/src/epp_topics/scientific_computing/optimization_mechanics/screencast/slides.md index 118668e7..c7e9b1df 100644 --- a/src/epp_topics/scientific_computing/optimization_mechanics/screencast/slides.md +++ b/src/epp_topics/scientific_computing/optimization_mechanics/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/randomness/screencast/slides.md b/src/epp_topics/scientific_computing/randomness/screencast/slides.md index 7218149e..9174e010 100644 --- a/src/epp_topics/scientific_computing/randomness/screencast/slides.md +++ b/src/epp_topics/scientific_computing/randomness/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/speedup_intro/screencast/slides.md b/src/epp_topics/scientific_computing/speedup_intro/screencast/slides.md index 065637e2..5209b658 100644 --- a/src/epp_topics/scientific_computing/speedup_intro/screencast/slides.md +++ b/src/epp_topics/scientific_computing/speedup_intro/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/speedup_line_profile/screencast/slides.md b/src/epp_topics/scientific_computing/speedup_line_profile/screencast/slides.md index 17577d44..3ac3f52a 100644 --- a/src/epp_topics/scientific_computing/speedup_line_profile/screencast/slides.md +++ b/src/epp_topics/scientific_computing/speedup_line_profile/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/speedup_measuring_time/screencast/slides.md b/src/epp_topics/scientific_computing/speedup_measuring_time/screencast/slides.md index 8afacf16..3117f854 100644 --- a/src/epp_topics/scientific_computing/speedup_measuring_time/screencast/slides.md +++ b/src/epp_topics/scientific_computing/speedup_measuring_time/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/speedup_numba/screencast/slides.md b/src/epp_topics/scientific_computing/speedup_numba/screencast/slides.md index d310dc22..9bf04c61 100644 --- a/src/epp_topics/scientific_computing/speedup_numba/screencast/slides.md +++ b/src/epp_topics/scientific_computing/speedup_numba/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/speedup_numpy/screencast/slides.md b/src/epp_topics/scientific_computing/speedup_numpy/screencast/slides.md index b77b5bc3..0e844bac 100644 --- a/src/epp_topics/scientific_computing/speedup_numpy/screencast/slides.md +++ b/src/epp_topics/scientific_computing/speedup_numpy/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/speedup_snakeviz/screencast/slides.md b/src/epp_topics/scientific_computing/speedup_snakeviz/screencast/slides.md index 6c745e0c..f23dd973 100644 --- a/src/epp_topics/scientific_computing/speedup_snakeviz/screencast/slides.md +++ b/src/epp_topics/scientific_computing/speedup_snakeviz/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/scientific_computing/what_is_numpy/screencast/slides.md b/src/epp_topics/scientific_computing/what_is_numpy/screencast/slides.md index 96e9f62b..358e29b5 100644 --- a/src/epp_topics/scientific_computing/what_is_numpy/screencast/slides.md +++ b/src/epp_topics/scientific_computing/what_is_numpy/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/deciding_containers/screencast/slides.md b/src/epp_topics/software_engineering/deciding_containers/screencast/slides.md index 86dff2cf..cfa0ea68 100644 --- a/src/epp_topics/software_engineering/deciding_containers/screencast/slides.md +++ b/src/epp_topics/software_engineering/deciding_containers/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/defining_containers/screencast/slides.md b/src/epp_topics/software_engineering/defining_containers/screencast/slides.md index ba640b14..7d1a0b9e 100644 --- a/src/epp_topics/software_engineering/defining_containers/screencast/slides.md +++ b/src/epp_topics/software_engineering/defining_containers/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/error_handling_intro/screencast/slides.md b/src/epp_topics/software_engineering/error_handling_intro/screencast/slides.md index 55a43628..149868fb 100644 --- a/src/epp_topics/software_engineering/error_handling_intro/screencast/slides.md +++ b/src/epp_topics/software_engineering/error_handling_intro/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/idea_of_testing/screencast/slides.md b/src/epp_topics/software_engineering/idea_of_testing/screencast/slides.md index cad41a8c..228cec68 100644 --- a/src/epp_topics/software_engineering/idea_of_testing/screencast/slides.md +++ b/src/epp_topics/software_engineering/idea_of_testing/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/naming/screencast/slides.md b/src/epp_topics/software_engineering/naming/screencast/slides.md index 505c6a73..573d7ca9 100644 --- a/src/epp_topics/software_engineering/naming/screencast/slides.md +++ b/src/epp_topics/software_engineering/naming/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/partial/screencast/slides.md b/src/epp_topics/software_engineering/partial/screencast/slides.md index d3574e81..696afbf0 100644 --- a/src/epp_topics/software_engineering/partial/screencast/slides.md +++ b/src/epp_topics/software_engineering/partial/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/pure_functions/screencast/slides.md b/src/epp_topics/software_engineering/pure_functions/screencast/slides.md index 3cf7fa97..abe14c40 100644 --- a/src/epp_topics/software_engineering/pure_functions/screencast/slides.md +++ b/src/epp_topics/software_engineering/pure_functions/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/raising_errors/screencast/slides.md b/src/epp_topics/software_engineering/raising_errors/screencast/slides.md index 6b47fe47..a18e75bd 100644 --- a/src/epp_topics/software_engineering/raising_errors/screencast/slides.md +++ b/src/epp_topics/software_engineering/raising_errors/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/style_guides/screencast/slides.md b/src/epp_topics/software_engineering/style_guides/screencast/slides.md index 38c7fb77..50b5e678 100644 --- a/src/epp_topics/software_engineering/style_guides/screencast/slides.md +++ b/src/epp_topics/software_engineering/style_guides/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/software_engineering/which_errors_to_handle/screencast/slides.md b/src/epp_topics/software_engineering/which_errors_to_handle/screencast/slides.md index 3a05048f..34aceedc 100644 --- a/src/epp_topics/software_engineering/which_errors_to_handle/screencast/slides.md +++ b/src/epp_topics/software_engineering/which_errors_to_handle/screencast/slides.md @@ -11,8 +11,6 @@ drawings: transition: fade defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/texts/writing_readme_files/__init__.py b/src/epp_topics/texts/writing_readme_files/__init__.py new file mode 100644 index 00000000..b2a709f3 --- /dev/null +++ b/src/epp_topics/texts/writing_readme_files/__init__.py @@ -0,0 +1,18 @@ +"""Create exercise and solution notebooks for the current subchapter.""" + +from pathlib import Path + +from pybaum import tree_map + +from .config import SITE_CONTENTS as _SITE_CONTENTS + + +def add_this_dir(filename): + """Add the current directory's name to the filename.""" + return f"{Path(__file__).parent.name}/{filename}" + + +SITE_CONTENTS = tree_map( + add_this_dir, + _SITE_CONTENTS, +) diff --git a/src/epp_topics/texts/writing_readme_files/config.py b/src/epp_topics/texts/writing_readme_files/config.py new file mode 100644 index 00000000..e88a55a1 --- /dev/null +++ b/src/epp_topics/texts/writing_readme_files/config.py @@ -0,0 +1,9 @@ +"""Definitions of source files for the current chapter.""" + +SITE_CONTENTS = { + "pages": ("objectives_materials.ipynb",), + "other": ( + # "existing figures etc.", + ), + "built": ("texts-writing_readme_files.pdf",), +} diff --git a/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb b/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb new file mode 100644 index 00000000..7344aa23 --- /dev/null +++ b/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb @@ -0,0 +1,106 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Writing Readme Files\n", + "\n", + "## Learning Objectives\n", + "\n", + "After working through this topic, you should be able to:\n", + "\n", + "- explain why it is important to write a good `README.md` file\n", + "- decide what to put in a `README.md` file for a specific project\n", + "\n", + "## Materials\n", + "\n", + "Video:\n", + "\n", + "\n", + "\n", + "Download the [slides](texts-writing_readme_files.pdf).\n", + "\n", + "## Quiz" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": { + "tags": [ + "remove-input" + ] + }, + "outputs": [], + "source": [ + "content = [\n", + " {\n", + " \"question\": \"Pandas ...\",\n", + " \"code\": \"import pandas as pd\",\n", + " \"type\": \"many_choice\",\n", + " \"answers\": [\n", + " {\n", + " \"answer\": (\n", + " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n", + " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n", + " ),\n", + " \"correct\": True,\n", + " \"feedback\": \"\",\n", + " },\n", + " {\n", + " \"answer\": (\n", + " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n", + " \"ccccc\",\n", + " ),\n", + " \"correct\": False,\n", + " \"feedback\": \"\",\n", + " },\n", + " {\n", + " \"answer\": (\n", + " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n", + " \"ddddd\",\n", + " ),\n", + " \"correct\": True,\n", + " \"feedback\": \"\",\n", + " },\n", + " {\n", + " \"answer\": (\n", + " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n", + " \"eeeeee\",\n", + " ),\n", + " \"correct\": False,\n", + " \"feedback\": \"\",\n", + " },\n", + " ],\n", + " },\n", + "]\n", + "\n", + "from jupyterquiz import display_quiz\n", + "\n", + "display_quiz(content, colors=\"fdsp\")" + ] + } + ], + "metadata": { + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/src/epp_topics/texts/writing_readme_files/screencast/script.md b/src/epp_topics/texts/writing_readme_files/screencast/script.md new file mode 100644 index 00000000..2b6d5ed9 --- /dev/null +++ b/src/epp_topics/texts/writing_readme_files/screencast/script.md @@ -0,0 +1,6 @@ +# Script: Subchapter Name + +## First slide + +- Some bullet point +- Another bullet point diff --git a/src/epp_topics/texts/writing_readme_files/screencast/slides.md b/src/epp_topics/texts/writing_readme_files/screencast/slides.md new file mode 100644 index 00000000..63f76809 --- /dev/null +++ b/src/epp_topics/texts/writing_readme_files/screencast/slides.md @@ -0,0 +1,69 @@ +--- +theme: academic +coverDate: "" +class: text-center +highlighter: shiki +lineNumbers: false +info: | + ## Effective Programming Practices for Economists +drawings: + persist: false +transition: fade +defaults: + layout: center +--- + +### Effective Programming Practices for Economists + +
+ +# Texts, Typesetting, and Text Data + +### Writing Readme Files + +
+ + +Janoś Gabler and Hans-Martin von Gaudecker + +--- + +# Readme.md + +- Everybody sees this first when they visit your repository + + → Always format nicely using markdown + +- In large projects, it could be a short visit + + → DRY. Just point to where the information below can be found + +- In small projects, it might be the only place with text (≠ code) + + → Provide all relevant information + +--- + +# Points to address + +- Entry point to the project: What is the goal? How is that being achieved? + +- How do I get it to run? + + - For experienced users: Make it easy to find the bare minimum (assumptions about + sytem, precise commands) + + - For less experienced users: Provide links to background information + +- Does it look like you cared? + + - about the project + - about the reader (don't make it too long!) + +--- + +# Examples + +- [optimagic](https://github.com/optimagic-dev/optimagic/) + +- some paper diff --git a/src/epp_topics/texts/writing_readme_files/screencast/style.css b/src/epp_topics/texts/writing_readme_files/screencast/style.css new file mode 120000 index 00000000..329b431f --- /dev/null +++ b/src/epp_topics/texts/writing_readme_files/screencast/style.css @@ -0,0 +1 @@ +../../../slidev_config/style.css \ No newline at end of file diff --git a/src/epp_topics/tools/unix_navigation/screencast/slides.md b/src/epp_topics/tools/unix_navigation/screencast/slides.md index 22984578..24891056 100644 --- a/src/epp_topics/tools/unix_navigation/screencast/slides.md +++ b/src/epp_topics/tools/unix_navigation/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/tools/why_shells_today/screencast/slides.md b/src/epp_topics/tools/why_shells_today/screencast/slides.md index 41eb705c..18b658ab 100644 --- a/src/epp_topics/tools/why_shells_today/screencast/slides.md +++ b/src/epp_topics/tools/why_shells_today/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists diff --git a/src/epp_topics/tools/windows_navigation/screencast/slides.md b/src/epp_topics/tools/windows_navigation/screencast/slides.md index 030307b2..a55de363 100644 --- a/src/epp_topics/tools/windows_navigation/screencast/slides.md +++ b/src/epp_topics/tools/windows_navigation/screencast/slides.md @@ -12,8 +12,6 @@ transition: fade title: Effective Programming Practices for Economists defaults: layout: center -# themeConfig: -# paginationPagesDisabled: true --- ### Effective Programming Practices for Economists From f4d29f7ce0cdb71fa7ef3262e0a45e5716277cae Mon Sep 17 00:00:00 2001 From: Hans-Martin von Gaudecker Date: Fri, 13 Dec 2024 17:29:23 +0100 Subject: [PATCH 3/5] Replace YouTube videos by electure. --- .../speedup_intro/objectives_materials.ipynb | 8 +++++++- .../speedup_line_profile/objectives_materials.ipynb | 8 +++++++- .../speedup_measuring_time/objectives_materials.ipynb | 8 +++++++- .../speedup_numba/objectives_materials.ipynb | 8 +++++++- .../speedup_numpy/objectives_materials.ipynb | 8 +++++++- .../speedup_snakeviz/objectives_materials.ipynb | 8 +++++++- .../deciding_containers/objectives_materials.ipynb | 8 +++++++- .../defining_containers/objectives_materials.ipynb | 8 +++++++- .../partial/objectives_materials.ipynb | 8 +++++++- 9 files changed, 63 insertions(+), 9 deletions(-) diff --git a/src/epp_topics/scientific_computing/speedup_intro/objectives_materials.ipynb b/src/epp_topics/scientific_computing/speedup_intro/objectives_materials.ipynb index e93f603c..1809ba2e 100644 --- a/src/epp_topics/scientific_computing/speedup_intro/objectives_materials.ipynb +++ b/src/epp_topics/scientific_computing/speedup_intro/objectives_materials.ipynb @@ -17,7 +17,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](scientific_computing-speedup_intro.pdf).\n", "\n", diff --git a/src/epp_topics/scientific_computing/speedup_line_profile/objectives_materials.ipynb b/src/epp_topics/scientific_computing/speedup_line_profile/objectives_materials.ipynb index 9386db35..59b01c49 100644 --- a/src/epp_topics/scientific_computing/speedup_line_profile/objectives_materials.ipynb +++ b/src/epp_topics/scientific_computing/speedup_line_profile/objectives_materials.ipynb @@ -14,7 +14,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](scientific_computing-speedup_line_profile.pdf).\n", "\n", diff --git a/src/epp_topics/scientific_computing/speedup_measuring_time/objectives_materials.ipynb b/src/epp_topics/scientific_computing/speedup_measuring_time/objectives_materials.ipynb index 601696d0..f76a84c1 100644 --- a/src/epp_topics/scientific_computing/speedup_measuring_time/objectives_materials.ipynb +++ b/src/epp_topics/scientific_computing/speedup_measuring_time/objectives_materials.ipynb @@ -15,7 +15,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](scientific_computing-speedup_measuring_time.pdf).\n", "\n", diff --git a/src/epp_topics/scientific_computing/speedup_numba/objectives_materials.ipynb b/src/epp_topics/scientific_computing/speedup_numba/objectives_materials.ipynb index d74bb5dc..fd03a0fe 100644 --- a/src/epp_topics/scientific_computing/speedup_numba/objectives_materials.ipynb +++ b/src/epp_topics/scientific_computing/speedup_numba/objectives_materials.ipynb @@ -16,7 +16,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](scientific_computing-speedup_numba.pdf).\n", "\n", diff --git a/src/epp_topics/scientific_computing/speedup_numpy/objectives_materials.ipynb b/src/epp_topics/scientific_computing/speedup_numpy/objectives_materials.ipynb index 954b8bc1..a3d0d946 100644 --- a/src/epp_topics/scientific_computing/speedup_numpy/objectives_materials.ipynb +++ b/src/epp_topics/scientific_computing/speedup_numpy/objectives_materials.ipynb @@ -16,7 +16,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](scientific_computing-speedup_numpy.pdf).\n", "\n", diff --git a/src/epp_topics/scientific_computing/speedup_snakeviz/objectives_materials.ipynb b/src/epp_topics/scientific_computing/speedup_snakeviz/objectives_materials.ipynb index 078e7cbb..af18b8ad 100644 --- a/src/epp_topics/scientific_computing/speedup_snakeviz/objectives_materials.ipynb +++ b/src/epp_topics/scientific_computing/speedup_snakeviz/objectives_materials.ipynb @@ -15,7 +15,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](scientific_computing-speedup_snakeviz.pdf).\n", "\n", diff --git a/src/epp_topics/software_engineering/deciding_containers/objectives_materials.ipynb b/src/epp_topics/software_engineering/deciding_containers/objectives_materials.ipynb index 7e018e51..81185137 100644 --- a/src/epp_topics/software_engineering/deciding_containers/objectives_materials.ipynb +++ b/src/epp_topics/software_engineering/deciding_containers/objectives_materials.ipynb @@ -13,7 +13,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "These are the [slides](software_engineering-deciding_containers.pdf).\n", "\n", diff --git a/src/epp_topics/software_engineering/defining_containers/objectives_materials.ipynb b/src/epp_topics/software_engineering/defining_containers/objectives_materials.ipynb index aedbb2a4..e74fcda1 100644 --- a/src/epp_topics/software_engineering/defining_containers/objectives_materials.ipynb +++ b/src/epp_topics/software_engineering/defining_containers/objectives_materials.ipynb @@ -17,7 +17,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](software_engineering-defining_containers.pdf).\n", "\n", diff --git a/src/epp_topics/software_engineering/partial/objectives_materials.ipynb b/src/epp_topics/software_engineering/partial/objectives_materials.ipynb index b8c8d46a..110ba936 100644 --- a/src/epp_topics/software_engineering/partial/objectives_materials.ipynb +++ b/src/epp_topics/software_engineering/partial/objectives_materials.ipynb @@ -13,7 +13,13 @@ "\n", "## Materials\n", "\n", - "\n", + "\n", "\n", "Download the [slides](software_engineering-partial.pdf).\n", "\n", From b4185ce71401d39d113eee60c3b2c21af44b59a8 Mon Sep 17 00:00:00 2001 From: Hans-Martin von Gaudecker Date: Mon, 16 Dec 2024 11:40:45 +0100 Subject: [PATCH 4/5] As recorded. --- .../texts/writing_readme_files/screencast/script.md | 6 ------ .../texts/writing_readme_files/screencast/slides.md | 7 ++----- 2 files changed, 2 insertions(+), 11 deletions(-) delete mode 100644 src/epp_topics/texts/writing_readme_files/screencast/script.md diff --git a/src/epp_topics/texts/writing_readme_files/screencast/script.md b/src/epp_topics/texts/writing_readme_files/screencast/script.md deleted file mode 100644 index 2b6d5ed9..00000000 --- a/src/epp_topics/texts/writing_readme_files/screencast/script.md +++ /dev/null @@ -1,6 +0,0 @@ -# Script: Subchapter Name - -## First slide - -- Some bullet point -- Another bullet point diff --git a/src/epp_topics/texts/writing_readme_files/screencast/slides.md b/src/epp_topics/texts/writing_readme_files/screencast/slides.md index 63f76809..8b209d68 100644 --- a/src/epp_topics/texts/writing_readme_files/screencast/slides.md +++ b/src/epp_topics/texts/writing_readme_files/screencast/slides.md @@ -58,12 +58,9 @@ Janoś Gabler and Hans-Martin von Gaudecker - Does it look like you cared? - about the project + - about the reader (don't make it too long!) --- -# Examples - -- [optimagic](https://github.com/optimagic-dev/optimagic/) - -- some paper +# Example: [optimagic](https://github.com/optimagic-dev/optimagic/?tab=readme-ov-file#optimagic) From 0fbf2ed67d4acee8e2823324c8d8d325b72ad1f9 Mon Sep 17 00:00:00 2001 From: Hans-Martin von Gaudecker Date: Mon, 16 Dec 2024 13:03:57 +0100 Subject: [PATCH 5/5] Upload video, add quiz. --- .../objectives_materials.ipynb | 61 ++++++++++++++----- 1 file changed, 47 insertions(+), 14 deletions(-) diff --git a/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb b/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb index 7344aa23..5b41ccde 100644 --- a/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb +++ b/src/epp_topics/texts/writing_readme_files/objectives_materials.ipynb @@ -18,7 +18,7 @@ "Video:\n", "\n", "