Skip to content

Commit f171bb9

Browse files
Normalize notebook sources, update README and CI
Normalize Jupyter notebook cells (standardized cell ids and convert cell source to arrays of lines) to reduce diff noise and improve consistency; adjust README markdown tables and Apptainer references (point BUILD -> README and add fenced code block language); simplify CI test run step to a single line for PowerShell compatibility. Changes touch multiple notebooks, README.md, and the CI workflow (.github/workflows/ci.yml) along with related package/test files to keep repository formatting consistent.
1 parent fb9a206 commit f171bb9

41 files changed

Lines changed: 3204 additions & 1048 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,8 @@ jobs:
6767
- name: Run non-PySCF tests
6868
# PySCF tests are skipped automatically via skipif guards when pyscf
6969
# is not installed. network tests also skipped.
70-
run: |
71-
pytest -m "not network" \
72-
--ignore=tests/test_session_calc.py \
73-
--ignore=tests/test_optimizer.py \
74-
--ignore=tests/test_preopt.py \
75-
--no-cov \
76-
--no-header -q
70+
# Single line: PowerShell does not support backslash line continuation.
71+
run: pytest -m "not network" --ignore=tests/test_session_calc.py --ignore=tests/test_optimizer.py --ignore=tests/test_preopt.py --no-cov --no-header -q
7772

7873
# ── Lint / type-check ─────────────────────────────────────────────────────
7974
lint:

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Built for classroom teaching at the
2929
## Platform requirements
3030

3131
| Platform | Works? | Notes |
32-
|----------|--------|-------|
32+
| --- | --- | --- |
3333
| Linux / macOS | Full | PySCF installs natively |
3434
| WSL (Windows) | Full | Use an Ubuntu WSL environment |
3535
| Windows (native) | Partial | All UI and visualization features work; PySCF calculations require the Apptainer container |
@@ -39,7 +39,7 @@ Built for classroom teaching at the
3939
PySCF does not install on Windows natively. The
4040
[`apptainer/quantui-local.def`](apptainer/quantui-local.def) container bundles
4141
the complete environment and runs anywhere Apptainer/Singularity is available.
42-
See [`apptainer/BUILD.md`](apptainer/BUILD.md) for build and run instructions.
42+
See [`apptainer/README.md`](apptainer/README.md) for build and run instructions.
4343

4444
---
4545

@@ -64,7 +64,7 @@ python -m pip install quantui-local[pyscf,ase,app]
6464

6565
### Option C — Apptainer container (Windows / reproducible deployment)
6666

67-
See [apptainer/BUILD.md](apptainer/BUILD.md).
67+
See [apptainer/README.md](apptainer/README.md).
6868

6969
---
7070

@@ -91,7 +91,7 @@ Open the notebook, pick a molecule, choose a method and basis set, and click
9191
Five step-by-step notebooks in [`notebooks/tutorials/`](notebooks/tutorials/):
9292

9393
| Notebook | Topic |
94-
|----------|-------|
94+
| --- | --- |
9595
| [01_first_calculation.ipynb](notebooks/tutorials/01_first_calculation.ipynb) | Your first RHF calculation |
9696
| [02_basis_set_study.ipynb](notebooks/tutorials/02_basis_set_study.ipynb) | Comparing STO-3G, 6-31G, cc-pVDZ |
9797
| [03_multiplicity_radicals.ipynb](notebooks/tutorials/03_multiplicity_radicals.ipynb) | Open-shell molecules and UHF |
@@ -103,7 +103,7 @@ Five step-by-step notebooks in [`notebooks/tutorials/`](notebooks/tutorials/):
103103
## Supported calculations
104104

105105
| Method | When to use |
106-
|--------|------------|
106+
| --- | --- |
107107
| RHF | Closed-shell molecules — all electrons paired |
108108
| UHF | Open-shell molecules — radicals or unpaired electrons |
109109

@@ -131,7 +131,7 @@ pytest -m "not network" \
131131

132132
## Project structure
133133

134-
```
134+
```text
135135
quantui/ Main package
136136
molecule.py Molecule input and validation
137137
session_calc.py In-session PySCF runner

notebooks/molecule_computations.ipynb

Lines changed: 540 additions & 19 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)