You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: migrate HowToGalaxy URLs/prose to PyAutoLabs/HowToGalaxy repo (#363)
Sub-task 3 of 3 of the HowToGalaxy extraction. The HowToGalaxy tutorial
series now lives in its own repository at
https://github.com/PyAutoLabs/HowToGalaxy; this commit points every
HowToGalaxy reference in PyAutoGalaxy at the new location (tag
2026.4.13.6, matching autogalaxy_workspace at extraction).
- Rewrite Colab URLs across docs/howtogalaxy/chapter_{1..4,optional}.rst
from `autogalaxy_workspace/blob/.../notebooks/howtogalaxy/chapter_X/`
to `HowToGalaxy/blob/.../notebooks/chapter_X/` (drops redundant
howtogalaxy/ segment since the new repo root is the tutorial series).
- Reword the README, docs/index.rst and docs/overview/overview_2
new-starter/"HowToGalaxy" sections to frame HowToGalaxy as a standalone
repo alongside autogalaxy_workspace.
- Rewrite docs/howtogalaxy/howtogalaxy.rst, docs/general/workspace.rst
and paper/paper.md with the same framing; fix the broken local
`file:///Users/...` readthedocs path in workspace.rst.
- Remove the `scripts/howtogalaxy/` bullet from CLAUDE.md's workspace
overview and add a short note that HowToGalaxy now lives externally.
- Restore missing `|` separator between "Introduction on Colab" and
"HowToGalaxy" links at the top of README.rst (pre-existing drift).
Closes#362
Co-authored-by: Jammy2211 <JNightingale2211@gmail.com>
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
**PyAutoGalaxy** is software for analysing the morphologies and structures of galaxies:
@@ -56,7 +56,9 @@ The following links are useful for new starters:
56
56
57
57
- `The introduction Jupyter Notebook on Google Colab <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/start_here.ipynb>`_, where you can try **PyAutoGalaxy** in a web browser (without installation).
58
58
59
-
- `The autogalaxy_workspace GitHub repository <https://github.com/Jammy2211/autogalaxy_workspace>`_, which includes example scripts and the `HowToGalaxy Jupyter notebook lectures <https://github.com/Jammy2211/autogalaxy_workspace/tree/main/notebooks/howtogalaxy>`_ which give new users a step-by-step introduction to **PyAutoGalaxy**.
59
+
- `The autogalaxy_workspace GitHub repository <https://github.com/PyAutoLabs/autogalaxy_workspace>`_: example scripts covering every **PyAutoGalaxy** use case.
60
+
61
+
- `The HowToGalaxy GitHub repository <https://github.com/PyAutoLabs/HowToGalaxy>`_: a Jupyter notebook lecture series teaching galaxy modeling from the ground up.
60
62
61
63
Core Aims
62
64
---------
@@ -81,16 +83,14 @@ Slack is invitation-only. If you’d like to join, please send an email requesti
81
83
82
84
For installation issues, bug reports, or feature requests, please raise an issue on the `GitHub issues page <https://github.com/Jammy2211/PyAutoGalaxy/issues>`_.
83
85
84
-
Here’s a clean, **AutoGalaxy**-appropriate rewrite, keeping the same structure and tone but removing lensing-specific language:
85
-
86
86
HowToGalaxy
87
87
-----------
88
88
89
89
For users less familiar with galaxy analysis, Bayesian inference, and scientific analysis, you may wish to read through
90
90
the **HowToGalaxy** lectures. These introduce the basic principles of galaxy modeling and Bayesian inference, with
91
91
the material pitched at undergraduate level and above.
92
92
93
-
A complete overview of the lectures is provided on the `HowToGalaxy readthedocs page <https://pyautogalaxy.readthedocs.io/en/latest/howtogalaxy/howtogalaxy.html>`_
93
+
A complete overview of the lectures `is provided on the HowToGalaxy readthedocs page <https://pyautogalaxy.readthedocs.io/en/latest/howtogalaxy/howtogalaxy.html>`_, and the notebooks themselves live in the `PyAutoLabs/HowToGalaxy <https://github.com/PyAutoLabs/HowToGalaxy>`_ repository.
- Setting up **PyAutoGalaxy**'s visualization library.
12
12
13
-
`Tutorial 1: Grids And Galaxies <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_1_introduction/tutorial_1_grids_and_galaxies.ipynb>`_
13
+
`Tutorial 1: Grids And Galaxies <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_1_introduction/tutorial_1_grids_and_galaxies.ipynb>`_
14
14
- Using grids of (y,x) coordinates with galaxies made up of light profiles.
15
15
16
-
`Tutorial 2: Data <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_1_introduction/tutorial_2_data.ipynb>`_
16
+
`Tutorial 2: Data <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_1_introduction/tutorial_2_data.ipynb>`_
17
17
- Simulating and inspecting telescope imaging data of a galaxy.
- Practicalities of performing model-fitting, like how to inspect the results on your hard-disk.
13
13
14
-
`Tutorial 3: Realism and Complexity <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_2_modeling/tutorial_3_realism_and_complexity.ipynb>`_
14
+
`Tutorial 3: Realism and Complexity <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_2_modeling/tutorial_3_realism_and_complexity.ipynb>`_
15
15
- Finding a balance between realism and complexity when composing and fitting a model.
16
16
17
-
`Tutorial 4: Dealing with Failure <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_2_modeling/tutorial_4_dealing_with_failure.ipynb>`_
17
+
`Tutorial 4: Dealing with Failure <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_2_modeling/tutorial_4_dealing_with_failure.ipynb>`_
18
18
- What to do when PyAutoGalaxy finds an inaccurate model.
19
19
20
-
`Tutorial 5: Linear Profiles <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_2_modeling/tutorial_5_linear_profiles.ipynb>`_
20
+
`Tutorial 5: Linear Profiles <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_2_modeling/tutorial_5_linear_profiles.ipynb>`_
21
21
- Light profiles which capture complex morphologies in a reduced number of non-linear parameters.
- Overview of the results available after successfully fitting a model.
28
28
29
-
`Tutorial 8: Need for Speed <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_2_modeling/tutorial_8_need_for_speed.ipynb>`_
29
+
`Tutorial 8: Need for Speed <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_2_modeling/tutorial_8_need_for_speed.ipynb>`_
30
30
- How to fit complex models whilst balancing efficiency and run-time.
- Smoothing the source within a Bayesian framework.
19
19
20
-
`Tutorial 6: Model Fit <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_4_pixelizations/tutorial_6_model_fit.ipynb>`_
20
+
`Tutorial 6: Model Fit <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_4_pixelizations/tutorial_6_model_fit.ipynb>`_
21
21
- An example modeling pipeline which uses an inversion.
Copy file name to clipboardExpand all lines: docs/howtogalaxy/chapter_optional.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,12 @@ This chapter contains optional tutorials expanding on different aspects of how *
5
5
6
6
The chapter contains the following tutorials:
7
7
8
-
`Tutorial: Mass Profiles <https://colab.research.google.com/github/PyAutoLabs/autogalaxy_workspace/blob/2026.4.13.6/notebooks/howtogalaxy/chapter_optional/tutorial_mass_profiles.ipynb>`_
8
+
`Tutorial: Mass Profiles <https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.4.13.6/notebooks/chapter_optional/tutorial_mass_profiles.ipynb>`_
9
9
- A description of mass profiles implemented in PyAutoGalaxy, which are currently only used by its child project PyAutoLens.
0 commit comments