diff --git a/README.md b/README.md index 1a10e3cc95ea271ba5297348baf13a39ef153c2a..171914ce79858fb79fd834e555e32886bafc7fc3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,41 @@ -A repository for storing the material for the programming portion of the -1st-year Applied Physics practicum course. +# Introduction to Python for Physicists -* Lecture notebooks -* Course information notebooks +In these repository, you can find the source code of the material developed for an introduction to Phython for Physicists that runs as a "minicourse" of 1 ECTS as part of the "Inleidend Practicum" (introduction lab course) of the Applied Physics program at TU Delft. -To get meaningful diff informatiton, we will store the notebooks paired with -markdown files using Jupytext. +The course consists of 5 core Jupyter notebooks designed for self-study. The notebooks are self-contained, and include an explanation of the concepts, example code to illustrate the concepts, and exercises (with answers at the end) for testing your knowledge. -The assignments and final project files are stored in a separate (private) -repository. \ No newline at end of file +The notebooks are designed for people with no programming background at all, and are used in the course during 5 afternoons (20 hours). By the end of the course, you should be familiar with: + +* The basic concepts of python: What is is and how it works +* Functions in python: How to write them and how to use them +* Program flow control: How to control the flow of execution of your code +* Computation in python: Introduction to the numpy library +* Data in python: How to load, plot and fit data + +Each notebook includes a list of detailed learning objectives so you know what you should be learning. + +There are also assignment notebooks from the course, which can be shared upon [request](mailto:g.a.steele@tudelft.nl). + +# How to use them + +If you want to use the notebooks for learning python, you can download this zip file: + +[Lecture_Notebooks.zip](https://gitlab.tudelft.nl/python-for-applied-physics/practicum-lecture-notes/-/jobs/artifacts/master/download?job=outputs) + +The zipfile also includes instructions on how to install python and start up the notebook server. + +# Feedback + +Did you find a typo? Is there something that is not clear and you think could be improved? We strongly welcome feedback! To give feedback, the easiest for us is for you to submit an "issue" in our repository issue tracker: + +[Submit an "issue"](https://gitlab.tudelft.nl/python-for-applied-physics/practicum-lecture-notes/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=) + +In the message, please include: + +* The notebook number +* Cut-and-paste the text from the notebook +* Optional: Describe your suggestion (with a typo not needed even) + +# Developers + +Notebooks were developed by Gary Steele <g.a.steele@tudelft.nl> with input and feedback Jeroen Kalkman <J.Kalkman@tudelft.nl>.