diff --git a/README.md b/README.md index 269afb900..c043a6ad7 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,12 @@ 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 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: - [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). diff --git a/docs/index.md b/docs/index.md index 60cd4a37b..8848e3f9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,8 +10,12 @@ 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 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: - [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). diff --git a/docs/overview/overview_1_start_here.md b/docs/overview/overview_1_start_here.md index 9ac7cd100..a39b1c1e9 100644 --- a/docs/overview/overview_1_start_here.md +++ b/docs/overview/overview_1_start_here.md @@ -2,6 +2,12 @@ # 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 assistant for its full scope and instructions. + +## Human-Readable Overview + **PyAutoLens** is software for analysing strong gravitational lenses, an astrophysical phenomenon where a galaxy appears multiple times because its light is bent by the gravitational field of an intervening foreground lens galaxy. diff --git a/docs/overview/overview_2_new_user_guide.md b/docs/overview/overview_2_new_user_guide.md index dab5221ed..36cbdc41f 100644 --- a/docs/overview/overview_2_new_user_guide.md +++ b/docs/overview/overview_2_new_user_guide.md @@ -2,16 +2,18 @@ # 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 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, group, and cluster) and for 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. -## 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 assistant for its full scope and instructions. - -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. +This guide begins with two simple questions to help you find the most appropriate example notebook for your science case. ## What Scale Lens?