├── 2023 ├── index.qmd └── weeks │ └── week01 │ ├── page.qmd │ └── slides.qmd ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── pull_request_template.md └── workflows │ ├── deadline.yml_ │ ├── initial_setup.yml │ └── publish.yml_ ├── .gitignore ├── LICENSE ├── README.md ├── _quarto.yml ├── css ├── custom.scss ├── custom_style.css ├── styles_slides.css └── syllabus.css ├── figures ├── icons │ └── course_favicon.png └── people │ ├── professor_octopus.png │ ├── professor_octopus2.png │ ├── ta_octopunian.png │ └── ta_octopunian2.png ├── helpers ├── README.md ├── remove-nav.html └── remove-title.html ├── index.qmd ├── references ├── README.md ├── chicago-author-date.csl └── references.bib └── requirements.txt /.gitattributes: -------------------------------------------------------------------------------- 1 | # Ignore .bib file 2 | *.bib -linguist-detectable 3 | 4 | # Here Markdown is not documentation 5 | *.md linguist-detectable 6 | *.qmd linguist-detectable 7 | 8 | # Associate Quarto with Markdown language 9 | *.qmd linguist-language=Markdown 10 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: "[BUG]" 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Environment (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - R/Python versions 29 | 30 | 31 | **Additional context** 32 | Add any other context about the problem here. -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: "[FEATURE REQUEST]" 5 | labels: feature request 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | **Optional: Title** 2 | 3 | --- 4 | 5 | ## Context 6 | 7 | 8 | 9 | 10 | ## Github Issues 11 | 12 | This PR addresses the following issues: 13 | 14 | - Closes # 15 | - Closes # 16 | 17 | 18 | ## How to validate this PR 19 | 20 | 21 | -------------------------------------------------------------------------------- /.github/workflows/deadline.yml_: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: Deadline 4 | # GitHub bot add a comment if an issue is open past its deadline. 5 | # Deadline is taken from the Milestone end date. 6 | on: 7 | 8 | schedule: 9 | - cron: "0 7 * * 2" 10 | 11 | # Allows you to run this workflow manually from the Actions tab 12 | workflow_dispatch: 13 | 14 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 15 | jobs: 16 | # This workflow contains a single job called "build" 17 | build: 18 | # The type of runner that the job will run on 19 | runs-on: ubuntu-latest 20 | env: 21 | GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 22 | 23 | # Steps represent a sequence of tasks that will be executed as part of the job 24 | steps: 25 | 26 | - name: Check out repository 27 | uses: actions/checkout@v3 28 | 29 | # Runs a set of commands using the runners shell 30 | - name: Issues past deadline 31 | run: | 32 | paste -d '\t' <(gh issue list -L 1000 -S "is:open -linked:pr" | awk {'print $1'}) <(gh issue list -L 1000 -S "is:open -linked:pr" --json milestone -q .[].milestone.dueOn | xargs -I {} bash -c 'today=$(date +"%s"); milestoneDate=$(date -d {} +"%s");if [ $(expr $today - $milestoneDate) -gt 0 ]; then echo "true"; else echo "false"; fi') | awk -F"\t" '$2 == "true" {print $1}' | xargs -I {} bash -c 'gh issue comment {} --body "This issue ({}) is open past its deadline: $(date -d $(gh issue view {} --json milestone -q .milestone.dueOn) '+%d-%B-%Y'). @$(gh issue view {} --json assignees -q .[][0].login), is there anything blocking your progress? Leave a comment here or contact the project manager."' 33 | paste -d '\t' <(gh issue list -L 1000 -S "is:open -linked:pr" | awk {'print $1'}) <(gh issue list -L 1000 -S "is:open -linked:pr" --json milestone -q .[].milestone.dueOn | xargs -I {} bash -c 'today=$(date +"%s"); milestoneDate=$(date -d {} +"%s");if [ $(expr $today - $milestoneDate) -gt 0 ]; then echo "true"; else echo "false"; fi') | awk -F"\t" '$2 == "true" {print $1}' | xargs -I {} bash -c 'gh issue edit {} --add-label "delayed ⏳"' 34 | -------------------------------------------------------------------------------- /.github/workflows/initial_setup.yml: -------------------------------------------------------------------------------- 1 | name: initial-setup 2 | 3 | # Controls when the action will run. 4 | on: 5 | push: 6 | branches: 7 | - main 8 | 9 | jobs: 10 | 11 | initial-setup: 12 | permissions: write-all 13 | # The type of runner that the job will run on 14 | runs-on: ubuntu-latest 15 | 16 | # Steps represent a sequence of tasks that will be executed as part of the job 17 | steps: 18 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 19 | - uses: actions/checkout@v2 20 | 21 | # Ensures that the main branch is created 22 | - name: ensure_main_branch 23 | continue-on-error: true 24 | run: | 25 | git checkout -b main 26 | git push --set-upstream origin main 27 | env: 28 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 29 | 30 | # Ensures that the main branch is created 31 | - name: ensure_develop_branch 32 | continue-on-error: true 33 | run: | 34 | git checkout -b develop 35 | git push --set-upstream origin develop 36 | env: 37 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 38 | 39 | # Delete boring labels 40 | - name: label_automation 41 | continue-on-error: true 42 | if: contains(github.event.head_commit.message, 'Initial commit') 43 | run: | 44 | gh label delete "bug" --confirm 45 | gh label delete "documentation" --confirm 46 | gh label delete "duplicate" --confirm 47 | gh label delete "enhancement" --confirm 48 | gh label delete "good first issue" --confirm 49 | gh label delete "help wanted" --confirm 50 | gh label delete "invalid" --confirm 51 | gh label delete "question" --confirm 52 | gh label delete "wontfix" --confirm 53 | env: 54 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 55 | 56 | # Create labels 57 | - name: label_automation 58 | continue-on-error: true 59 | if: contains(github.event.head_commit.message, 'Initial commit') 60 | run: gh label create "pages 🔖 " --description "Adding or rearranging pages or menus." --color "f1bcba" 61 | env: 62 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 63 | 64 | - name: label_blocked 65 | continue-on-error: true 66 | if: contains(github.event.head_commit.message, 'Initial commit') 67 | run: gh label create "blocked 🚧" --description "Task blocked by some other issue." --color "F9F0F4" 68 | env: 69 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 70 | 71 | - name: label_bug 72 | continue-on-error: true 73 | if: contains(github.event.head_commit.message, 'Initial commit') 74 | run: gh label create "bug 🐞" --description "Something isn't working" --color "D73A4A" 75 | env: 76 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 77 | 78 | - name: label_chore 79 | continue-on-error: true 80 | if: contains(github.event.head_commit.message, 'Initial commit') 81 | run: gh label create "chore 🔨" --description "Maintenance" --color "1F8466" 82 | env: 83 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 84 | 85 | - name: label_data_engineering 86 | if: contains(github.event.head_commit.message, 'Initial commit') 87 | continue-on-error: true 88 | run: gh label create "announcements 📣" --description "Adding announcements to students" --color "e3db73" 89 | env: 90 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 91 | 92 | - name: label_documentation 93 | if: contains(github.event.head_commit.message, 'Initial commit') 94 | continue-on-error: true 95 | run: gh label create "documentation 📖" --description "Add or update documentation" --color "0075CA" 96 | env: 97 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 98 | 99 | - name: label_duplicate 100 | if: contains(github.event.head_commit.message, 'Initial commit') 101 | continue-on-error: true 102 | run: gh label create "teaching content 👨‍🏫" --description "Slides, lecture notes, lecture plan, etc." --color "ccd3cb" 103 | env: 104 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 105 | 106 | - name: label_eda 107 | if: contains(github.event.head_commit.message, 'Initial commit') 108 | continue-on-error: true 109 | run: gh label create "exploratory analysis 🔬" --description "We want to explore some data or perform some analysis that will become a feature later" --color "D4C5F9" 110 | env: 111 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 112 | 113 | - name: label_feature_request 114 | if: contains(github.event.head_commit.message, 'Initial commit') 115 | continue-on-error: true 116 | run: gh label create "assignments ✍️" --description "Release of assignment instructions, assignment pages, marking criteria, etc." --color "d4c6b2" 117 | env: 118 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 119 | 120 | - name: label_new_feature 121 | if: contains(github.event.head_commit.message, 'Initial commit') 122 | continue-on-error: true 123 | run: gh label create "references 📚" --description "Changes to syllabus, academic references, "read more" links, etc." --color "e9f4e2" 124 | env: 125 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 126 | 127 | - name: label_newcomers 128 | if: contains(github.event.head_commit.message, 'Initial commit') 129 | continue-on-error: true 130 | run: gh label create "roadmap 🛣️" --description "Computer lab (or seminar) roadmap, detailing the steps students will take or the items for discussio" --color "eff8f3" 131 | env: 132 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 133 | 134 | - name: label_refactoring 135 | if: contains(github.event.head_commit.message, 'Initial commit') 136 | continue-on-error: true 137 | run: gh label create "refactoring ♻️" --description "Some things just have to be re-done or re-organized" --color "C2E0C6" 138 | env: 139 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 140 | 141 | - name: label_sprint 142 | if: contains(github.event.head_commit.message, 'Initial commit') 143 | continue-on-error: true 144 | run: gh label create "sprint ➡️" --description "Tasks to be done on the current sprint" --color "D5EEF5" 145 | env: 146 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 147 | 148 | - name: label_dataviz 149 | if: contains(github.event.head_commit.message, 'Initial commit') 150 | continue-on-error: true 151 | run: gh label create "dataviz 🖼️" --description "Visualisation-related stuff" --color "212121" 152 | env: 153 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 154 | 155 | - name: disable_workflow 156 | continue-on-error: true 157 | run: gh workflow disable initial-setup 158 | env: 159 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 160 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml_: -------------------------------------------------------------------------------- 1 | on: 2 | workflow_dispatch: 3 | push: 4 | branches: main 5 | 6 | name: Quarto Publish 7 | 8 | jobs: 9 | build-deploy: 10 | runs-on: ubuntu-latest 11 | permissions: 12 | contents: write 13 | steps: 14 | - name: Check out repository 15 | uses: actions/checkout@v2 16 | 17 | - name: Install jupyter 18 | run: python3 -m pip install jupyterlab==3.6.0 pandas==1.5.3 numpy==1.24 19 | 20 | - uses: r-lib/actions/setup-r@v2 21 | with: 22 | use-public-rspm: true 23 | 24 | - name: Install rmarkdown 25 | run: install.packages("rmarkdown");install.packages("ggplot2") 26 | shell: Rscript {0} 27 | 28 | - name: Set up Quarto 29 | uses: quarto-dev/quarto-actions/setup@v2 30 | 31 | - name: Render and Publish 32 | uses: quarto-dev/quarto-actions/publish@v2 33 | with: 34 | target: gh-pages 35 | env: 36 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 37 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Node rules: 2 | ## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 3 | .grunt 4 | 5 | ## Dependency directory 6 | ## Commenting this out is preferred by some people, see 7 | ## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git 8 | node_modules 9 | 10 | # Book build output 11 | _book 12 | 13 | # eBook build output 14 | *.epub 15 | *.mobi 16 | *.pdf 17 | 18 | /.quarto/ 19 | /_output/ 20 | /_site/ 21 | /site_libs/ 22 | 23 | # History files 24 | .Rhistory 25 | .Rapp.history 26 | 27 | # Session Data files 28 | .RData 29 | .RDataTmp 30 | 31 | # User-specific files 32 | .Ruserdata 33 | 34 | # Example code in package build process 35 | *-Ex.R 36 | 37 | # Output files from R CMD build 38 | /*.tar.gz 39 | 40 | # Output files from R CMD check 41 | /*.Rcheck/ 42 | 43 | # RStudio files 44 | .Rproj.user/ 45 | 46 | # produced vignettes 47 | vignettes/*.html 48 | vignettes/*.pdf 49 | 50 | # OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 51 | .httr-oauth 52 | 53 | # knitr and R markdown default cache directories 54 | *_cache/ 55 | /cache/ 56 | 57 | # Temporary files created by R markdown 58 | *.utf8.md 59 | *.knit.md 60 | 61 | # R Environment Variables 62 | .Renviron 63 | 64 | # pkgdown site 65 | docs/ 66 | 67 | # translation temp files 68 | po/*~ 69 | 70 | # RStudio Connect folder 71 | rsconnect/ 72 | 73 | ## PYTHON 74 | 75 | # Byte-compiled / optimized / DLL files 76 | __pycache__/ 77 | *.py[cod] 78 | *$py.class 79 | 80 | # C extensions 81 | *.so 82 | 83 | # Distribution / packaging 84 | .Python 85 | build/ 86 | develop-eggs/ 87 | dist/ 88 | downloads/ 89 | eggs/ 90 | .eggs/ 91 | lib/ 92 | lib64/ 93 | parts/ 94 | sdist/ 95 | var/ 96 | wheels/ 97 | share/python-wheels/ 98 | *.egg-info/ 99 | .installed.cfg 100 | *.egg 101 | MANIFEST 102 | 103 | # PyInstaller 104 | # Usually these files are written by a python script from a template 105 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 106 | *.manifest 107 | *.spec 108 | 109 | # Installer logs 110 | pip-log.txt 111 | pip-delete-this-directory.txt 112 | 113 | # Unit test / coverage reports 114 | htmlcov/ 115 | .tox/ 116 | .nox/ 117 | .coverage 118 | .coverage.* 119 | .cache 120 | nosetests.xml 121 | coverage.xml 122 | *.cover 123 | *.py,cover 124 | .hypothesis/ 125 | .pytest_cache/ 126 | cover/ 127 | 128 | # Translations 129 | *.mo 130 | *.pot 131 | 132 | # Django stuff: 133 | *.log 134 | local_settings.py 135 | db.sqlite3 136 | db.sqlite3-journal 137 | 138 | # Flask stuff: 139 | instance/ 140 | .webassets-cache 141 | 142 | # Scrapy stuff: 143 | .scrapy 144 | 145 | # Sphinx documentation 146 | docs/_build/ 147 | 148 | # PyBuilder 149 | .pybuilder/ 150 | target/ 151 | 152 | # Jupyter Notebook 153 | .ipynb_checkpoints 154 | 155 | # IPython 156 | profile_default/ 157 | ipython_config.py 158 | 159 | # pyenv 160 | # For a library or package, you might want to ignore these files since the code is 161 | # intended to run in multiple environments; otherwise, check them in: 162 | # .python-version 163 | 164 | # pipenv 165 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 166 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 167 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 168 | # install all needed dependencies. 169 | #Pipfile.lock 170 | 171 | # poetry 172 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 173 | # This is especially recommended for binary packages to ensure reproducibility, and is more 174 | # commonly ignored for libraries. 175 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 176 | #poetry.lock 177 | 178 | # pdm 179 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 180 | #pdm.lock 181 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 182 | # in version control. 183 | # https://pdm.fming.dev/#use-with-ide 184 | .pdm.toml 185 | 186 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 187 | __pypackages__/ 188 | 189 | # Celery stuff 190 | celerybeat-schedule 191 | celerybeat.pid 192 | 193 | # SageMath parsed files 194 | *.sage.py 195 | 196 | # Environments 197 | .env 198 | .venv 199 | env/ 200 | venv/ 201 | ENV/ 202 | env.bak/ 203 | venv.bak/ 204 | 205 | # Spyder project settings 206 | .spyderproject 207 | .spyproject 208 | 209 | # Rope project settings 210 | .ropeproject 211 | 212 | # mkdocs documentation 213 | /site 214 | 215 | # mypy 216 | .mypy_cache/ 217 | .dmypy.json 218 | dmypy.json 219 | 220 | # Pyre type checker 221 | .pyre/ 222 | 223 | # pytype static type analyzer 224 | .pytype/ 225 | 226 | # Cython debug symbols 227 | cython_debug/ 228 | 229 | # PyCharm 230 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 231 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 232 | # and can be added to the global gitignore or merged into this file. For a more nuclear 233 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 234 | #.idea/ 235 | 236 | 237 | .vscode/ -------------------------------------------------------------------------------- /2023/index.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "MY_COURSE_CODE - MY_COURSE_NAME" 3 | subtitle: "Academic Year: 2022/23" 4 | format: html 5 | --- 6 | 7 | ::: {.callout-important collapse=false} 8 | ## 📢 Important 9 | 10 | (12/03/2023) 11 | 12 | - [🗓️ Week 01 lecture material](/2023/weeks/week01/page.qmd) is now available! 13 | 14 | ::: 15 | 16 | 17 | # 🧑🏻‍🏫 Our Team 18 | 19 | ::: {.panel-tabset} 20 | ## Course Convenor 21 | 22 | 23 | ![](/figures/people/professor_octopus.png){fig-align="left" fig-alt="Photo of Dr. MY NAME" style="object-fit: cover;width:5em;height:5em;border-radius: 50%;"} 24 | **[MY_NAME](#)**
25 | _MY_JOB_TITLE_
26 | [MY_INSTITUTION](#)
27 | 📧 [MY_EMAIL](mailto:) 28 | 29 | Office Hours: 30 | 31 | - When: 32 | - Where: 33 | - How to book: 34 | 35 | ## Teaching Staff 36 | 37 | ![](/figures/people/ta_octopunian.png){fig-align="left" fig-alt="Photo of TA_NAME" style="object-fit: cover;width:5em;height:5em;border-radius: 50%;"} 38 | **[TA_NAME](#)**
39 | PhD Candidate at PLACE
40 | 📧 [EMAIL](mailto:) 41 | 42 | ![](/figures/people/ta_octopunian2.png){fig-align="left" fig-alt="Photo of TA_NAME" style="object-fit: cover;width:5em;height:5em;border-radius: 50%;"} 43 | **[TA_NAME](#)**
44 | PhD Candidate at PLACE
45 | 📧 [EMAIL](mailto:) 46 | 47 | 48 | ::: 49 | 50 | # 📍 Lecture 51 | 52 | Fridays 2pm-4pm at PLACE 53 | 54 | # 💻 Class Groups 55 | 56 | ::: {style="display:inline-block;width: 28.5%;border-style: dotted;border-width: 1px;border-color: "#fefefe"; margin:1%;padding:1.5%;background-color:#fafafa"} 57 | **Group 01** 58 | 59 | - 📆 Mondays 60 | - ⌚ 09:00 - 10:30 61 | - 📍 62 | - 🧑‍🏫 _TA_NAME_ 63 | ::: 64 | 65 | ::: {style="display:inline-block;width: 28.5%;border-style: dotted;border-width: 1px;border-color: "#fefefe"; margin:1%;padding:1.5%;background-color:#fafafa"} 66 | **Group 02** 67 | 68 | 69 | - 📆 Mondays 70 | - ⌚ 10:30 - 12:00 71 | - 📍 72 | - 🧑‍🏫 _TA_NAME_ 73 | 74 | ::: 75 | 76 | ::: {style="display:inline-block;width: 28.5%;border-style: dotted;border-width: 1px;border-color: "#fefefe"; margin:1%;padding:1.5%;background-color:#fafafa"} 77 | **Group 03** 78 | 79 | - 📆 Fridays 80 | - ⌚ 16:00 - 17:30 81 | - 📍 82 | - 🧑‍🏫 _TA_NAME_ 83 | ::: 84 | -------------------------------------------------------------------------------- /2023/weeks/week01/page.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "🗓️ Week 01 - Introduction, Context & Key Concepts" 3 | --- 4 | 5 | In this first week, we will cover what you can expect to learn from this course and the course logistics: all you need to know about the structure of the lectures, classes, assessments, and how we will interact throughout this course. 6 | 7 | ## 👨‍🏫 Lecture Slides 8 | 9 | Either click on the slide area below or click [here](slides.qmd) to view it in fullscreen. 10 | Use your keypad to navigate the slides. 11 | 12 |
13 | 14 |
15 | 16 | 🎥 Looking for lecture recordings? You can only find those on Moodle. 17 | 18 | ## ✍️ Coursework 19 | 20 | 🚧 Come back after the lecture to read the coursework instructions for the week 🚧 21 | 22 | 23 | ## 📚 Recommended Reading 24 | 25 | - Check the end of slides for the list of references cited in the lecture. 26 | 27 | ## 📟 Communication 28 | 29 | - If you feel like it, introduce yourself in the `#introductions` channel on Slack -------------------------------------------------------------------------------- /2023/weeks/week01/slides.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | subtitle: "MY_COURSE_CODE -- MY_COURSE_NAME" 3 | title: "🗓️ Week 01
Introduction
" 4 | author: Prof. [Octopian](#) 5 | institute: '[University of Octopus Studies](#)' 6 | date: 14 March 2023 7 | date-meta: 14 March 2023 8 | date-format: "DD MMM YYYY" 9 | toc: true 10 | toc-depth: 1 11 | toc-title: "What we will cover today:" 12 | center-title-slide: false 13 | from: markdown+emoji 14 | format: 15 | revealjs: 16 | fig-responsive: true 17 | theme: simple 18 | slide-number: true 19 | mouse-wheel: false 20 | preview-links: auto 21 | logo: /figures/icons/course_favicon.png 22 | css: /css/styles_slides.css 23 | footer: 'MY_COURSE_CODE -- MY_COURSE_NAME' 24 | --- 25 | 26 | # Who are we 27 | 28 | ## Your lecturer {.smaller} 29 | 30 | ::: columns 31 | 32 | ::: {.column style="display:inline-block;width:40%;height:60%;border-radius:1em;margin:1%;padding:1.5%;background-color:#f5f5f5"} 33 |
34 | Photo of Professor Octopian 35 |
36 | Prof. Octopian 37 |
Professor of Octopus Issues 38 |
Head of the Python vs R Debate Society 39 |
40 |
41 | ::: 42 | 43 | ::: {.column style="width:50%;font-size:0.85em;margin-left:3%;"} 44 | - PhD in Octopi Engineering 45 | - **Background**: Engineering of Deep Ocean constructions 46 | - Former **Lead Data Scientist** 47 | 48 | deep ocean 49 |
50 | engineering 51 |
52 | octopus 53 | 54 | ::: 55 | 56 | ::: 57 | 58 | ## Teaching Assistants {.smaller} 59 | 60 | ::: columns 61 | 62 | ::: {.column style="display:inline-block;width:40%;height:60%;border-radius:1em;margin:1%;padding:1.5%;background-color:#f5f5f5"} 63 |
64 | Image Created with DALL·E. Prompt: 'octopus-like alien futuristic non-binary happy teaching assistant, phd student Octopunian, award-winning professional high-quality studio headshot' 65 |
66 | Octopnuian Arveda 67 |
68 | PhD Candidate at [OctopusLab, OUN](#)
69 | MSc in Octopus Transportation
70 | 📧 71 |
72 |
73 |
74 | ::: 75 | 76 | ::: {.column style="display:inline-block;width:40%;height:60%;border-radius:1em;margin:1%;padding:1.5%;background-color:#f5f5f5"} 77 |
78 | Image Created with DALL·E. Prompt: 'octopus-like alien futuristic non-binary happy teaching assistant, phd student Octopunian, award-winning professional high-quality studio headshot' 79 |
80 | Octopnuian Arveda 81 |
82 | PhD Candidate at [OctopusLab, UOS](#)
83 | MSc in Octopus Transportation
84 | 📧 85 |
86 |
87 |
88 | ::: 89 | 90 | ::: -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Quarto template for university courses 2 | 3 |
4 | Image Created with DALL·E. Prompt: 'octopus-like alien futuristic teacher, abstract award-winning material design favicon blue flat colours' 5 |
6 | 7 | Image created with DALL·E. Prompt: 'octopus-like alien futuristic teacher, abstract award-winning material design favicon blue flat colours' 8 | 9 |
10 | 11 |
12 | 13 | 14 | A template for developing university courses using Quarto. 15 | 16 | **Real Examples:** 17 | 18 | - [LSE DS101](https://lse-dsi.github.io/DS101/) - Fundamentals of Data Science 19 | - [LSE DS105](https://lse-dsi.github.io/DS105/) - Data for Data Science 20 | - [LSE DS202](https://lse-dsi.github.io/DS202/) - Data Science for Social Scientists 21 | - [LSE ME204](https://lse-dsi.github.io/ME204/) - Data Engineering for the Social World 22 | 23 | **New to Quarto?** 24 | 25 | You will need to understand the basics of the following features of Quarto to make the most of this template. It's worth it! 26 | 27 | - Check [their initial tutorial](https://quarto.org/docs/get-started/) 28 | - Then read about [Quarto websites](https://quarto.org/docs/websites/) 29 | - Check out also [Revealjs tutorial](https://quarto.org/docs/presentations/revealjs/) to learn how to create modern slides 30 | - Then move on to learn about [Quarto projects](https://quarto.org/docs/projects/quarto-projects.html) 31 | 32 | There you go. You might be wondering how to put all of this to work. That is precisely why this template exists! 33 | 34 | # 💡 How to use this template 35 | 36 |
On GitHub: 37 | 38 | 1. Click on the green button **Use this template** then **Create a new repository**. 39 | 40 | 2. Wait for GitHub to copy the files and run the initial setup (you will see this on the **Actions** tab). 41 |
42 | 43 |
Locally in your computer: 44 | 45 | 3. Clone your newly created repository to your computer. 46 | 47 | 4. Follow the instructions written below in the 🧰 [Dev Setup](#dev-setup) section. 48 | 49 | 5. Skip the R or Python setup if you do not plan on working in one of these languages. 50 | 51 |
52 | 53 |
Start editing the files: 54 | 55 | Here is a guide of the initial files you might want to modify to remove the sections that refer to the template, leaving only what is relevant to developing/updating the material of your course. 56 | 57 | 6. Start by editing the `README.md` file carefully. 58 | - Change the title 59 | - Remove some of the sections 60 | - Edit the Dev Setup instructions to cater to your needs. 61 | 7. Add your **course code** and **course name** to the web pages 62 | 63 | - If you are using VSCode, you can Ctrl + Shift + F (or ⌘ + Shift + F if you are on Mac) and replace all occurrences of `MY_COURSE_CODE` and `MY_COURSE_NAME` to the code and name of your course, respectively. 64 | - Or, you can manually edit those in the following files: 65 | - `_quarto.yml` 66 | - `2023/index.qmd` 67 | - `helpers/remove-nav.html` 68 | 69 | 8. Then move on to `_quarto.yml`. Scan through this file to spot what you want to change. What pages do you want to keep or remove from your website? 70 | 71 | 9. Next, modify the content of `index.qmd` and start working properly on your content pages under `2023/*` 72 | 73 | 10. Visualise your changes by running the Quarto website locally: 74 | 75 | ```bash 76 | quarto preview . --render all --no-browser 77 | ``` 78 |
79 | 80 | # 🧰 Dev Setup 81 | 82 | On top of the setup below, I also recommend you use [VSCode](https://code.visualstudio.com/Download) as your primary IDE. 83 | 84 |
🐍 The Python setup 85 | 86 | ## 🐍 The Python setup 87 | 88 | 1. Install [Python 3.8](python.org) or higher on your computer. 89 | 2. Install [anaconda](https://www.anaconda.com/products/individual) or [miniconda](https://docs.conda.io/en/latest/miniconda.html) on your computer. 90 | 3. Create a new `conda` environment: 91 | 92 | ```bash 93 | conda create -y -n=venv-my-course python=3.10.8 94 | ``` 95 | 96 | Never worked with conda environments before? Take some time to read [their documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). 97 | 98 | 💡 **Pro-tip**: replace `my-course` with your course code. Say, for example, `venv-ds105`. 99 | 100 | 4. Activate the environment and make sure you have `pip` installed inside that environment: 101 | 102 | ```bash 103 | # the exact `activate` command will vary depending on your OS 104 | conda activate venv-my-course 105 | ``` 106 | 107 | 💡 Remember to activate this particular `conda` environment whenever you reopen VSCode/the terminal. 108 | 109 | 10. Install required libraries 110 | 111 | ```bash 112 | pip install -r requirements.txt 113 | ``` 114 | 115 | Now, whenever you open a Jupyter Notebook, you should see the `venv-my-course` kernel available. 116 |
117 | 118 |
📊 The R setup 119 | 120 | ## 📊 The R setup 121 | 122 | 1. Open a terminal and navigate to the root of this repository. 123 | 2. Ensure you have **R version 4.2.2** or higher 124 | 3. Open the R console in this same directory and install `renv` package: 125 | ```r 126 | install.packages("renv") 127 | ``` 128 | 4. Run `renv::restore()` to install all the packages needed for this project 129 | 5. Whenever you install a new R package, run `renv::snapshot()` to save it on your renv. 130 | 131 |
132 | 133 |
The Quarto setup 134 | 135 | ## The Quarto setup 136 | 137 | 1. Install [Quarto](https://quarto.org/docs/getting-started/installation.html) on your computer. 138 | 2. Run the following command to start the website locally: 139 | 140 | ```bash 141 | quarto preview . --render all --no-browser 142 | ``` 143 | This will read the instructions from `_quarto.yml` and render the website locally. 144 | 5. Open your browser and navigate to `http://localhost:/`. That's it! 145 | 146 |
147 | 148 |
🕸️ Publishing the website 149 | 150 | ## 🕸️ Publishing the website 151 | 152 | I recommend you set up a **GitHub Action** for this. Just follow the instructions in the official [Quarto instructions](https://quarto.org/docs/publishing/github-pages.html#publish-action). 153 | 154 | 💡 This template already comes with a GitHub workflow setup. You can find it in the [.github/workflows/publish.yml_](.github/workflows/publish.yml_) file. You just need to rename it to `.github/workflows/publish.yml` (remove the underscore at the end) 155 | 156 |
157 | 158 | # 📟 Contact 159 | 160 | **✋ Questions? Suggestions?** If you are not sure how to do something with the template or have a suggestion for a new feature, start a [discussion](https://github.com/jonjoncardoso/quarto-template-for-university-courses/discussions). 161 | 162 | **🐞 Spotted any bugs?** Create a new [Issue](https://github.com/jonjoncardoso/quarto-template-for-university-courses/issues). 163 | 164 | **🖼️ Want to show us your courses?** Share a link to your public page on the [discussions page](https://github.com/jonjoncardoso/quarto-template-for-university-courses/discussions) or write me an e-mail. -------------------------------------------------------------------------------- /_quarto.yml: -------------------------------------------------------------------------------- 1 | project: 2 | type: "website" 3 | title: "MY_COURSE_NAME 2022/23" 4 | output-dir: _output 5 | render: 6 | - "index.qmd" 7 | - "2023/*.qmd" 8 | - "2023/weeks/week01/*.qmd" 9 | 10 | website: 11 | title: "MY_COURSE_NAME 2022/23" 12 | page-navigation: true 13 | reader-mode: true 14 | open-graph: true 15 | twitter-card: 16 | creator: "@" 17 | site: "\\@" 18 | favicon: "figures/icons/course_favicon.png" 19 | search: 20 | location: navbar 21 | type: textbox 22 | sidebar: 23 | style: docked 24 | contents: 25 | - href: 2023/index.qmd 26 | text: "🏠 Home" 27 | # - href: 2023/syllabus.qmd 28 | # text: "📓 Syllabus" 29 | # - href: 2023/communication.qmd 30 | # text: "📟 Communication" 31 | # - href: 2023/assignments.qmd 32 | # text: "✍️ Assignments" 33 | # contents: 34 | # - href: 2023/assignments/assignment01.qmd 35 | # text: "📝 Assignment 01" 36 | # - href: 2023/assignments/assignment02.qmd 37 | # text: "📝 Assignment 02" 38 | # - href: 2023/assignments/group_project.qmd 39 | # text: "👥 Group Project" 40 | - section: "🗓️ Weeks" 41 | contents: 42 | - href: 2023/weeks/week01/page.qmd 43 | text: Week 01 44 | contents: 45 | - href: 2023/weeks/week01/page.qmd 46 | text: 👨‍🏫 Lecture Material 47 | # - href: 2023/weeks/week01/lab.qmd 48 | # text: 💻 Lab Roadmap 49 | # - href: 2023/weeks/week01/appendix.qmd 50 | # text: 🔖 Appendix 51 | 52 | navbar: 53 | background: primary 54 | page-footer: 55 | background: light 56 | left: "Copyright 2023, MY INSTITUTION" 57 | 58 | 59 | 60 | bibliography: references/references.bib 61 | csl: references/chicago-author-date.csl 62 | 63 | 64 | format: 65 | html: 66 | author: Dr. [MY NAME](#) 67 | author-meta: Dr. MY NAME 68 | date-format: "DD MMMM YYYY" 69 | 70 | email-obfuscation: javascript 71 | link-external-newwindow: true 72 | link-external-icon: true 73 | link-external-filter: ^(?:http:|https:)\/\/(?:lse-dsi\.github\.io\/|localhost) 74 | 75 | theme: 76 | light: 77 | - journal 78 | - css/custom.scss # I use this just to change the default colour 79 | css: 80 | - css/custom_style.css 81 | - css/syllabus.css 82 | toc: true 83 | 84 | #margin-header: | 85 | # ![](/figures/logos/MY_INSTITUTION.png) 86 | 87 | -------------------------------------------------------------------------------- /css/custom.scss: -------------------------------------------------------------------------------- 1 | /*-- scss:defaults --*/ 2 | 3 | $blue: #20794D !default; 4 | /*-- scss:rules --*/ 5 | -------------------------------------------------------------------------------- /css/custom_style.css: -------------------------------------------------------------------------------- 1 | 2 | .navbar-dark .navbar-brand { 3 | color: #ffffff; 4 | } 5 | 6 | div.csl-entry { 7 | margin-top: 1rem; 8 | } 9 | 10 | div.csl-entry a::before { 11 | content: "\a"; 12 | white-space: pre; 13 | } 14 | 15 | div.csl-entry a { 16 | color: var(--bs-indigo); 17 | } 18 | 19 | /* CSS */ 20 | .button-61 { 21 | align-items: center; 22 | appearance: none; 23 | border-radius: 4px; 24 | border-style: none; 25 | box-shadow: rgba(0, 0, 0, .2) 0 3px 1px -2px,rgba(0, 0, 0, .14) 0 2px 2px 0,rgba(0, 0, 0, .12) 0 1px 5px 0; 26 | box-sizing: border-box; 27 | color: var(--bs-white); 28 | cursor: pointer; 29 | display: inline-flex; 30 | font-family: Roboto,sans-serif; 31 | font-size: .875rem; 32 | font-weight: 500; 33 | height: 36px; 34 | justify-content: center; 35 | letter-spacing: .0892857em; 36 | line-height: normal; 37 | min-width: 64px; 38 | outline: none; 39 | overflow: visible; 40 | padding: 0 16px; 41 | position: relative; 42 | text-align: center; 43 | text-decoration: none; 44 | text-transform: uppercase; 45 | transition: box-shadow 280ms cubic-bezier(.4, 0, .2, 1); 46 | user-select: none; 47 | -webkit-user-select: none; 48 | touch-action: manipulation; 49 | vertical-align: middle; 50 | will-change: transform,opacity; 51 | } 52 | 53 | .button-61:hover { 54 | box-shadow: rgba(0, 0, 0, .2) 0 2px 4px -1px, rgba(0, 0, 0, .14) 0 4px 5px 0, rgba(0, 0, 0, .12) 0 1px 10px 0; 55 | } 56 | 57 | .button-61:disabled { 58 | background-color: rgba(0, 0, 0, .12); 59 | box-shadow: rgba(0, 0, 0, .2) 0 0 0 0, rgba(0, 0, 0, .14) 0 0 0 0, rgba(0, 0, 0, .12) 0 0 0 0; 60 | color: rgba(0, 0, 0, .37); 61 | cursor: default; 62 | pointer-events: none; 63 | } 64 | 65 | .button-61:not(:disabled) { 66 | background-color: var(--bs-blue); 67 | } 68 | 69 | .button-61:focus { 70 | box-shadow: rgba(0, 0, 0, .2) 0 2px 4px -1px, rgba(0, 0, 0, .14) 0 4px 5px 0, rgba(0, 0, 0, .12) 0 1px 10px 0; 71 | } 72 | 73 | .button-61:active { 74 | box-shadow: rgba(0, 0, 0, .2) 0 5px 5px -3px, rgba(0, 0, 0, .14) 0 8px 10px 1px, rgba(0, 0, 0, .12) 0 3px 14px 2px; 75 | background: var(--bs-blue); 76 | } 77 | -------------------------------------------------------------------------------- /css/styles_slides.css: -------------------------------------------------------------------------------- 1 | table td { 2 | vertical-align: text-top; 3 | border: 0; 4 | } 5 | 6 | table tr.header { 7 | vertical-align: text-top; 8 | border: 0; 9 | background-color: #20794D; 10 | color: #ffffff; 11 | } 12 | 13 | table tbody tr.even{ 14 | padding: 0.5rem 0.5rem; 15 | background-color: transparent; 16 | box-shadow: inset 0 0 0 9999px transparent; 17 | } 18 | 19 | div.ascii table td:nth-child(3) { 20 | font-weight: bold; 21 | color: #B63072; 22 | } 23 | 24 | table tr.odd { 25 | background-color: #f1f6f4; 26 | } 27 | 28 | .reveal pre { 29 | font-size: .7em; 30 | } 31 | 32 | span.tag { 33 | display: inline-block; 34 | padding: 0 0.6em; 35 | font-size: 1em; 36 | font-weight: var(--base-text-weight-medium, 500); 37 | line-height: 1.2em; 38 | white-space: nowrap; 39 | border: 1px solid transparent; 40 | border-radius: 2em; 41 | background-color:#5C4AFE; 42 | color: #fcfcfc; 43 | margin-bottom: 0.5em; 44 | } 45 | 46 | .border { 47 | border: 1px solid #dee2e6; 48 | } 49 | 50 | .border-thick { 51 | border-width: 3px; 52 | } 53 | 54 | 55 | mark{ 56 | /* background-color:#FFFF00; */ 57 | background: none; 58 | color: #E69F25; 59 | font-weight: bold; 60 | 61 | padding-left: 0em; 62 | padding-right: 0em; 63 | margin-right: 0em; 64 | padding-top: 0em; 65 | padding-bottom: 0em; 66 | } 67 | 68 | mark.math{ 69 | color: #274f92; 70 | } 71 | 72 | mark.todo:before{ 73 | content: '📝 TODO: '; 74 | } 75 | 76 | mark.todo{ 77 | padding-right: 0.3em; 78 | } 79 | 80 | mark.idea:before{ 81 | content: '💡 Idea: ' 82 | 83 | } 84 | 85 | mark.idea{ 86 | background-color: #8FBC8F; 87 | color: #fcfcfc; 88 | padding-right: 0.3em; 89 | } 90 | 91 | mark.remove:before{ 92 | content: '' 93 | } 94 | 95 | mark.remove{ 96 | text-decoration:line-through; 97 | padding-bottom: 0.1em; 98 | } 99 | 100 | div.csl-entry { 101 | margin-bottom: 0.35em; 102 | } 103 | 104 | td { 105 | vertical-align: middle; 106 | } 107 | 108 | /* https://github.com/hakimel/reveal.js/issues/1002 */ 109 | .reveal > .slides > section > section { 110 | transform-style: flat; 111 | } 112 | 113 | /* @jonjoncardoso: The following is a trick I created to override mis-alignment of slides with multiple columns 114 | Similar to what was reported here: https://github.com/quarto-dev/quarto-cli/issues/892 */ 115 | 116 | .reveal .columns>.column>:not(ul,ol) { 117 | margin-left: 0; 118 | margin-right: 0; 119 | } 120 | 121 | .reveal .columns>.column:last-child>:not(ul,ol) { 122 | margin-right: 0; 123 | margin-left: 0; 124 | } 125 | 126 | .reveal .callout.callout-captioned .callout-icon::before { 127 | margin-top: 0.3rem; 128 | } 129 | 130 | .reveal .callout.callout-style-simple .callout-icon::before { 131 | margin-top: 0.6rem; 132 | } 133 | 134 | .reveal .callout.callout-style-default .callout-icon::before, .reveal .callout.callout-style-simple .callout-icon::before { 135 | background-size: 1.5rem 1.5rem; 136 | } 137 | 138 | .reveal div.sourceCode{ 139 | font-size: 1.4rem; 140 | } 141 | 142 | .reveal div.cell-output pre { 143 | font-size: 0.9rem; 144 | margin-top: 0.5rem; 145 | margin-bottom: 0.5rem; 146 | } 147 | 148 | /* .reveal section#title-slide h1.title{ 149 | margin-left:15%; 150 | margin-right:15%; 151 | } */ 152 | 153 | details { 154 | margin-bottom: 1em; 155 | font-size: 0.5em; 156 | } -------------------------------------------------------------------------------- /css/syllabus.css: -------------------------------------------------------------------------------- 1 | table.syllabus td { 2 | vertical-align: text-top; 3 | border: 0; 4 | } 5 | 6 | table.syllabus tbody tr.even{ 7 | padding: 0.5rem 0.5rem; 8 | background-color: transparent; 9 | box-shadow: inset 0 0 0 9999px transparent; 10 | } 11 | 12 | table.syllabus tbody tr.even:last-child { 13 | border-bottom-width: 1px; 14 | } 15 | 16 | table.syllabus tr.odd { 17 | background-color: var(--bs-blue); 18 | color: var(--bs-white); 19 | } 20 | 21 | details.special { 22 | border: 1px solid #aaa; 23 | border-radius: 4px; 24 | padding: .5em .5em 0; 25 | } 26 | 27 | details.special summary { 28 | font-weight: bold; 29 | margin: -.5em -.5em 0; 30 | padding: .5em; 31 | } 32 | 33 | details.special[open] { 34 | padding: .5em; 35 | } 36 | 37 | details.special[open] summary { 38 | border-bottom: 1px solid #aaa; 39 | margin-bottom: .5em; 40 | } -------------------------------------------------------------------------------- /figures/icons/course_favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jonjoncardoso/quarto-template-for-university-courses/199dba2e1bbda7f018b0bd3579fb515142121e0e/figures/icons/course_favicon.png -------------------------------------------------------------------------------- /figures/people/professor_octopus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jonjoncardoso/quarto-template-for-university-courses/199dba2e1bbda7f018b0bd3579fb515142121e0e/figures/people/professor_octopus.png -------------------------------------------------------------------------------- /figures/people/professor_octopus2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jonjoncardoso/quarto-template-for-university-courses/199dba2e1bbda7f018b0bd3579fb515142121e0e/figures/people/professor_octopus2.png -------------------------------------------------------------------------------- /figures/people/ta_octopunian.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jonjoncardoso/quarto-template-for-university-courses/199dba2e1bbda7f018b0bd3579fb515142121e0e/figures/people/ta_octopunian.png -------------------------------------------------------------------------------- /figures/people/ta_octopunian2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jonjoncardoso/quarto-template-for-university-courses/199dba2e1bbda7f018b0bd3579fb515142121e0e/figures/people/ta_octopunian2.png -------------------------------------------------------------------------------- /helpers/README.md: -------------------------------------------------------------------------------- 1 | This directory contains cheap hacks to hide the navigation bar and title from the home page of the website. -------------------------------------------------------------------------------- /helpers/remove-nav.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /helpers/remove-title.html: -------------------------------------------------------------------------------- 1 | 5 | -------------------------------------------------------------------------------- /index.qmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "MY COURSE CODE - MY COURSE NAME" 3 | format: 4 | html: 5 | include-before-body: helpers/remove-nav.html 6 | include-after-body: helpers/remove-title.html 7 | --- 8 | 9 | # 📑 Course Brief 10 | 11 | **Focus:** the focus of this course is to learn stuff 12 | 13 | **How:** hands-on learning 14 | 15 | # 🎯 Learning Objectives 16 | 17 | - You will discover how to do X 18 | - Distinguish X from **X** 19 | - Practice how to put things _in italic_ 20 | - Discover how to highlight `code` inline 21 | - Proceed to learn stuff 22 | 23 | 24 | ----------------- 25 | 26 | **Select Academic Year/Term:** 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /references/README.md: -------------------------------------------------------------------------------- 1 | Update `references.bib` with your own BibTeX file to use citations on your website. -------------------------------------------------------------------------------- /references/chicago-author-date.csl: -------------------------------------------------------------------------------- 1 | 2 | 683 | -------------------------------------------------------------------------------- /references/references.bib: -------------------------------------------------------------------------------- 1 | 2 | @book{hall2000internet, 3 | title={Internet Core Protocols: The Definitive Guide: Help for Network Administrators}, 4 | author={Hall, Eric}, 5 | year={2000}, 6 | publisher={" O'Reilly Media, Inc."} 7 | } 8 | 9 | @book{pelz_fundamentals_2018, 10 | address = {Birmingham}, 11 | title = {Fundamentals of {Linux}: {Explore} the {Essentials} of the {Linux} {Command} {Line}}, 12 | isbn = {9781789537529}, 13 | shorttitle = {Fundamentals of {Linux}}, 14 | abstract = {Linux is a Unix-like computer operating system assembled under the model of free and open-source software development and distribution. This book will teach all the important command-line tools and utilities using real-world examples. You'll learn everything you need to know as a new Linux system administrator}, 15 | language = {eng}, 16 | publisher = {Packt Publishing Ltd}, 17 | author = {Pelz, Oliver}, 18 | year = {2018}, 19 | note = {OCLC: 1045044188}, 20 | } 21 | 22 | @book{ebrahim_mastering_2018, 23 | address = {Birmingham}, 24 | edition = {2nd ed}, 25 | title = {Mastering {Linux} {Shell} {Scripting}: a practical guide to {Linux} command-line, {Bash} scripting, and {Shell} programming, 2nd {Edition}}, 26 | isbn = {9781788990158}, 27 | shorttitle = {Mastering {Linux} {Shell} {Scripting}}, 28 | abstract = {Shell scripting is a quick method to prototype a complex application or a problem by automating tasks when working on Linux-based systems. This book will make use of both simple one-line commands and command sequences and complex problems can be solved with ease, from text processing to backing up sysadmin tools}, 29 | language = {eng}, 30 | publisher = {Packt Publishing}, 31 | author = {Ebrahim, Mokhtar and Mallett, Andrew}, 32 | year = {2018}, 33 | note = {OCLC: 1034631829}, 34 | } 35 | 36 | @misc{computer_history_museum_1950_nodate, 37 | title = {1950 {\textbar} {Timeline} of {Computer} {History}}, 38 | url = {https://www.computerhistory.org/timeline/1950/}, 39 | language = {en}, 40 | urldate = {2022-09-16}, 41 | journal = {1950 {\textbar} Timeline of Computer History}, 42 | author = {{Computer History Museum}}, 43 | } 44 | 45 | @book{silberschatz_operating_2005, 46 | address = {Hoboken, NJ}, 47 | edition = {7th ed}, 48 | title = {Operating system concepts}, 49 | isbn = {9780471694663}, 50 | publisher = {J. Wiley \& Sons}, 51 | author = {Silberschatz, Abraham and Galvin, Peter B. and Gagne, Greg}, 52 | year = {2005}, 53 | keywords = {Operating systems (Computers)}, 54 | } 55 | 56 | @misc{hartl_using_2020, 57 | type = {Online {Course}}, 58 | title = {Using {Z} {Shell} on {Macs} with the {Learn} {Enough} {Tutorials}}, 59 | shorttitle = {Using {Z} {Shell} on {Macs}}, 60 | url = {https://news.learnenough.com/macos-bash-zshell}, 61 | abstract = {News \& blog about Learn Enough (including the Ruby on Rails Tutorial)}, 62 | language = {en-us}, 63 | urldate = {2022-08-31}, 64 | journal = {Learn Enough News \& Blog}, 65 | author = {Hartl, Michael}, 66 | month = apr, 67 | year = {2020}, 68 | } 69 | 70 | @misc{abubakar_what_2021, 71 | type = {Blogpost}, 72 | title = {What {Is} {Ubuntu}?}, 73 | shorttitle = {What {Is} {Ubuntu}?}, 74 | url = {https://www.howtogeek.com/763775/what-is-ubuntu/}, 75 | abstract = {In online discussions, you may have heard the term “Ubuntu” thrown around, often in the context of discussing alternatives to Windows. So what exactly is it, and why do people choose to use it?}, 76 | language = {en-US}, 77 | urldate = {2022-08-31}, 78 | journal = {How-To Geek}, 79 | author = {Abubakar, Mohammed}, 80 | month = dec, 81 | year = {2021}, 82 | } 83 | 84 | @misc{canonical_install_2022, 85 | type = {Tutorial}, 86 | title = {Install {Ubuntu} on {WSL2} on {Windows} 11 with {GUI} support}, 87 | shorttitle = {Install {Ubuntu} on {WSL2} on {Windows} 11 with {GUI} support}, 88 | url = {https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support}, 89 | abstract = {Ubuntu is an open source software operating system that runs from the desktop, to the cloud, to all your internet connected things.}, 90 | language = {en}, 91 | urldate = {2022-08-31}, 92 | journal = {Ubuntu}, 93 | author = {{Canonical}}, 94 | year = {2022}, 95 | } 96 | 97 | @misc{microsoft_what_2022, 98 | type = {Tutorial}, 99 | title = {What is {Windows} {Subsystem} for {Linux}}, 100 | shorttitle = {What is {Windows} {Subsystem} for {Linux}}, 101 | url = {https://docs.microsoft.com/en-us/windows/wsl/about}, 102 | abstract = {Learn about the Windows Subsystem for Linux, including the different versions and ways you can use them.}, 103 | language = {en-us}, 104 | urldate = {2022-08-31}, 105 | journal = {What is Windows Subsystem for Linux}, 106 | author = {{Microsoft}}, 107 | month = aug, 108 | year = {2022}, 109 | } 110 | 111 | @article{brandies_ten_2021, 112 | title = {Ten simple rules for getting started with command-line bioinformatics}, 113 | volume = {17}, 114 | issn = {1553-7358}, 115 | url = {https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1008645}, 116 | doi = {10.1371/journal.pcbi.1008645}, 117 | language = {en}, 118 | number = {2}, 119 | urldate = {2022-08-30}, 120 | journal = {PLOS Computational Biology}, 121 | author = {Brandies, Parice A. and Hogg, Carolyn J.}, 122 | month = feb, 123 | year = {2021}, 124 | keywords = {Bioinformatics, Cloud computing, Computational pipelines, Computer software, Operating systems, Programming languages, Software tools, Source code}, 125 | pages = {e1008645}, 126 | } 127 | 128 | @book{schutt_doing_2013, 129 | address = {Beijing ; Sebastopol}, 130 | edition = {First edition}, 131 | title = {Doing data science}, 132 | isbn = {9781449358655}, 133 | url = {https://ebookcentral.proquest.com/lib/londonschoolecons/detail.action?docID=1465965}, 134 | publisher = {O'Reilly Media}, 135 | author = {Schutt, Rachel and O'Neil, Cathy}, 136 | year = {2013}, 137 | note = {OCLC: ocn827841776}, 138 | keywords = {Big data, Cyberinfrastructure, Data mining, Data structures (Computer science), Database management, Information science}, 139 | } 140 | 141 | @book{gelman_regression_2020, 142 | edition = {1}, 143 | title = {Regression and {Other} {Stories}}, 144 | isbn = {9781139161879 9781107023987 9781107676510}, 145 | url = {https://www.cambridge.org/highereducation/product/9781139161879/book}, 146 | abstract = {Most textbooks on regression focus on theory and the simplest of examples. Real statistical problems, however, are complex and subtle. This is not a book about the theory of regression. It is about using regression to solve real problems of comparison, estimation, prediction, and causal inference. Unlike other books, it focuses on practical issues such as sample size and missing data and a wide range of goals and techniques. It jumps right in to methods and computer code you can use immediately. Real examples, real stories from the authors' experience demonstrate what regression can do and its limitations, with practical advice for understanding assumptions and implementing methods for experiments and observational studies. They make a smooth transition to logistic regression and GLM. The emphasis is on computation in R and Stan rather than derivations, with code available online. Graphics and presentation aid understanding of the models and model fitting.}, 147 | urldate = {2022-08-26}, 148 | publisher = {Cambridge University Press}, 149 | author = {Gelman, Andrew and Hill, Jennifer and Vehtari, Aki}, 150 | month = jul, 151 | year = {2020}, 152 | doi = {10.1017/9781139161879}, 153 | } 154 | 155 | @misc{ortiz-ospina_rise_2019, 156 | title = {The rise of social media}, 157 | url = {https://ourworldindata.org/rise-of-social-media}, 158 | abstract = {Social media sites are used by more than two-thirds of all internet users. When did the rise of social media start and what are the largest sites today?}, 159 | urldate = {2022-08-25}, 160 | journal = {Our World in Data}, 161 | author = {Ortiz-Ospina, Esteban}, 162 | month = sep, 163 | year = {2019}, 164 | } 165 | 166 | @misc{kolawole_about_2013, 167 | title = {About those 2005 and 2013 photos of the crowds in {St}. {Peter}’s {Square}}, 168 | url = {http://wapo.st/WKKTMh}, 169 | abstract = {Two photos showing how our technological lives have changed are compelling, but not a direct comparison.}, 170 | language = {en-US}, 171 | urldate = {2022-08-25}, 172 | journal = {Washington Post}, 173 | author = {Kolawole, Emi}, 174 | month = mar, 175 | year = {2013}, 176 | } 177 | 178 | @misc{fischer-baum_what_2017, 179 | title = {What ‘tech world’ did you grow up in?}, 180 | url = {https://www.washingtonpost.com/graphics/2017/entertainment/tech-generations/}, 181 | abstract = {How did people watch videos, listen to music or access the internet in other generations?}, 182 | language = {en}, 183 | urldate = {2022-08-25}, 184 | journal = {Washington Post}, 185 | author = {Fischer-Baum, Reuben}, 186 | month = nov, 187 | year = {2017}, 188 | } 189 | 190 | @book{shah_hands-introduction_2020, 191 | address = {Cambridge, United Kingdom ; New York, NY, USA}, 192 | title = {A hands-on introduction to data science}, 193 | isbn = {9781108560412}, 194 | url = {https://librarysearch.lse.ac.uk/permalink/f/1n2k4al/TN_cdi_askewsholts_vlebooks_9781108673907}, 195 | abstract = {"This book introduces the field of data science in a practical and accessible manner, using a hands-on approach that assumes no prior knowledge of the subject. The foundational ideas and techniques of data science are provided independently from technology, allowing students to easily develop a firm understanding of the subject without a strong technical background, as well as being presented with material that will have continual relevance even after tools and technologies change. Using popular data science tools such as Python and R, the book offers many examples of real-life applications, with practice ranging from small to big data. A suite of online material for both instructors and students provides a strong supplement to the book, including datasets, chapter slides, solutions, sample exams and curriculum suggestions. This entry-level textbook is ideally suited to readers from a range of disciplines wishing to build a practical, working knowledge of data science"--}, 196 | publisher = {Cambridge University Press}, 197 | author = {Shah, Chirag}, 198 | year = {2020}, 199 | keywords = {Computer science, Information technology}, 200 | } 201 | 202 | @article{davenport_beyond_2020, 203 | title = {Beyond {Unicorns}: {Educating}, {Classifying}, and {Certifying} {Business} {Data} {Scientists}}, 204 | volume = {2}, 205 | shorttitle = {Beyond {Unicorns}}, 206 | url = {https://hdsr.mitpress.mit.edu/pub/t37qjoi7/release/4}, 207 | doi = {10.1162/99608f92.55546b4a}, 208 | abstract = {There is increasing recognition that the data scientist ‘unicorn’—one who can master all the necessary skills of data science required by businesses—exists only rarely, if at all. Successful data science teams in business organizations, then, need to assemble people with a variety of different skills. This is only possible at scale with clear classification and certification of skills. While such certifications and classifications are in their early days, some firms are beginning to create them, and they are beginning to emerge in professional associations as well. Ideally, universities and other education providers and certifiers of data science skills would also employ standard skill classifications to communicate the skills they intend to inculcate.}, 209 | language = {en}, 210 | number = {2}, 211 | urldate = {2022-08-22}, 212 | journal = {Harvard Data Science Review}, 213 | author = {Davenport, Thomas}, 214 | month = may, 215 | year = {2020}, 216 | } 217 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # Regular DS stuff 2 | pandas==1.5.3 3 | 4 | # Web scraping/APIs 5 | requests==2.28.2 6 | beautifulsoup4==4.11.2 7 | 8 | # Data viz 9 | plotnine==0.10.1 10 | 11 | 12 | # Stuff VSCode needs 13 | ipykernel==6.21.2 14 | jupyterlab==3.6.1 --------------------------------------------------------------------------------