Skip to content

Commit

Permalink
Merge pull request #92 from AccelerationConsortium/tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
sgbaird authored Oct 12, 2024
2 parents 44c5abb + 82587c9 commit fb37101
Show file tree
Hide file tree
Showing 12 changed files with 78 additions and 631 deletions.
18 changes: 9 additions & 9 deletions docs/course-data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ software-dev:
- "Commit, push, and pull changes"
- "Run a unit test and fix a simple Python function"
- "Define continuous integration"
- module_name: "Deep dive into Git and GitHub"
- module_name: "4.1 Deep dive into Git and GitHub"
tutorial_file: 4.1-github-deep-dive.md
topics:
- "GitHub issues"
Expand All @@ -590,7 +590,7 @@ software-dev:
- "Create a new branch"
- "Merge a GitHub pull request"
- "Resolve a merge conflict"
- module_name: "Setting up VS Code"
- module_name: "4.2 Setting up VS Code"
tutorial_file: 4.2-vscode-setup.md
topics:
- "IDEs"
Expand All @@ -606,7 +606,7 @@ software-dev:
- "Set up VS Code"
- "Install Miniconda"
- "Install VS Code extensions"
- module_name: "Debugging in VS Code"
- module_name: "4.3 Debugging in VS Code"
tutorial_file: 4.3-vscode-debugging.md
topics:
- "Print statements"
Expand All @@ -622,7 +622,7 @@ software-dev:
- "Step through code"
- "Use the debug console"
- "Set up debug configurations"
- module_name: "Unit testing"
- module_name: "4.4 Unit testing"
tutorial_file: 4.4-unit-testing.md
topics:
- "pytest"
Expand All @@ -639,7 +639,7 @@ software-dev:
# Coding best practices? (e.g., modularity, readability, PEP8, object-oriented programming, etc.)
# Linting and code formatting? (e.g., black, flake8, isort, etc., especially VS Code Extensions)
# VS Code extensions? (e.g., Python, Jupyter, Git, etc.)
- module_name: "Automated documentation"
- module_name: "4.5 Automated docs"
tutorial_file: 4.5-automated-docs.md
topics:
- "Markdown"
Expand All @@ -654,7 +654,7 @@ software-dev:
- "Set up a readthedocs account and publish a readthedocs page"
tutorial:
- "GitHub-flavored Markdown tutorial"
- module_name: "Continuous integration (CI)"
- module_name: "4.6 Continuous integration"
tutorial_file: 4.6-continuous-integration.md
topics:
- "Continuous integration"
Expand All @@ -665,7 +665,7 @@ software-dev:
- "Explain the purpose of continuous integration"
- "Set up a GitHub actions workflow"
- "Run unit tests and documentation builds on GitHub actions"
- module_name: "Project templates"
- module_name: "4.7 Project templates"
tutorial_file: 4.7-project-templates.md
topics:
- "PyScaffold"
Expand All @@ -680,7 +680,7 @@ software-dev:
- "Add project content"
- "Publish a Python package to PyPI"
- "Outline the key benefits of dependency management during software development"
- module_name: "Launching a free cloud server"
- module_name: "4.8 Launching a free cloud server"
tutorial_file: 4.8-cloud-server.md
topics:
- "Serverless computing"
Expand All @@ -692,7 +692,7 @@ software-dev:
- "Use a container"
- "Create a container"
- "Deploy a materials discovery campaign on a cloud server"
- module_name: "On-demand cloud simulations"
- module_name: "4.9 On-demand cloud simulations"
tutorial_file: 4.9-cloud-simulations.md
topics:
- "Cloud computing"
Expand Down
26 changes: 25 additions & 1 deletion docs/courses/hello-world/1.3-bayesian-optimization.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,31 @@
"- [The Olympus benchmarking package](https://aspuru-guzik-group.github.io/olympus/classes/planners/index.html) with a variety of other optimization algorithms documented\n",
"- [A `self-driving-lab-demo` discussion](https://github.com/sparks-baird/self-driving-lab-demo/discussions/57) which has a list of optimization algorithms \n",
"- [Honegumi](https://github.com/sgbaird/honegumi), an interactive \"skeleton code\" generator for optimization packages\n",
"- [AC BO Hackathon Resources](https://ac-bo-hackathon.github.io/resources/), resources for participants from the Bayesian Optimization Hackathon for Chemistry and Materials"
"- [AC BO Hackathon Resources](https://ac-bo-hackathon.github.io/resources/), resources for participants from the Bayesian Optimization Hackathon for Chemistry and Materials\n",
"\n",
"- Materials Informatics Course: Bayes Theorem and Naive Bayes Classifiers\n",
"\n",
"<div style=\"position: relative; overflow: hidden; padding-top: 50%; margin-bottom: 100px; width: 75%;\">\n",
" <iframe src=\"https://www.youtube.com/embed/26wC9WmEWlw\" title=\"YouTube video player\" style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share; fullscreen\" allowfullscreen=\"allowfullscreen\" mozallowfullscreen=\"mozallowfullscreen\" msallowfullscreen=\"msallowfullscreen\" oallowfullscreen=\"oallowfullscreen\" webkitallowfullscreen=\"webkitallowfullscreen\"></iframe>\n",
"</div>\n",
"\n",
"- Materials Informatics Course: Coding a Naive Bayes Classifier By Hand\n",
"\n",
"<div style=\"position: relative; overflow: hidden; padding-top: 50%; margin-bottom: 100px; width: 75%;\">\n",
" <iframe src=\"https://www.youtube.com/embed/_mHmo6B6NSw\" title=\"YouTube video player\" style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share; fullscreen\" allowfullscreen=\"allowfullscreen\" mozallowfullscreen=\"mozallowfullscreen\" msallowfullscreen=\"msallowfullscreen\" oallowfullscreen=\"oallowfullscreen\" webkitallowfullscreen=\"webkitallowfullscreen\"></iframe>\n",
"</div>\n",
"\n",
"- Materials Informatics Course: Gaussian Processes\n",
"\n",
"<div style=\"position: relative; overflow: hidden; padding-top: 50%; margin-bottom: 100px; width: 75%;\">\n",
" <iframe src=\"https://www.youtube.com/embed/zquAOOjG2iI\" title=\"YouTube video player\" style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share; fullscreen\" allowfullscreen=\"allowfullscreen\" mozallowfullscreen=\"mozallowfullscreen\" msallowfullscreen=\"msallowfullscreen\" oallowfullscreen=\"oallowfullscreen\" webkitallowfullscreen=\"webkitallowfullscreen\"></iframe>\n",
"</div>\n",
"\n",
"- Materials Informatics Course: Bayesian Optimization\n",
"\n",
"<div style=\"position: relative; overflow: hidden; padding-top: 50%; margin-bottom: 100px; width: 75%;\">\n",
" <iframe src=\"https://www.youtube.com/embed/qVEBO1Viv7k\" title=\"YouTube video player\" style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share; fullscreen\" allowfullscreen=\"allowfullscreen\" mozallowfullscreen=\"mozallowfullscreen\" msallowfullscreen=\"msallowfullscreen\" oallowfullscreen=\"oallowfullscreen\" webkitallowfullscreen=\"webkitallowfullscreen\"></iframe>\n",
"</div>"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/courses/hello-world/1.4.1-onboard-led-temp.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/AccelerationConsortium/ac-microcourses/blob/main/docs/courses/hello-world/1.4.1-onboard-led-temp.ipynb)\n",
"\n",
"Ensure that you've followed the instructions in the [hardware/software communication notebook](./1.4-hardware-software-communication.ipynb) to set up your Pico W microcontroller. This notebook will allow you to interact with the microcontroller via the MQTT protocol. This assumes you are using the same HiveMQ microcredentials as in this notebook (`HIVEMQ_USERNAME`, `HIVEMQ_PASSWORD`, `HIVEMQ_HOST`).\n",
"Ensure that you've followed the instructions in the [hardware/software communication notebook](./1.4-hardware-software-communication) to set up your Pico W microcontroller. This notebook will allow you to interact with the microcontroller via the MQTT protocol. This assumes you are using the same HiveMQ microcredentials as in this notebook (`HIVEMQ_USERNAME`, `HIVEMQ_PASSWORD`, `HIVEMQ_HOST`).\n",
"\n",
"<!-- Feel free to swap in your own credentials if you have them (required for the GitHub Classroom assignment), but you will need to make sure that is changed on both the microcontroller and here. -->\n",
"\n",
Expand Down
10 changes: 5 additions & 5 deletions docs/courses/hello-world/1.6-connecting-the-pieces.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ You've made it to the final module of this microcourse! Well done 🥳. In this

✅ Review the tutorials from the earlier modules. Direct links to the tutorial pages are copied here for convenience:

1. [Running the demo](./1.1-running-the-demo.ipynb)
2. [Blink and read](./1.2-blink-and-read.ipynb)
3. [Bayesian optimization](./1.3-bayesian-optimization.ipynb)
4. [Hardware-software communication](./1.4-hardware-software-communication.ipynb)
5. [Data logging](1.5-data-logging.ipynb)
1. [Running the demo](./1.1-running-the-demo)
2. [Blink and read](./1.2-blink-and-read)
3. [Bayesian optimization](./1.3-bayesian-optimization)
4. [Hardware-software communication](./1.4-hardware-software-communication)
5. [Data logging](1.5-data-logging)

✅ Review the knowledge checks via the main course website

Expand Down
Empty file.
152 changes: 0 additions & 152 deletions docs/courses/software-dev/4.1-vscode-setup.md

This file was deleted.

Loading

0 comments on commit fb37101

Please sign in to comment.