From 4c0680f044fbb709007fbe7e7971db9ba2957012 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 6 Aug 2026 21:43:50 +0000 Subject: [PATCH] docs: update RTD howtogalaxy pages for the HowToGalaxy restructure HowToGalaxy dissolved its search-chaining chapter into chapter 2 (tutorials 9-10), renamed pixelizations to chapter 3 (with a new Bayesian formalism tutorial 5) and added a scaling-up-galaxies chapter 4. The RTD pages, overview and toctree now mirror that structure; the new-user guide says four chapters. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01BxKfSZisjnEn91LRGkN4SU --- docs/howtogalaxy/chapter_2_modeling.md | 9 +++++++- docs/howtogalaxy/chapter_3_pixelizations.md | 23 +++++++++++++++++++ docs/howtogalaxy/chapter_3_search_chaining.md | 15 ------------ docs/howtogalaxy/chapter_4_pixelizations.md | 20 ---------------- .../chapter_4_scaling_up_galaxies.md | 15 ++++++++++++ docs/howtogalaxy/howtogalaxy.md | 10 ++++---- docs/index.md | 4 ++-- docs/overview/overview_2_new_user_guide.md | 2 +- 8 files changed, 55 insertions(+), 43 deletions(-) create mode 100644 docs/howtogalaxy/chapter_3_pixelizations.md delete mode 100644 docs/howtogalaxy/chapter_3_search_chaining.md delete mode 100644 docs/howtogalaxy/chapter_4_pixelizations.md create mode 100644 docs/howtogalaxy/chapter_4_scaling_up_galaxies.md diff --git a/docs/howtogalaxy/chapter_2_modeling.md b/docs/howtogalaxy/chapter_2_modeling.md index c6574a97..e5ca9582 100644 --- a/docs/howtogalaxy/chapter_2_modeling.md +++ b/docs/howtogalaxy/chapter_2_modeling.md @@ -1,6 +1,7 @@ # Chapter 2: Modeling -In chapter 2, we'll take you through how to model galaxies using a non-linear search. +In chapter 2, we'll take you through how to model galaxies using a non-linear search, ending with how +searches are chained together into automated modeling pipelines. The chapter contains the following tutorials: @@ -27,3 +28,9 @@ The chapter contains the following tutorials: [Tutorial 8: Need for Speed](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_2_modeling/tutorial_8_need_for_speed.ipynb) \- How to fit complex models whilst balancing efficiency and run-time. + +[Tutorial 9: Search Chaining](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_2_modeling/tutorial_9_search_chaining.ipynb) +\- Breaking the modeling procedure into a chained sequence of model-fits. + +[Tutorial 10: Prior Passing](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_2_modeling/tutorial_10_prior_passing.ipynb) +\- How the results of earlier searches are passed to later searches. diff --git a/docs/howtogalaxy/chapter_3_pixelizations.md b/docs/howtogalaxy/chapter_3_pixelizations.md new file mode 100644 index 00000000..2bf81e35 --- /dev/null +++ b/docs/howtogalaxy/chapter_3_pixelizations.md @@ -0,0 +1,23 @@ +# Chapter 3: Pixelizations + +In chapter 3, we use **Pixelizations** to reconstruct the light of complex galaxies on pixelized grids. + +The chapter contains the following tutorials: + +[Tutorial 1: Pixelizations](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_pixelizations/tutorial_1_pixelizations.ipynb) +\- Creating a pixel-grid to reconstruct a galaxy's light. + +[Tutorial 2: Mappers](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_pixelizations/tutorial_2_mappers.ipynb) +\- How a pixelization maps its pixels to image-pixels. + +[Tutorial 3: Inversions](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_pixelizations/tutorial_3_inversions.ipynb) +\- Inverting the mappings to reconstruct the galaxy's light. + +[Tutorial 4: Bayesian Regularization](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_pixelizations/tutorial_4_bayesian_regularization.ipynb) +\- Smoothing the reconstruction within a Bayesian framework. + +[Tutorial 5: Bayesian Formalism](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_pixelizations/tutorial_5_bayesian_formalism.ipynb) +\- The linear algebra and Bayesian evidence equations behind pixelized galaxy reconstruction. + +[Tutorial 6: Model Fit](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_pixelizations/tutorial_6_model_fit.ipynb) +\- An example modeling pipeline which uses an inversion. diff --git a/docs/howtogalaxy/chapter_3_search_chaining.md b/docs/howtogalaxy/chapter_3_search_chaining.md deleted file mode 100644 index 58de98aa..00000000 --- a/docs/howtogalaxy/chapter_3_search_chaining.md +++ /dev/null @@ -1,15 +0,0 @@ -# Chapter 3: Search Chaining - -In chapter 3, we introduce non-linear search chaining, whereby model-fits are chained together to enable efficient and -robust modeling of large galaxy samples. - -The chapter contains the following tutorials: - -[Tutorial 1: Search Chaining](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_search_chaining/tutorial_1_search_chaining.ipynb) -\- Breaking the modeling procedure into a chained sequence of model-fits. - -[Tutorial 2: Prior Passing](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_search_chaining/tutorial_2_prior_passing.ipynb) -\- How the results of earlier searches are passed to later searches. - -[Tutorial 3: x2 Galaxies](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_3_search_chaining/tutorial_3_x2_galaxies.ipynb) -\- Modeling a dataset with two galaxies using chained searches. diff --git a/docs/howtogalaxy/chapter_4_pixelizations.md b/docs/howtogalaxy/chapter_4_pixelizations.md deleted file mode 100644 index 8612818b..00000000 --- a/docs/howtogalaxy/chapter_4_pixelizations.md +++ /dev/null @@ -1,20 +0,0 @@ -# Chapter 4: Pixelizations - -In chapter 4, we use **Pixelizations** to reconstruct complex galaxies on pixelized grids. - -The chapter contains the following tutorials: - -[Tutorial 1: Pixelizations](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_pixelizations/tutorial_1_pixelizations.ipynb) -\- Creating a pixel-grid which will reconstruct a galaxy's light. - -[Tutorial 2: Mappers](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_pixelizations/tutorial_2_mappers.ipynb) -\- How a pixelization maps between the data and pixelization. - -[Tutorial 3: Inversions](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_pixelizations/tutorial_3_inversions.ipynb) -\- Inverting the mappings to reconstruct the galaxy's light. - -[Tutorial 4: Bayesian Regularization](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_pixelizations/tutorial_4_bayesian_regularization.ipynb) -\- Smoothing the source within a Bayesian framework. - -[Tutorial 5: Model Fit](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_pixelizations/tutorial_5_model_fit.ipynb) -\- An example modeling pipeline which uses an inversion. diff --git a/docs/howtogalaxy/chapter_4_scaling_up_galaxies.md b/docs/howtogalaxy/chapter_4_scaling_up_galaxies.md new file mode 100644 index 00000000..f79f7518 --- /dev/null +++ b/docs/howtogalaxy/chapter_4_scaling_up_galaxies.md @@ -0,0 +1,15 @@ +# Chapter 4: Scaling Up Galaxies + +In chapter 4, we scale galaxy modeling up beyond a single galaxy: extra galaxies, blended multi-galaxy +systems, and cluster fields. + +The chapter contains the following tutorials: + +[Tutorial 1: Extra Galaxies](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_scaling_up_galaxies/tutorial_1_extra_galaxies.ipynb) +\- Handling nearby galaxies by scaling their light out of the fit or modeling them explicitly. + +[Tutorial 2: Multi Galaxy](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_scaling_up_galaxies/tutorial_2_multi_galaxy.ipynb) +\- Modeling two or more blended galaxies simultaneously and the degeneracies this creates. + +[Tutorial 3: Cluster](https://colab.research.google.com/github/PyAutoLabs/HowToGalaxy/blob/2026.8.4.1/notebooks/chapter_4_scaling_up_galaxies/tutorial_3_cluster.ipynb) +\- Modeling a cluster field's BCG and catalogue-driven member population. diff --git a/docs/howtogalaxy/howtogalaxy.md b/docs/howtogalaxy/howtogalaxy.md index 2bbdb1e2..a1c735a8 100644 --- a/docs/howtogalaxy/howtogalaxy.md +++ b/docs/howtogalaxy/howtogalaxy.md @@ -6,12 +6,14 @@ The best way to learn **PyAutoGalaxy** is by going through the **HowToGalaxy** l repository at [PyAutoLabs/HowToGalaxy](https://github.com/PyAutoLabs/HowToGalaxy). The lectures are provided as Jupyter notebooks (and Python scripts), and they are linked to via this readthedocs. The -lectures are composed of five chapters +lectures are composed of four chapters - **Introduction** - An introduction to galaxy morphology and structure using **PyAutoGalaxy**. -- **Lens Modeling** - How to model galaxies, including a primer on Bayesian non-linear analysis. -- **Search Chaining** - How to fit complex lens models using non-linear search chaining. -- **Pixelizations** - How to perform pixelized reconstructions of a galaxy. +- **Modeling** - How to model galaxies, including a primer on Bayesian non-linear analysis and + non-linear search chaining. +- **Pixelizations** - How to perform pixelized reconstructions of a galaxy, including the Bayesian + formalism behind them. +- **Scaling Up Galaxies** - Extra galaxies, blended multi-galaxy systems, and cluster fields. ## How to Tackle HowToGalaxy diff --git a/docs/index.md b/docs/index.md index a142a4c5..785a4b2c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -249,8 +249,8 @@ general/credits howtogalaxy/howtogalaxy howtogalaxy/chapter_1_introduction howtogalaxy/chapter_2_modeling -howtogalaxy/chapter_3_search_chaining -howtogalaxy/chapter_4_pixelizations +howtogalaxy/chapter_3_pixelizations +howtogalaxy/chapter_4_scaling_up_galaxies howtogalaxy/chapter_optional ``` diff --git a/docs/overview/overview_2_new_user_guide.md b/docs/overview/overview_2_new_user_guide.md index 52169698..aeb36113 100644 --- a/docs/overview/overview_2_new_user_guide.md +++ b/docs/overview/overview_2_new_user_guide.md @@ -75,7 +75,7 @@ morphology were already familiar and the statistical techniques used for fitting For those less familiar with these concepts (e.g. undergraduate students, new PhD students or interested members of the public), things may have been less clear and a slower more detailed explanation of each concept would be beneficial. -The **HowToGalaxy** Jupyter Notebook lectures provide exactly this. They are a 3+ chapter guide which thoroughly +The **HowToGalaxy** Jupyter Notebook lectures provide exactly this. They are a four-chapter guide which thoroughly takes you through the core concepts of galaxy light profiles, teaches you the principles of the statistical techniques used in modeling and ultimately will allow you to undertake scientific research like a professional astronomer.