From c777146cb545c206cd1d1f692fed3c0ee739be12 Mon Sep 17 00:00:00 2001
From: rajarshi <rajarshi.tiwari@ichec.ie>
Date: Fri, 7 Jun 2024 15:34:49 +0100
Subject: [PATCH] added README

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..20fa300
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+---
+title: Python For Quantum Mechanics
+---
+
+# Python For Quantum Mechanics
+
+## Description
+Welcome to Python for Quantum Mechanics. This course was designed to give you a solid foundation in the Python programming language for your studies in quantum technology. The course is six sessions long in total, and builds from the ground up a working knowledge of Python, with emphasis on the NumPy, Matplotlib and SciPy libraries. The first three sessions entail the building of a foundation, where you will learn how to manipulate basic data types in the first session, all the way to object-oriented programming in the third session. The final three sessions involve a deep dive into the afore-mentioned libraries.
+
+The course material will be hosted on GitHub and includes a folder for each session which includes a complete set of notebooks with the video lectures embedded as well as a README where links to the videos can also be found. There will be a live tutorial each week on Tuesday at 3am in the SNIAM basement lecture hall. The Discord, linked above, server also serves as a place of communication, where questions can be asked and discussions held.
+
+## Installation & Requirements
+- Python – [Installation and Setup Guide](https://realpython.com/installing-python/)
+- Anaconda – [Installation Guide]( https://docs.anaconda.com/anaconda/install/)
+- Jupyter Notebook – [Getting Started with Jupyter](https://jupyter.org/install.html)
+- Discord - [Download](https://discord.com/download)
+
+
+
+## Contents
+1. Fundamentals – [Week 1](pyqm-week1/)
+2. Flow Control and I/O - [Week 2](pyqm-week2/)
+3. Functions and Classes - [Week 3](pyqm-week3/)
+4. Numpy - [Week 4](pyqm-week4/)
+5. Matplotlib - [Week 5](pyqm-week5/)
+6. Scipy - [Week 6](pyqm-week6/)
+
+|No.|Topic                 |Folder                |                 |
+|-- |--                    |--                    |--               |
+|1. |Fundamentals          | [Week 1](pyqm-week1/)|Divyajyoti Sarkar|
+|2. |Flow Control and I/O  | [Week 2](pyqm-week2/)|Divyajyoti Sarkar|
+|3. |Functions and Classes | [Week 3](pyqm-week3/)|Pablo Lauret     |
+|4. |Numpy                 | [Week 4](pyqm-week4/)|Rajarshi Tiwari  |
+|5. |Matplotlib            | [Week 5](pyqm-week5/)|Pablo Lauret     |
+|6. |Scipy                 | [Week 6](pyqm-week6/)|Rajarshi Tiwari  |
+
+
+## Contact
+- Divyajyoti Sarkar - <divyajyoti.sarkar@ichec.ie>
+- Pablo Lauret – <pablo.lauret@ichec.ie>
+- Rajarshi Tiwari - <rajarshi.tiwari@ichec.ie>
+- Karthik Krishnakumar - <karthik.krishnakumar@ichec.ie>
+- Emil Dimitrov – <emil.dimitrov@ichec.ie>
+- Conor Dunne – <conor.dunne@ichec.ie>
+- Venkatesh Kannan – <venkatesh.kannan@ichec.ie>