From 73355b6a4507ab857606ba734c6d4d50e3a5ada3 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Thu, 3 Sep 2026 20:08:54 -0400 Subject: [PATCH] docs: human-readable documentation first, AI assistant second Swap the Getting Started order back so the human-readable documentation precedes the AI Assistant section (text unchanged, order only), and add a bold note under the AI Assistant section that only the paid coding agents Claude Code and Codex are currently supported. Part of PyAutoLabs/autolens_assistant#120 Co-Authored-By: Claude Fable 5.1 Claude-Session: https://claude.ai/code/session_01TRKarVxARKJ6VJN5Qc3521 --- README.md | 10 ++++++---- docs/index.md | 10 ++++++---- docs/overview/overview_1_start_here.md | 10 ++++++---- docs/overview/overview_2_new_user_guide.md | 10 ++++++---- 4 files changed, 24 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 99b445bbb..b9922d538 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,6 @@ This is called strong gravitational lensing and **PyAutoLens** makes it **simple ## Getting Started -### PyAutoLens AI Assistant - -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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. - ### Human-Readable Documentation and Examples The following human-readable documentation and examples are also useful for new starters: @@ -38,6 +34,12 @@ The following human-readable documentation and examples are also useful for new - [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. +### PyAutoLens AI Assistant + +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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. + +**The PyAutoLens AI Assistant currently only supports AI coding agents which require a paid subscription, either Claude Code or Codex. Work is ongoing to support free AI coding agents and conversation agents like ChatGPT.** + ## Community & Support Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses diff --git a/docs/index.md b/docs/index.md index 5c7391cf0..c42b1ca93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,10 +10,6 @@ This is called strong gravitational lensing and **PyAutoLens** makes it simple t # Getting Started -## PyAutoLens AI Assistant - -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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. - ## Human-Readable Documentation and Examples The following human-readable documentation and examples are also useful for new starters: @@ -23,6 +19,12 @@ The following human-readable documentation and examples are also useful for new - [The autolens_workspace GitHub repository](https://github.com/PyAutoLabs/autolens_workspace), which includes 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. +## PyAutoLens AI Assistant + +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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. + +**The PyAutoLens AI Assistant currently only supports AI coding agents which require a paid subscription, either Claude Code or Codex. Work is ongoing to support free AI coding agents and conversation agents like ChatGPT.** + # Strong Gravitational Lensing When two galaxies are aligned down the line-of-sight to Earth, light rays from the background galaxy are deflected by the diff --git a/docs/overview/overview_1_start_here.md b/docs/overview/overview_1_start_here.md index 53ea7fbbb..ceff417e9 100644 --- a/docs/overview/overview_1_start_here.md +++ b/docs/overview/overview_1_start_here.md @@ -2,10 +2,6 @@ # Start Here -## PyAutoLens AI Assistant - -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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. - ## Human-Readable Overview **PyAutoLens** is software for analysing strong gravitational lenses, an astrophysical phenomenon where a galaxy @@ -25,6 +21,12 @@ Here is a schematic of a strong gravitational lens: This notebook gives an overview of **PyAutoLens**'s features and API. +## PyAutoLens AI Assistant + +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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. + +**The PyAutoLens AI Assistant currently only supports AI coding agents which require a paid subscription, either Claude Code or Codex. Work is ongoing to support free AI coding agents and conversation agents like ChatGPT.** + ## Imports Lets first import autolens, its plotting module and the other libraries we'll need. diff --git a/docs/overview/overview_2_new_user_guide.md b/docs/overview/overview_2_new_user_guide.md index 10b461847..0b64be2af 100644 --- a/docs/overview/overview_2_new_user_guide.md +++ b/docs/overview/overview_2_new_user_guide.md @@ -2,10 +2,6 @@ # New User Guide -## PyAutoLens AI Assistant - -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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. - ## Human-Readable Guide **PyAutoLens** can analyse strong lens systems across a range of physical scales (e.g. galaxy, multi-galaxy, group, and cluster) and for @@ -15,6 +11,12 @@ The autolens_workspace contains a suite of example Jupyter Notebooks, organised This guide begins with two simple questions to help you find the most appropriate example notebook for your science case. +## PyAutoLens AI Assistant + +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 [autolens_assistant GitHub page](https://github.com/PyAutoLabs/autolens_assistant) for its full scope and instructions. + +**The PyAutoLens AI Assistant currently only supports AI coding agents which require a paid subscription, either Claude Code or Codex. Work is ongoing to support free AI coding agents and conversation agents like ChatGPT.** + ## What Scale Lens? What size and scale of strong lens system are you expecting to work with?