Skip to content

Commit af11935

Browse files
authored
Merge pull request #646 from PyAutoLabs/feature/assistant-first-docs
docs: make getting started assistant-first
2 parents be09460 + 4acabfc commit af11935

3 files changed

Lines changed: 9 additions & 37 deletions

File tree

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,17 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
2323

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

26-
> 🤖 **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.
27-
2826
## Getting Started
2927

30-
The following links are useful for new starters:
28+
The [**PyAutoLens AI Assistant**](https://github.com/PyAutoLabs/autolens_assistant) supports conversation agents such as ChatGPT and coding agents such as Claude Code and Codex. You can get started simply by asking it a question about gravitational lensing or describing the task you would like to perform with **PyAutoLens**. See the assistant for its full scope and instructions.
29+
30+
The following human-readable documentation and examples are also useful for new starters:
3131

3232
- [The PyAutoLens readthedocs](https://pyautolens.readthedocs.io/en/latest): which includes [an overview of PyAutoLens's core features](https://pyautolens.readthedocs.io/en/latest/overview/overview_1_start_here.html), [a new user starting guide](https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) and [an installation guide](https://pyautolens.readthedocs.io/en/latest/installation/overview.html).
3333
- [The introduction Jupyter Notebook on Google Colab](https://colab.research.google.com/github/PyAutoLabs/autolens_workspace/blob/2026.7.23.1/notebooks/imaging/start_here.ipynb): try **PyAutoLens** in a web browser (without installation).
3434
- [The autolens_workspace GitHub repository](https://github.com/PyAutoLabs/autolens_workspace): example scripts covering every **PyAutoLens** use case.
3535
- [The HowToLens GitHub repository](https://github.com/PyAutoLabs/HowToLens): a Jupyter notebook lecture series teaching strong lensing and lens modeling from the ground up.
3636

37-
## Three Ways to Learn PyAutoLens
38-
39-
There are three ways to learn how to use **PyAutoLens**, which you can freely mix and match:
40-
41-
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.
42-
2. **AI chat assistant** — ask questions to a conversational AI assistant such as ChatGPT or Claude in the browser. Go to the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and copy the ready-to-use example prompt from its README into ChatGPT or Claude to get started. This is ideal for learning the API, working out how to perform a calculation, and creating end-to-end example Python scripts.
43-
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.
44-
45-
See [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) for more on the AI-assisted options (2 and 3).
46-
4737
## Community & Support
4838

4939
Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses

docs/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
88

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

11-
```{note}
12-
🤖 **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.
13-
```
14-
1511
# Getting Started
1612

17-
The following links are useful for new starters:
13+
The [**PyAutoLens AI Assistant**](https://github.com/PyAutoLabs/autolens_assistant) supports conversation agents such as ChatGPT and coding agents such as Claude Code and Codex. You can get started simply by asking it a question about gravitational lensing or describing the task you would like to perform with **PyAutoLens**. See the assistant for its full scope and instructions.
14+
15+
The following human-readable documentation and examples are also useful for new starters:
1816

1917
- [The PyAutoLens readthedocs](https://pyautolens.readthedocs.io/en/latest): which includes [an overview of PyAutoLens's core features](https://pyautolens.readthedocs.io/en/latest/overview/overview_1_start_here.html), [a new user starting guide](https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) and [an installation guide](https://pyautolens.readthedocs.io/en/latest/installation/overview.html).
2018
- [The introduction Jupyter Notebook on Colab](https://colab.research.google.com/github/PyAutoLabs/autolens_workspace/blob/2026.7.23.1/notebooks/imaging/start_here.ipynb), where you can try **PyAutoLens** in a web browser (without installation).

docs/overview/overview_2_new_user_guide.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,11 @@ different types of data (e.g. imaging, interferometer, and point-source observat
77

88
The autolens_workspace contains a suite of example Jupyter Notebooks, organised by lens scale and dataset type.
99

10-
## Three Ways To Learn PyAutoLens
10+
## AI Assistant
1111

12-
There are three ways to learn how to use **PyAutoLens**, which you are free to mix and match:
12+
The [**PyAutoLens AI Assistant**](https://github.com/PyAutoLabs/autolens_assistant) supports conversation agents such as ChatGPT and coding agents such as Claude Code and Codex. You can get started simply by asking it a question about gravitational lensing or describing the task you would like to perform with **PyAutoLens**. See the assistant for its full scope and instructions.
1313

14-
1. **Manual Navigation**: Read the workspace guides yourself. To find the example notebook best suited to your
15-
science case, work through the two questions below ("What Scale Lens?" and "What Dataset Type?"), which point you
16-
to the right starting point. This is the traditional route, and the rest of this guide supports it.
17-
18-
2. **AI Chat Assistant**: Ask questions to a conversational AI assistant such as ChatGPT or Claude in the browser.
19-
Go to the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and copy the ready-to-use
20-
example prompt from its README into ChatGPT or Claude — it gets you asking useful questions from the very first
21-
message. This is ideal for learning the API, working out how to perform a calculation, and creating end-to-end
22-
example Python scripts.
23-
24-
3. **Fully Agentic AI**: Use an agentic coding tool such as [Claude Code](https://claude.com/claude-code) or
25-
[Codex](https://developers.openai.com/codex) together with [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant).
26-
These can inspect your data, write and run scripts, and manage an end-to-end lens modeling project directly on your
27-
machine. See the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository for more information.
28-
29-
The rest of this guide supports **manual navigation**: we begin by answering two simple questions to find your most
30-
appropriate starting point.
14+
The rest of this human-readable guide begins with two simple questions to help you find the most appropriate example notebook for your science case.
3115

3216
## What Scale Lens?
3317

0 commit comments

Comments
 (0)