You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
authored
docs: three-ways-to-learn guide + prune stale API-doc references (#593)
Phase C: add a 'Three Ways to Learn PyAutoLens' subsection (manual
navigation / AI chat assistant / fully agentic AI) to the new-user guide
and README; reframe autolens_assistant from experimental to a first-class
option in README + docs/index.
Phase A: prune docs/api/*.rst references to removed API — the OO plotting
subsystem (MatPlot2D/Cmap/*Scatter, replaced by the functional plot API),
PySwarms searches, PointDict, SetupAdapt->AdaptImages, OverSampling->
OverSampler, and dead linear Chameleon entries. Re-audit clean.
Issue #592.
Co-authored-by: Jammy2211 <JNightingale2211@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
23
23
24
24
This is called strong gravitational lensing and **PyAutoLens** makes it **simple** to model strong gravitational lenses, using JAX to **accelerate lens modeling on GPUs**.
25
25
26
-
> 🤖 **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.
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
27
28
28
## Getting Started
29
29
@@ -34,6 +34,16 @@ The following links are useful for new starters:
34
34
-[The autolens_workspace GitHub repository](https://github.com/PyAutoLabs/autolens_workspace): example scripts covering every **PyAutoLens** use case.
35
35
-[The HowToLens GitHub repository](https://github.com/PyAutoLabs/HowToLens): a Jupyter notebook lecture series teaching strong lensing and lens modeling from the ground up.
36
36
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. 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?"*.
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
+
37
47
## Community & Support
38
48
39
49
Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses
Copy file name to clipboardExpand all lines: docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ When two or more galaxies are aligned perfectly down our line-of-sight, the back
9
9
This is called strong gravitational lensing and **PyAutoLens** makes it simple to model strong gravitational lenses, using JAX to **accelerate lens modeling on GPUs**.
10
10
11
11
```{note}
12
-
🤖 **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.
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.
Copy file name to clipboardExpand all lines: docs/overview/overview_2_new_user_guide.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,27 @@
6
6
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.
7
7
8
8
The autolens_workspace contains a suite of example Jupyter Notebooks, organised by lens scale and dataset type.
9
-
To help you find the most appropriate starting point, we begin by answering two simple questions.
9
+
10
+
## Three Ways To Learn PyAutoLens
11
+
12
+
There are three ways to learn how to use **PyAutoLens**, which you are free to mix and match:
13
+
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
+
Point it at the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository and ask questions
20
+
like *"How do I model a galaxy-scale strong lens observed with Hubble imaging?"*. This is ideal for learning the API,
21
+
working out how to perform a calculation, and interpreting or debugging errors.
22
+
23
+
3.**Fully Agentic AI**: Use an agentic coding tool such as [Claude Code](https://claude.com/claude-code) or
24
+
[Codex](https://developers.openai.com/codex) together with [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant).
25
+
These can inspect your data, write and run scripts, and manage an end-to-end lens modeling project directly on your
26
+
machine. See the [autolens_assistant](https://github.com/PyAutoLabs/autolens_assistant) repository for more information.
27
+
28
+
The rest of this guide supports **manual navigation**: we begin by answering two simple questions to find your most
0 commit comments