Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back

This is called strong gravitational lensing and **PyAutoLens** makes it **simple** to model strong gravitational lenses, using JAX to **accelerate lens modeling on GPUs**.

> 🤖 **Prototype:** [**autolens_assistant**](https://github.com/PyAutoLabs/autolens_assistant) is an early-stage AI assistant you talk to in natural language to do lens modeling end-to-end. It is experimental and **not the recommended starting point** — the readthedocs, autolens_workspace, and HowToLens below remain the canonical entry points. Try it if you'd like to drive PyAutoLens by conversation.
> 🤖 **AI-assisted use:** you can also learn and drive **PyAutoLens** with AI — either a browser chat assistant (ChatGPT, Claude) pointed at [**autolens_assistant**](https://github.com/PyAutoLabs/autolens_assistant), or a fully agentic coding tool (Claude Code, Codex) that runs lens modeling end-to-end on your machine. See the **Three Ways to Learn PyAutoLens** section below.

## Getting Started

Expand All @@ -34,6 +34,16 @@ The following links are useful for new starters:
- [The autolens_workspace GitHub repository](https://github.com/PyAutoLabs/autolens_workspace): example scripts covering every **PyAutoLens** use case.
- [The HowToLens GitHub repository](https://github.com/PyAutoLabs/HowToLens): a Jupyter notebook lecture series teaching strong lensing and lens modeling from the ground up.

## Three Ways to Learn PyAutoLens

There are three ways to learn how to use **PyAutoLens**, which you can freely mix and match:

1. **Manual navigation** — read the workspace guides yourself, starting from the [new user guide](https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) and the `start_here` notebooks, which are organised by lens scale and dataset type.
2. **AI chat assistant** — ask questions to a conversational AI assistant such as ChatGPT or Claude in the browser. Point it at the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and ask a question like *"How do I model a galaxy-scale strong lens observed with Hubble imaging?"*.
3. **Fully agentic AI** — drive **PyAutoLens** end-to-end with an agentic coding tool such as [Claude Code](https://claude.com/claude-code) or [Codex](https://developers.openai.com/codex) together with [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant). These can inspect your data, write and run scripts, and manage a lens-modeling project directly on your machine.

See [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) for more on the AI-assisted options (2 and 3).

## Community & Support

Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses
Expand Down
3 changes: 1 addition & 2 deletions docs/api/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ For datasets taken with a CCD (or similar imaging device), including objects whi
Imaging
SimulatorImaging
Convolver
Convolver


Interferometer
Expand Down Expand Up @@ -67,7 +66,7 @@ applied to datasets to apply over sampling to their fit.
:template: custom-class-template.rst
:recursive:

OverSampling
OverSampler


1D Data Structures
Expand Down
2 changes: 0 additions & 2 deletions docs/api/mass.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,5 +187,3 @@ inversion during each likelihood evaluation rather than as a free non-linear par
ExponentialGradientSph
DevVaucouleurs
DevVaucouleursSph
Chameleon
ChameleonSph
4 changes: 1 addition & 3 deletions docs/api/modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ Markov Chain Monte Carlo (MCMC) and Maximum Likelihood Estimaotrs (MLE).
BFGS
DynestyDynamic
Emcee
PySwarmsLocal
PySwarmsGlobal

Priors
------
Expand All @@ -65,4 +63,4 @@ Adapt
.. autosummary::
:toctree: generated/

SetupAdapt
AdaptImages
80 changes: 0 additions & 80 deletions docs/api/plot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,83 +97,3 @@ Module-level functions for visualizing non-linear search results.
corner_anesthetic
subplot_parameters
log_likelihood_vs_iteration

Plot Customization [aplt]
-------------------------

Customize figures created via ``Plotter`` objects, including changing ``matplotlib`` settings and adding
visuals to figures.

.. currentmodule:: autogalaxy.plot

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

MatPlot1D
MatPlot2D
Visuals1D
Visuals2D

Matplot Lib Wrappers [aplt]
---------------------------

Wrappers for every ``matplotlib`` function used by a ``Plotter``, allowing for detailed customization of
every figure and subplot.

.. currentmodule:: autogalaxy.plot

**Matplotlib Wrapper Base Objects:**

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

Units
Figure
Axis
Cmap
Colorbar
ColorbarTickParams
TickParams
YTicks
XTicks
Title
YLabel
XLabel
Legend
Output

**Matplotlib Wrapper 1D Objects:**

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

YXPlot

**Matplotlib Wrapper 2D Objects:**

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

ArrayOverlay
GridScatter
GridPlot
VectorYXQuiver
PatchOverlay
VoronoiDrawer
OriginScatter
MaskScatter
BorderScatter
PositionsScatter
IndexScatter
MeshGridScatter
ParallelOverscanPlot
SerialPrescanPlot
SerialOverscanPlot
1 change: 0 additions & 1 deletion docs/api/point.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ named point sources.
:recursive:

PointDataset
PointDict

Solver
------
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
This is called strong gravitational lensing and **PyAutoLens** makes it simple to model strong gravitational lenses, using JAX to **accelerate lens modeling on GPUs**.

```{note}
🤖 **Prototype:** [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) is an early-stage AI assistant you talk to in natural language to do lens modeling end-to-end. It is experimental and **not the recommended starting point** — the readthedocs, autolens_workspace, and HowToLens below remain the canonical entry points. Try it if you'd like to drive PyAutoLens by conversation.
🤖 **AI-assisted use:** alongside reading the guides, you can learn and drive **PyAutoLens** with AI — either a browser chat assistant (ChatGPT, Claude) pointed at [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant), or a fully agentic coding tool (Claude Code, Codex) that runs lens modeling end-to-end on your machine. The [new user guide](https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) describes all three ways to learn.
```

# Getting Started
Expand Down
22 changes: 21 additions & 1 deletion docs/overview/overview_2_new_user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,27 @@
different types of data (e.g. imaging, interferometer, and point-source observations). Depending on the scientific questions you are interested in, the analysis you perform may differ significantly.

The autolens_workspace contains a suite of example Jupyter Notebooks, organised by lens scale and dataset type.
To help you find the most appropriate starting point, we begin by answering two simple questions.

## Three Ways To Learn PyAutoLens

There are three ways to learn how to use **PyAutoLens**, which you are free to mix and match:

1. **Manual Navigation**: Read the workspace guides yourself. To find the example notebook best suited to your
science case, work through the two questions below ("What Scale Lens?" and "What Dataset Type?"), which point you
to the right starting point. This is the traditional route, and the rest of this guide supports it.

2. **AI Chat Assistant**: Ask questions to a conversational AI assistant such as ChatGPT or Claude in the browser.
Point it at the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and ask questions
like *"How do I model a galaxy-scale strong lens observed with Hubble imaging?"*. This is ideal for learning the API,
working out how to perform a calculation, and interpreting or debugging errors.

3. **Fully Agentic AI**: Use an agentic coding tool such as [Claude Code](https://claude.com/claude-code) or
[Codex](https://developers.openai.com/codex) together with [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant).
These can inspect your data, write and run scripts, and manage an end-to-end lens modeling project directly on your
machine. See the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository for more information.

The rest of this guide supports **manual navigation**: we begin by answering two simple questions to find your most
appropriate starting point.

## What Scale Lens?

Expand Down
Loading