Keeping repository and website tutorials/examples consistent
Maintainers usually reply within 3 days
@Ooolab is already working on this.
Since Oct 9, 2026.
Assessment
This issue has not been assessed yet.
Description
ALPS tutorials and examples are maintained in several places, including the repository’s tutorials/ and example/ directories, notebooks, and the website. There is overlap between these materials, and some have diverged—for example, the website’s Code-01 tutorial still shows Python 2 syntax while the corresponding repository code uses Python 3.
Could we agree on an approach to keep these resources consistent and reduce duplicated maintenance?
Questions worth discussing:
- What roles should the repository and website serve, and where should the authoritative sources live?
- Which duplication is useful, and which could be avoided?
- How should tutorials relate to released ALPS versions and ongoing development?
- What checks or maintenance practices would help prevent examples and instructions becoming stale?
This relates to ALPS #172, which tracks installation and tutorial migration, and website #51, which addressed tutorial presentation standards. The aim here is to discuss a sustainable approach across the repository and website, with concrete follow-up work once there is agreement.
- Dominant language
- C++
- Stars
- 32
- Forks
- 10
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 46
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ALPSim/ALPS
-
area:lattice bug
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 3 days
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 44/100
Maintainers usually reply within 3 days
-
area:qmc enhancement
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 3 days
-
area:mc area:qmc bug
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Maintainers usually reply within 3 days
-
area:dmrg bug scientific-correctness
Difficulty 4/5 3-5 days Newbie friendliness 52/100
Maintainers usually reply within 3 days
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
pocoproject/poco#5636 ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
[BUG] Segfault when all runs of a Complexity() benchmark are skippedPossibly taken @nitanshnagpal claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Code: Performance
Difficulty 1/5 Under an hour Newbie friendliness 88/100
CrimsonCrossBunker/Cataclysm-Cleanwater-Bomb#1167 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day