Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jammy2211 committed Sep 20, 2024
1 parent 98e35c1 commit 6fa839d
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Getting Started

The following links are useful for new starters:

- `The PyAutoGalaxy readthedocs <https://pyautogalaxy.readthedocs.io/en/latest>`_, which includes `an overview of PyAutoGalaxy's core features <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_introduction.html>`_, `a new user starting guide <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>`_ and `an installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/overview.html>`_.
- `The PyAutoGalaxy readthedocs <https://pyautogalaxy.readthedocs.io/en/latest>`_, which includes `an overview of PyAutoGalaxy's core features <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_start_here.html>`_, `a new user starting guide <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>`_ and `an installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/overview.html>`_.

- `The introduction Jupyter Notebook on Binder <https://mybinder.org/v2/gh/Jammy2211/autogalaxy_workspace/release?filepath=start_here.ipynb>`_, where you can try **PyAutoGalaxy** in a web browser (without installation).

Expand Down
4 changes: 2 additions & 2 deletions docs/howtogalaxy/chapter_2_modeling.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Chapter 2: Lens Modeling
========================
Chapter 2: Modeling
===================

In chapter 2, we'll take you through how to model galaxies using a non-linear search.

Expand Down
6 changes: 2 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
What is PyAutoGalaxy?
=====================

``PyAutoGalaxy`` is an open-source Python 3.9 - 3.12 package for analysing the morphologies and structures of large
multi-wavelength galaxy samples. **PyAutoGalaxy** makes it simple to model galaxies, for example this Hubble Space
Telescope imaging of a spiral galaxy:
**PyAutoGalaxy** is software for analysing the morphologies and structures of galaxies:

|pic1|

Expand All @@ -21,7 +19,7 @@ Getting Started

The following links are useful for new starters:

- `The PyAutoGalaxy readthedocs <https://pyautogalaxy.readthedocs.io/en/latest>`_, which includes `an overview of PyAutoGalaxy's core features <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_introduction.html>`_, `a new user starting guide <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>`_ and `an installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/overview.html>`_.
- `The PyAutoGalaxy readthedocs <https://pyautogalaxy.readthedocs.io/en/latest/>`_, which includes `an overview of PyAutoGalaxy's core features <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_start_here.html>`_, `a new user starting guide <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>`_ and `an installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/overview.html>`_.

- `The introduction Jupyter Notebook on Binder <https://mybinder.org/v2/gh/Jammy2211/autogalaxy_workspace/release?filepath=start_here.ipynb>`_, where you can try **PyAutoGalaxy** in a web browser (without installation).

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Overview
========

**PyAutoGalaxy** requires Python 3.9 - 3.11 and support the Linux, MacOS and Windows operating systems.
**PyAutoGalaxy** requires Python 3.9 - 3.12 and support the Linux, MacOS and Windows operating systems.

**PyAutoGalaxy** can be installed via the Python distribution `Anaconda <https://www.anaconda.com/>`_ or using
`PyPI <https://pypi.org/>`_ to ``pip install`` **PyAutoGalaxy** into your Python distribution.
Expand Down
26 changes: 13 additions & 13 deletions docs/overview/overview_1_start_here.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Start Here

**PyAutoGalaxy** is software for analysing the morphologies and structures of galaxies:

![HST Image](https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/paper/hstcombined.png)
.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/paper/hstcombined.png
:width: 400
:alt: Alternative text

**PyAutoGalaxy** has three core aims:

Expand All @@ -26,8 +28,6 @@ You'll see these imports in the majority of workspace examples.

.. code:: python
# %matplotlib inline
import autogalaxy as ag
import autogalaxy.plot as aplt
Expand Down Expand Up @@ -57,7 +57,7 @@ We make and plot a uniform Cartesian grid:
The ``Grid2D`` looks like this:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/0_grid.png
:width: 400
:width: 600
:alt: Alternative text

Light Profiles
Expand Down Expand Up @@ -112,7 +112,7 @@ for fits to large datasets.
The light profile appears as follows:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/1_image_2d.png
:width: 400
:width: 600
:alt: Alternative text

Galaxy
Expand Down Expand Up @@ -146,7 +146,7 @@ The ``GalaxyPlotter`` object plots the image of the galaxy, which is the sum of
The galaxy, with both a bulge and disk, appears as follows:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/2_image_2d.png
:width: 400
:width: 600
:alt: Alternative text

One example of the plotter's customizability is the ability to plot the individual light profiles of the galaxy
Expand All @@ -159,7 +159,7 @@ on a subplot.
The light profiles appear as follows:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/3_subplot_image.png
:width: 400
:width: 600
:alt: Alternative text


Expand Down Expand Up @@ -190,7 +190,7 @@ the galaxy is used below where the ``Sersic`` is passed directly to the ``Galaxy
galaxies_plotter.figures_2d(image=True)
.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/4_image_2d.png
:width: 400
:width: 600
:alt: Alternative text

Extensibility
Expand Down Expand Up @@ -244,7 +244,7 @@ To further illustrate this, we create a merging galaxy system with 4 star formin
The image of the merging galaxy system appears as follows:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/5_image_2d.png
:width: 400
:width: 600
:alt: Alternative text

Simulating Data
Expand Down Expand Up @@ -317,7 +317,7 @@ import dataset attributes like the noise-map and PSF.
The observed dataset appears as follows:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/6_data.png
:width: 400
:width: 600
:alt: Alternative text

If you have come to **PyAutoGalaxy** to perform interferometry, the API above is easily adapted to use
Expand Down Expand Up @@ -363,7 +363,7 @@ and the plot axis automatically zooms in around the mask.
Here is the masked dataset:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/7_data.png
:width: 400
:width: 600
:alt: Alternative text

Fitting
Expand Down Expand Up @@ -422,7 +422,7 @@ In this example, the galaxies used to simulate the data are used to fit it, thus
as shown by the subplots below:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/10_subplot_fit.png
:width: 400
:width: 600
:alt: Alternative text

The overall quality of the fit is quantified with the ``log_likelihood``.
Expand Down Expand Up @@ -585,7 +585,7 @@ Here is an example corner plot of the model-fit, which shows the probability den
model:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_1/cornerplot.png
:width: 400
:width: 600
:alt: Alternative text

Wrap Up
Expand Down
17 changes: 12 additions & 5 deletions docs/overview/overview_3_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,19 @@ Firstly, brief one sentence descriptions of each feature are given, with more de
links to the relevant workspace examples.

**Interferometry**: Modeling of interferometer data (e.g. ALMA, LOFAR) directly in the uv-plane.

**Multi-Wavelength**: Simultaneous analysis of imaging and / or interferometer datasets observed at different wavelengths.

**Ellipse Fitting**: Fitting ellipses to determine a galaxy's ellipticity, position angle and centre.

**Multi Gaussian Expansion (MGE)**: Decomposing a galaxy into hundreds of Gaussians, capturing more complex structures than simple light profiles.

**Shapelets**: Decomposing a galaxy into a set of shapelet orthogonal basis functions, capturing more complex structures than simple light profiles.

**Sky Background**: Including the background sky in the model to ensure robust fits to the outskirts of galaxies.

**Operated Light Profiles**: Assuming a light profile has already been convolved with the PSF, for when the PSF is a significant effect.

**Pixelizations**: Reconstructing a galaxy's on a mesh of pixels, to capture extremely irregular structures like spiral arms.

Interferometry
Expand All @@ -23,7 +30,7 @@ Interferometry
Modeling interferometer data from submillimeter (e.g. ALMA) and radio (e.g. LOFAR) observatories:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/paper/almacombined.png
:width: 400
:width: 600
:alt: Alternative text

Visibilities data is fitted directly in the uv-plane, circumventing issues that arise when fitting a dirty image
Expand Down Expand Up @@ -60,7 +67,7 @@ Ellipse fitting is a technique which fits many ellipses to a galaxy's emission t
angle and centre, without assuming a parametric form for its light (e.g. a Sersic profile):

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_3/ellipse.png
:width: 400
:width: 600
:alt: Alternative text

This provides complementary information to parametric light profile fitting, for example giving insights on whether
Expand All @@ -79,7 +86,7 @@ Multi Gaussian Expansion (MGE)
An MGE decomposes the light of a galaxy into tens or hundreds of two dimensional Gaussians:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/docs/overview/images/overview_3/mge.png
:width: 400
:width: 600
:alt: Alternative text

In the image above, 30 Gaussians are shown, where their sizes go from below the pixel scale (in order to resolve
Expand All @@ -97,7 +104,7 @@ Shapelets
Shapelets are a set of orthogonal basis functions that can be combined the represent galaxy structures:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoLens/main/docs/overview/images/overview_3/shapelets.png
:width: 400
:width: 600
:alt: Alternative text

Scientific Applications include capturing symmetric structures in a galaxy which are more complex than a Sersic profile,
Expand Down Expand Up @@ -142,7 +149,7 @@ fitted accurately using light profiles, whereas its asymmetric and irregular spi
captured using a rectangular mesh:

.. image:: https://raw.githubusercontent.com/Jammy2211/PyAutoGalaxy/main/paper/hstcombined.png
:width: 400
:width: 600
:alt: Alternative text

Checkout ``autogalaxy_workspace/notebooks/features/pixelizations.ipynb`` to learn how to use a pixelization, however
Expand Down

0 comments on commit 6fa839d

Please sign in to comment.