Skip to content

Commit 6e373f6

Browse files
Refactor README by removing sections
updates
1 parent 11c3bd5 commit 6e373f6

File tree

1 file changed

+1
-166
lines changed

1 file changed

+1
-166
lines changed

README.md

Lines changed: 1 addition & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,12 @@
11
# Quantum Autumn School 2025 (QAS2025)
22

3-
Educational materials and tutorials for the Quantum Autumn School 2025, a 5-day event covering quantum computing with hands-on tutorials and lectures.
4-
5-
## Quick Start
3+
materials and tutorials for the Quantum Autumn School 2025, a 5-day event covering quantum computing with hands-on tutorials and lectures.
64

75
### Prerequisites
86

97
- Python 3.10, 3.11, or 3.12 (NOT 3.13+ due to Qrisp compatibility)
108
- `uv` package manager (recommended) - [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
119

12-
### Setup Instructions
13-
14-
The workflow is clean and consistent:
15-
16-
```bash
17-
# From project root
18-
uv sync # Install all dependencies
19-
```
20-
21-
Then in VS Code:
22-
- Open `notebooks/getting-started/qrisp-intro.ipynb`
23-
- When prompted, select Python interpreter: **`.venv/bin/python3`**
24-
- Run cells with full IQM and Qiskit support
25-
26-
VS Code automatically detects `.venv/` - no manual kernel registration needed!
27-
28-
### Quick Scripts
29-
30-
For convenience, use these helper scripts:
31-
32-
```bash
33-
./preview.sh # Start live reload server at http://127.0.0.1:8000
34-
./build.sh # Build documentation for production
35-
./deploy.sh # Build, commit, and push to GitHub (triggers deployment)
36-
```
37-
38-
See `SCRIPTS_README.md` for detailed usage.
39-
40-
## Project Structure
41-
42-
```
43-
qas2025/
44-
├── content/ # Sphinx documentation source
45-
│ ├── conf.py # Sphinx configuration
46-
│ ├── index.md # Main landing page
47-
│ ├── day0.md - day5.md # Daily schedules and content
48-
│ └── resources/ # PDF documents
49-
├── notebooks/ # Jupyter notebooks
50-
│ └── getting-started/
51-
│ ├── qrisp-starter.ipynb # Quick start with VQE & Grover examples
52-
│ ├── qrisp-intro.ipynb # Comprehensive Qrisp tutorial (archived)
53-
│ └── token.txt # IQM authentication token (gitignored)
54-
├── _build/ # Build output (gitignored)
55-
├── .venv/ # Virtual environment (gitignored, uv-managed)
56-
├── pyproject.toml # Python dependencies
57-
└── uv.lock # Locked dependency versions
58-
```
59-
60-
## Working with Notebooks
61-
62-
### Automated Setup
63-
64-
The fastest way to get started with Qrisp notebooks:
65-
66-
```bash
67-
cd notebooks/getting-started
68-
./setup.sh
69-
```
70-
71-
This script will:
72-
- Install all dependencies (Qrisp, Qiskit, IQM support, Jupyter)
73-
- Verify everything is working
74-
- No manual kernel registration needed - VS Code auto-detects `.venv/`
75-
76-
### Manual Setup
77-
78-
If you prefer to set up manually:
79-
80-
```bash
81-
# From project root
82-
uv sync
83-
84-
# Start Jupyter (optional - or use VS Code)
85-
uv run jupyter notebook
86-
# Navigate to: notebooks/getting-started/qrisp-intro.ipynb
87-
```
88-
89-
### Important: Python Environment Selection
90-
91-
The most common issue is selecting the wrong Python environment in VS Code.
92-
93-
**Solution:**
94-
1. Open the notebook in VS Code
95-
2. Click kernel selector (top-right)
96-
3. Select "Python Environments" → Choose **`.venv/bin/python3`**
97-
4. Run cells
98-
99-
If you see "IQM backend not available", you're using the wrong environment!
100-
101-
## Building Documentation
102-
103-
### Using Scripts
104-
105-
```bash
106-
./preview.sh # Live reload development server
107-
./build.sh # Build once for production
108-
```
109-
110-
### Manual Build
111-
112-
```bash
113-
# Build HTML
114-
uv run sphinx-build -b html content _build
115-
116-
# Build with live reload (recommended for development)
117-
uv run sphinx-autobuild content _build --port 8000
118-
# Visit http://127.0.0.1:8000
119-
120-
# Using Makefile
121-
make html # Build HTML
122-
make livehtml # Live reload
123-
```
124-
125-
## Deployment
126-
127-
The site is automatically deployed to GitHub Pages when you push to the main branch.
128-
129-
**Production URL**: https://enccs.github.io/qas2025/
130-
131-
To manually deploy:
132-
133-
```bash
134-
./deploy.sh
135-
```
136-
13710
## Dependency Management
13811

13912
```bash
@@ -181,29 +54,7 @@ iqm_backend = IQMBackend(
18154
results = qf.get_measurement(backend=iqm_backend, shots=1000)
18255
```
18356

184-
## Troubleshooting
185-
186-
### pyenv virtualenv warnings
187-
188-
If you see `VIRTUAL_ENV=/Users/.../... does not match...`:
189-
- Run `unset VIRTUAL_ENV` before uv commands
190-
- Or open a fresh terminal
191-
192-
### "IQM backend not available" Error
193-
194-
**Most common issue!**
19557

196-
**Cause:** Wrong Python environment selected in VS Code.
197-
198-
**Solution:**
199-
1. Click kernel selector (top-right of notebook)
200-
2. Select "Python Environments" → Choose **`.venv/bin/python3`**
201-
3. Restart kernel
202-
4. Run cells again
203-
204-
### Build warnings
205-
206-
Ignore the `FutureWarning` about `get_cssname` in conf.py - this is from sphinx-lesson compatibility.
20758

20859
## Resources
20960

@@ -212,22 +63,6 @@ Ignore the `FutureWarning` about `get_cssname` in conf.py - this is from sphinx-
21263
- **IQM Resonance**: https://resonance.meetiqm.com
21364
- **IQM Academy**: https://www.iqmacademy.com
21465

215-
## Contributing
216-
217-
For detailed information about:
218-
- Project structure and conventions
219-
- Content guidelines
220-
- Jupyter notebook setup
221-
- Build and deployment process
222-
223-
See `CLAUDE.md` for comprehensive documentation.
224-
225-
## Support
226-
227-
- Check the documentation: https://enccs.github.io/qas2025/
228-
- Review the getting-started README: `notebooks/getting-started/README.md`
229-
- Reach out to the organizing team during QAS2025
230-
23166
---
23267

23368
**Quantum Autumn School 2025**

0 commit comments

Comments
 (0)