Skip to content

Commit 60c7fb1

Browse files
author
Stephen Shao
committed
Updated docs and implemented a script to test all examples
1 parent 2f047c9 commit 60c7fb1

File tree

12 files changed

+1211
-48
lines changed

12 files changed

+1211
-48
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Quantum Computing 101 🚀⚛️
22

3-
**The most comprehensive, beginner-friendly quantum computing course** with **45 examples** covering everything from "what is a qubit?" to industry applications in drug discovery and financial optimization.
3+
**The most comprehensive, beginner-friendly quantum computing course** with **48 examples** covering everything from "what is a qubit?" to industry applications in drug discovery and financial optimization.
44

55
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
66
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
77
[![Qiskit](https://img.shields.io/badge/Qiskit-2.x-purple.svg)](https://qiskit.org/)
88
[![Beginner Friendly](https://img.shields.io/badge/beginner-friendly-brightgreen.svg)]()
9-
[![Examples](https://img.shields.io/badge/examples-45_working-brightgreen.svg)]()
9+
[![Examples](https://img.shields.io/badge/examples-48_working-brightgreen.svg)]()
1010

1111
## 🎯 Perfect for Complete Beginners
1212

@@ -53,10 +53,11 @@ Unlike other courses that oversell quantum computing, we give you an honest asse
5353
### ✅ Qiskit 2.x Compatible & Fully Tested
5454
All examples have been updated and tested for **Qiskit 2.x compatibility** and **headless environment execution** (Docker, SSH, remote servers).
5555

56-
**🎯 Testing Status: 52/56 examples (93%) passing**
57-
- ✅ Modules 1-7: 100% passing (46/46 examples)
58-
- ✅ Module 8: 50% passing (3/6 examples), 1 working but slow
59-
- All critical functionality verified and working
56+
**🎯 Testing Status: 48/48 examples (100%) passing**
57+
- ✅ All modules: 100% passing (48/48 examples)
58+
- ✅ Comprehensive automated test suite included
59+
- ✅ All critical functionality verified and working
60+
- See [Testing Guide](docs/TESTING.md) for details
6061

6162
**Recent Compatibility Fixes (November 2025):**
6263
- Updated all `bind_parameters``assign_parameters` (Qiskit 2.x API)
@@ -331,9 +332,11 @@ quantum-computing-101/
331332
├── verify_examples.py # Quality assurance tool
332333
├── BEGINNERS_GUIDE.md # Complete learning pathway (Updated v2.0)
333334
└── docs/ # Additional documentation
335+
├── COMPATIBILITY.md # Qiskit 2.x compatibility reference
334336
├── CONTRIBUTING.md # Contribution guidelines
335337
├── CODE_OF_CONDUCT.md # Community standards
336-
└── SECURITY.md # Security policy
338+
├── SECURITY.md # Security policy
339+
└── TESTING.md # Testing guide and procedures
337340
```
338341

339342
## 🤝 Contributing
@@ -355,13 +358,18 @@ git clone https://github.com/AIComputing101/quantum-computing-101.git
355358
cd quantum-computing-101
356359
pip install -r examples/requirements-dev.txt
357360

358-
# Verify all examples work
361+
# Run comprehensive test suite (recommended)
362+
./test-examples.sh --continue
363+
364+
# Or verify all examples work (legacy)
359365
python verify_examples.py
360366

361367
# Run specific module tests
362-
python verify_examples.py --module module1_fundamentals
368+
./test-examples.sh --module module1_fundamentals
363369
```
364370

371+
For detailed testing procedures and options, see the **[Testing Guide](docs/TESTING.md)**.
372+
365373
## 🎓 Educational Use
366374

367375
### For Students
@@ -466,7 +474,7 @@ pip install scikit-learn
466474
## 📞 Support & Community
467475

468476
### **When You Need Help:**
469-
- 🐛 **Technical Issues**: Run `python verify_examples.py` to diagnose problems
477+
- 🐛 **Technical Issues**: Run `./test-examples.sh --continue` to diagnose problems (see [Testing Guide](docs/TESTING.md))
470478
- 📚 **Learning Questions**: Check the [Complete Beginner's Guide](BEGINNERS_GUIDE.md)
471479
- 📖 **Qiskit 2.x Compatibility**: All examples updated for Qiskit 2.x (tested November 2025)
472480
- 🐳 **Docker/Headless Problems**: Examples use matplotlib 'Agg' backend for headless compatibility

0 commit comments

Comments
 (0)