Update README.md

README.md

@@ -1,2 +1,75 @@
 # variational-quantum-classifier-on-heartattack
+
 Implement variational quantum classifier on heart attack data available on kaggle with the aim to understand different variational models and different feature maps
+
+
+## Running the notebooks
+
+1. Create a virtual environment:
+
+```bash
+python3 -m venv venv
+```
+
+2. Activate the environment:
+
+```bash
+source venv/bin/activate
+```
+
+3. Update `pip`:
+
+```bash
+pip install --upgrade pip
+```
+
+4. Install requirements
+
+```bash
+pip install -r requirements.txt
+```
+
+5. Clone the repo
+
+```bash
+git clone https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack
+```
+
+6. Launch Jupyter Notebook:
+
+```
+jupyter notebook
+```
+
+7. Open and run the jupyter notebooks under `Src/Notebooks`
+
+## Project Structure
+
+1. [01dataExploration.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/01dataExploration.ipynb) Data exploration
+
+2. [02-pennylane.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/02-pennylane.ipynb) Pennylane version of VQE
+
+3. [02-qiskit.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/02-qiskit.ipynb) Qiskit version of VQE implementation
+
+4. [03-analyseBenchmarks.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/03-analyseBenchmarks.ipynb) Analysing benchmarks
+
+5. [04generateImages.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/04generateImages.ipynb) Notebook to generate images
+
+6. [05cleanwinedata.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/05cleanwinedata.ipynb) Cleaning wine data
+
+7. [06validatewine.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/06validatewine.ipynb) Validating wine data
+
+8. [07cleanirisdata.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/07cleanirisdata.ipynb) Cleaning iris data
+
+9. [08validateiris.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/08validateiris.ipynb) Validating iris data
+
+10. [09analysewine.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/09analysewine.ipynb) Analyse wine data
+
+11. [09generalisation.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/09generalisation.ipynb) Generalisation of all models
+
+12. [10analyseiris.ipynb](https://github.com/0x6f736f646f/variational-quantum-classifier-on-heartattack/blob/main/Src/Notebooks/10analyseiris.ipynb) Analyse iris data
+
+
+## Acknowledgements
+
+I would like to thank my mentor **Amira Abbas** for her constant support and guidance without who this project wouldn't have taken shape. I would also like to thank the **QOSF** team for giving me this fantastic opportunity of being a part of an awesome mentorship program.