Repository navigation
docs: route Colab introductions to workspace start #649
Description
Overview
Introductory Google Colab links for PyAutoLens and PyAutoGalaxy currently open each workspace’s imaging-specific notebook. They should instead open the workspace-root start_here.ipynb, which provides the overall product introduction.
Both root notebooks exist at the referenced release tags and contain the correct product-specific setup_colab bootstrap.
Plan
- Redirect generic PyAutoLens introduction links to the autolens workspace-root notebook.
- Apply the equivalent correction to PyAutoGalaxy links.
- Update matching README, documentation, and paper references across the affected repositories.
- Preserve links explicitly describing the imaging-specific tutorial.
- Verify the release-tag targets and their
setup_colabcalls.
Detailed implementation plan
Affected Repositories
- PyAutoLens (primary)
- PyAutoGalaxy
- autolens_workspace
- autogalaxy_workspace
- euclid_strong_lens_modeling_pipeline
Branch Survey
| Repository | Current Branch | Dirty? |
|---|---|---|
| PyAutoLens | main | clean |
| PyAutoGalaxy | main | clean |
| autolens_workspace | main | clean |
| autogalaxy_workspace | main | clean |
| euclid_strong_lens_modeling_pipeline | main | test_report.md modified; unrelated |
Suggested branch: feature/workspace-start-here-colab-links
Work classification: Both — library documentation and workspaces
Worktree root: ~/Code/PyAutoLabs-wt/workspace-start-here-colab-links/
Implementation Steps
- Replace generic introductory links in
PyAutoLens/README.md,docs/index.md, andpaper/paper.mdwith<release>/start_here.ipynb. - Update the three introductory links in
autolens_workspace/README.md. - Correct the matching link in
euclid_strong_lens_modeling_pipeline/README.md, retaining its existing release pin. - Apply the equivalent changes to
PyAutoGalaxy/README.md,docs/index.md,paper/paper.md, andautogalaxy_workspace/README.md. - Preserve imaging-specific links in the new-user guides and generated Markdown catalogues.
- Confirm the root notebooks contain
setup_colab.for_autolens(...)andsetup_colab.for_autogalaxy(...). - Run a final scoped scan and link-target validation.
Key Files
PyAutoLens/README.mdPyAutoLens/docs/index.mdPyAutoLens/paper/paper.mdautolens_workspace/README.mdPyAutoGalaxy/README.mdPyAutoGalaxy/docs/index.mdPyAutoGalaxy/paper/paper.mdautogalaxy_workspace/README.mdeuclid_strong_lens_modeling_pipeline/README.md
Original Prompt
Click to expand starting prompt
The URL to this should not be imaging/start_here.py but the overall workspace start_here.py, The introduction Jupyter Notebook on Google Colab: try PyAutoLens in a web browser (without installation)., update it and scan other README.md and docs for the same issue
make sure the examples we are routing to has the right setup_colab
this is prob requied for PyautoGalaxy too
Activity
Jammy2211 commentedon Jul 24, 2026
Library PRs Created
API changes: None — documentation links only.
Next:
/start_workspacefor the coordinated README updates inautolens_workspace,autogalaxy_workspace, andeuclid_strong_lens_modeling_pipeline.Jammy2211 commentedon Jul 24, 2026
Smoke Test Results — 2026-07-24
All 25 smoke tests passed across 3 workspaces.
Jammy2211 commentedon Jul 24, 2026
Workspace PRs Created
All PRs carry the
pending-releaselabel and are cross-referenced from their upstream library PRs.Required merge order
The workspace PRs remain unmerged behind the library-first gate.
Jammy2211 commentedon Jul 24, 2026
Library PRs Merged
d231441f3dd05d46The library-first gate is now open. Euclid pipeline #36 is green; autolens_workspace #331 and autogalaxy_workspace #157 still have smoke checks in progress. No workspace PR has been merged yet.
Jammy2211 commentedon Jul 24, 2026
Shipped — 2026-07-24
PRs
Summary
Generic PyAutoLens and PyAutoGalaxy introduction links now open each workspace-root
start_here.ipynbinstead of the imaging-specific notebook. Explicit imaging tutorial links remain unchanged, and the pinned root notebooks were verified to contain the correct product-specificsetup_colabcalls.Validation passed: 448 PyAutoLens tests, 1,006 PyAutoGalaxy tests, and workspace smoke totals of 11/11, 8/8, and 6/6.
Session Notes
The unrelated Euclid main-checkout change to
test_report.mdwas preserved outside the task worktree.