HowToGalaxy/start_here.py at main · PyAutoLabs/HowToGalaxy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
"""
Start Here: HowToGalaxy
=======================

Welcome to **HowToGalaxy** — the `PyAutoGalaxy` tutorial lecture series on modeling galaxy morphology.

This script gives you a one-page overview of the series and points you to the first tutorial.

__HowToGalaxy__

**HowToGalaxy** is a four-chapter guide which takes you, step by step, from knowing nothing about galaxy
light profile fitting to being able to model real galaxy imaging data with **PyAutoGalaxy** for scientific
research.

- Chapter 1: Introduction to galaxy morphology — grids, light profiles, galaxies, simulated data, and how
  fitting works.
- Chapter 2: Bayesian inference and non-linear searches — how to fit a galaxy model to CCD imaging data.
- Chapter 3: Search chaining — automated pipelines that fit complex systems by chaining multiple searches.
- Chapter 4: Pixelized galaxy reconstruction — reconstructing galaxies with irregular morphology using
  inversions and regularization.

Each chapter is organised into numbered tutorial files: `chapter_<N>_<name>/tutorial_<M>_<topic>.py` (Python script)
or the matching `.ipynb` in `notebooks/`. Tutorials build on each other within a chapter and assume you have
completed the earlier ones.

__Recommended Path__

We recommend working through the tutorials in order:

1. First run `scripts/chapter_1_introduction/tutorial_0_visualization.py` — this checks your installation
   and sets up matplotlib for the rest of the series.
2. Work through `chapter_1_introduction` tutorial-by-tutorial.
3. Work through `chapter_2_modeling`.
4. At this point you can start modeling real galaxies using scripts in the separate
   `autogalaxy_workspace` repository — you know enough to be productive.
5. Come back for `chapter_3_search_chaining` and `chapter_4_pixelizations` when you want to tackle more
   complex systems.

__Notebooks vs Scripts__

Every tutorial exists as both a Python script (under `scripts/`) and a Jupyter notebook (under `notebooks/`).
The notebooks are ideal for reading because plots render inline between small blocks of code. The Python
scripts are more convenient for actual **PyAutoGalaxy** use — which chapter 3 onwards starts to assume.

The notebooks are auto-generated from the Python scripts, so if you want to make changes, **edit the
Python scripts, not the notebooks.**

__Next Step__

Open `scripts/chapter_1_introduction/tutorial_0_visualization.py` (or the `.ipynb` equivalent) and start there.
"""

print(__doc__)