Skip to content

docs: route Colab introductions to workspace start #649

Description

@Jammy2211

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_colab calls.
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

  1. Replace generic introductory links in PyAutoLens/README.md, docs/index.md, and paper/paper.md with <release>/start_here.ipynb.
  2. Update the three introductory links in autolens_workspace/README.md.
  3. Correct the matching link in euclid_strong_lens_modeling_pipeline/README.md, retaining its existing release pin.
  4. Apply the equivalent changes to PyAutoGalaxy/README.md, docs/index.md, paper/paper.md, and autogalaxy_workspace/README.md.
  5. Preserve imaging-specific links in the new-user guides and generated Markdown catalogues.
  6. Confirm the root notebooks contain setup_colab.for_autolens(...) and setup_colab.for_autogalaxy(...).
  7. Run a final scoped scan and link-target validation.

Key Files

  • PyAutoLens/README.md
  • PyAutoLens/docs/index.md
  • PyAutoLens/paper/paper.md
  • autolens_workspace/README.md
  • PyAutoGalaxy/README.md
  • PyAutoGalaxy/docs/index.md
  • PyAutoGalaxy/paper/paper.md
  • autogalaxy_workspace/README.md
  • euclid_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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions