From 310ce5c6245b08675315e64dd77c2c7cc0ac1a25 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Fri, 10 Jul 2026 19:04:31 +0100 Subject: [PATCH 1/2] docs: point AI Chat Assistant option at the ready-made prompt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The "AI Chat Assistant" option in the new-user guide and README told users to "point ChatGPT/Claude at autolens_assistant and ask questions like ..." — a vague half-example a new user can't act on directly. Replace it with an instruction to copy the ready-to-use example prompt from the autolens_assistant README into ChatGPT or Claude, so someone who already knows ChatGPT gets going from the first message. Also add "creating end-to-end example Python scripts" to the use-case list. Co-Authored-By: Claude Opus 4.8 --- README.md | 2 +- docs/overview/overview_2_new_user_guide.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 631d73d98..04d2da1cc 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ The following links are useful for new starters: 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?"*. +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, creating end-to-end example Python scripts, and interpreting or debugging errors. 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). diff --git a/docs/overview/overview_2_new_user_guide.md b/docs/overview/overview_2_new_user_guide.md index a9ff1dbba..c2f9ed803 100644 --- a/docs/overview/overview_2_new_user_guide.md +++ b/docs/overview/overview_2_new_user_guide.md @@ -16,9 +16,10 @@ There are three ways to learn how to use **PyAutoLens**, which you are free to m 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. + 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 — it gets you asking useful questions from the very first + message. This is ideal for learning the API, working out how to perform a calculation, creating end-to-end example + Python scripts, 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). From 5fcbd1783eaf2920fd2cbd8577beb3529d849d37 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Fri, 10 Jul 2026 19:22:02 +0100 Subject: [PATCH 2/2] docs: match assistant README's use-case phrasing Drop 'interpreting or debugging errors' from the AI Chat Assistant use-case line so it matches the autolens_assistant README exactly. Co-Authored-By: Claude Opus 4.8 --- README.md | 2 +- docs/overview/overview_2_new_user_guide.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 04d2da1cc..4cc6dfb89 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ The following links are useful for new starters: 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. 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, creating end-to-end example Python scripts, and interpreting or debugging errors. +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. 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). diff --git a/docs/overview/overview_2_new_user_guide.md b/docs/overview/overview_2_new_user_guide.md index c2f9ed803..f775d6952 100644 --- a/docs/overview/overview_2_new_user_guide.md +++ b/docs/overview/overview_2_new_user_guide.md @@ -18,8 +18,8 @@ There are three ways to learn how to use **PyAutoLens**, which you are free to m 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 — it gets you asking useful questions from the very first - message. This is ideal for learning the API, working out how to perform a calculation, creating end-to-end example - Python scripts, and interpreting or debugging errors. + message. This is ideal for learning the API, working out how to perform a calculation, and creating end-to-end + example Python scripts. 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).