Skip to content

Commit

Permalink
fixed links and added tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
RichRick1 committed Jan 9, 2024
1 parent f5cb708 commit 639b04a
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
12 changes: 6 additions & 6 deletions book/jupyter.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,10 @@
"> Before you get started, it's helpful to [log into LinkedIn Learning](https://www.linkedin.com/learning). (However, the links provided should automatically prompt you to log in if you are not already.) If you already have a LinkedIn account associated with a different e-mail, you can link your accounts. \n",
"\n",
"## 👩🏽‍💻 Assignments\n",
"- You will learn more about Jupyter, Python, Numpy, and GitHub through the [assignment](../problems/JupyterPythonNumpy.md).\n",
"- You will learn more about how to use GitHub Classroom and Google Colaboratory through the [assignment](Tutorial_0.ipynb). (This assignment is really more of a tutorial.)\n",
"- As a first (very basic) application to quantum mechanics, you'll [normalize the wavefunction](tutorial_1.ipynb). (This assignment is also basically a tutorial.)\n",
"- A more advanced exercise including Numpy operations is to [compute student grades using a complicated grading scheme.](https://github.com/McMasterQM/grading/blob/main/grading.ipynb). [Github Classroom Link](https://classroom.github.com/a/2IRoHSuh).\n",
"- You will learn more about Jupyter, Python, Numpy, and GitHub through the [assignment](./problems/JupyterPythonNumpy.md).\n",
"- You will learn more about how to use GitHub Classroom and Google Colaboratory through the [assignment](problems/Tutorial_0.ipynb). (This assignment is really more of a tutorial.)\n",
"- As a first (very basic) application to quantum mechanics, you'll [normalize the wavefunction](problems/tutorial_1.ipynb). (This assignment is also basically a tutorial.)\n",
"- A more advanced exercise including Numpy operations is to [compute student grades using a complicated grading scheme](https://github.com/McMasterQM/grading/blob/main/grading.ipynb). [Github Classroom Link](https://classroom.github.com/a/faZ6D_fY).\n",
"\n",
"## 🪞 Self-Reflection\n",
"- What is the difference between interpreted and compiled languages? What type of language is Python? Can you explain why we need two different types of languages?\n",
Expand Down Expand Up @@ -138,7 +138,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -152,7 +152,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.3"
"version": "3.9.7"
},
"latex_envs": {
"LaTeX_envs_menu_present": true,
Expand Down
2 changes: 1 addition & 1 deletion book/problems/JupyterPythonNumpy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ This assignment consists of LinkedIn Learning courses that that cover Jupyter, p
3. Upload the certificates for [using Jupyter notebooks](../problems/Jupyter.md), [Python programming](../problems/python.md), and [using Numpy](../problems/numpy.md).
4. Invite Rik [(username: `RichRick1`)](https://github.com/RichRick1) and Paul [(username: `PaulWAyers`)](https://github.com/PaulWAyers) as external collaborators with "write" permission to this repository.

> Completing these four items suffices for an **S-** grade. For an **S** grade, complete one [additional activity](../extracredit/programming.md). For an **S+** grade, complete a total of at least three [additional activities](../extracredit/programming.md). The certificates and/or proofs-of-completion for these activities should be added to the `README.md` file in your `Course-Certificates` repository. Further activities can be added to this repository over the course of the term for (even more) additional points.
> Completing these four items suffices for an **S-** grade. For an **S** grade, complete one [additional activity](../extracredit/programming.md). For an **S+** grade, complete a total of at least three [additional activities](../extracredit/programming.md). The certificates and/or proofs-of-completion for these activities should be added to the `README.md` file in your `Course-Certificates` repository. Further activities can be added to this repository over the course of the term for (even more) additional points.
28 changes: 14 additions & 14 deletions book/problems/tutorial_1.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
"To practice Jupyter and Colab.\n",
"\n",
"## 📜 Instructions\n",
"1. Presuming you already have a GitHub account, [connect to GitHub Classroom](https://classroom.github.com/a/1DZ_qS9k). You'll see ![p1](pics/2.png)\n",
"1. Click `Accept the assignment` and then update the page ![p2](pics/3.png). You will see a new repository with the task ![p3](pics/4.png)\n",
"1. Presuming you already have a GitHub account, [connect to GitHub Classroom](https://classroom.github.com/a/KxJcE3PU). You'll see ![p1](../pics/2.png)\n",
"1. Click `Accept the assignment` and then update the page ![p2](../pics/3.png). You will see a new repository with the task ![p3](../pics/4.png)\n",
"1. To complete the assignment you need to complete the Jupyter notebook **`Normalizing_eigenfunctions.ipynb`**."
]
},
Expand All @@ -23,16 +23,16 @@
"source": [
"## Editing a Jupyter Notebook from GitHub\n",
"\n",
"As described in the [notes](https://qchem.qc-edu.org/ipynb/jupyter.html#what-is-jupyter), there are several ways to edit `.ipynb` files.\n",
"As described in the [notes](https://qchem.qc-edu.org/jupyter.html#), there are several ways to edit `.ipynb` files.\n",
"\n",
"### Using Google Colab (direct download and upload)\n",
"In this tutorial we will show how to work with Jupyter notebooks through Google Colab.\n",
"1. Download the `.zip` archive of the GitHub repo. In order to download it click `code` and `Download Zip` ![p4](pics/5.png)\n",
"1. When the repo is downloaded, go to [Google Colab](https://colab.research.google.com/) and add the `.ipynb` file from the repo: `File` $\\rightarrow$ `Upload notebook` ![p5](pics/6.png)\n",
"You will see this window ![p6](pics/7.png)\n",
"1. Download the `.zip` archive of the GitHub repo. In order to download it click `code` and `Download Zip` ![p4](../pics/5.png)\n",
"1. When the repo is downloaded, go to [Google Colab](https://colab.research.google.com/) and add the `.ipynb` file from the repo: `File` $\\rightarrow$ `Upload notebook` ![p5](../pics/6.png)\n",
"You will see this window ![p6](../pics/7.png)\n",
"1. Upload the `.ipynb` file \n",
"\n",
"Voila! ![p7](pics/8.png)\n",
"Voila! ![p7](../pics/8.png)\n",
"\n",
"### Extension for Chromium Browsers.\n",
"If you use a browser like Google Chrome or Microsoft Edge, then you can use the [Open in Colab](https://chrome.google.com/webstore/detail/open-in-colab/iogfkhleblhcpcekbiedikdehleodpjo) browser extension. Then, \n",
Expand All @@ -53,13 +53,13 @@
"...\n",
"### END YOUR CODE HERE\n",
"```\n",
"![p8](pics/9.png)\n",
"![p8](../pics/9.png)\n",
"\n",
"The purpose of this assignment is to compute the normalization constant for the particle-in-a-box. The particle-in-a-box is perhaps the simplest (bound) quantum system. You do not need to know much about the particle-in-a-box to complete this assignment however: referring to the relevant section of the [notes](https://qchem.qc-edu.org/ParticleIn1DBox.html#normalization-of-wavefunctions), one sees that one can choose $A_n = \\sqrt{\\frac{2}{a}}$.\n",
"\n",
"Once the code is completed, you can click the play button to evaluate the cell.\n",
"When you are satisfied with a code just click `File` $\\rightarrow$ `Save` and then `Download` $\\rightarrow$ `Download .ipynb`\n",
"![p9](pics/10.png)"
"![p9](../pics/10.png)"
]
},
{
Expand All @@ -70,8 +70,8 @@
"## Submitting an assignment\n",
"\n",
"Submitting the assignment is breeze!\n",
"When you downloaded the final version of the file just go to your repo and click `Add file` $\\rightarrow$ `Upload files`; then upload your newly created file ![p10](pics/11.png)\n",
"Now commit your changes and click `Commit changes` ![p11](pics/12.png)"
"When you downloaded the final version of the file just go to your repo and click `Add file` $\\rightarrow$ `Upload files`; then upload your newly created file ![p10](../pics/11.png)\n",
"Now commit your changes and click `Commit changes` ![p11](../pics/12.png)"
]
},
{
Expand All @@ -81,15 +81,15 @@
"source": [
"## Check the result\n",
"\n",
"In order to check whether your code passed tests all you need to do is go to `Actions`$\\rightarrow$ `Your commit` $\\rightarrow$ `Test with pytest`. ![p12](pics/13.png) ![p13](pics/14.png) In most cases the tests will run automatically, and you do not need to explicitly invoke Pytest.\n",
"In order to check whether your code passed tests all you need to do is go to `Actions`$\\rightarrow$ `Your commit` $\\rightarrow$ `Test with pytest`. ![p12](../pics/13.png) ![p13](../pics/14.png) In most cases the tests will run automatically, and you do not need to explicitly invoke Pytest.\n",
"\n",
"If you see a green check mark: ***CONGRATULATIONS!*** you passed the assignment \n",
"\n",
"If there is a bug, then the following may occur:\n",
"![p14](pics/15.png) ![p15](pics/16.png)\n",
"![p14](../pics/15.png) ![p15](../pics/16.png)\n",
"\n",
"Try to find your mistake but if you get stuck, contact me `@RichRick1`\n",
"![p16](pics/17.png) ![p17](pics/18.png)"
"![p16](../pics/17.png) ![p17](../pics/18.png)"
]
},
{
Expand Down

0 comments on commit 639b04a

Please sign in to comment.