Skip to content

Commit c74bb8d

Browse files
Jammy2211Jammy2211
authored andcommitted
docs: clarify assistant and documentation paths
1 parent af11935 commit c74bb8d

4 files changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,12 @@ This is called strong gravitational lensing and **PyAutoLens** makes it **simple
2525

2626
## Getting Started
2727

28+
### PyAutoLens AI Assistant
29+
2830
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.
2931

32+
### Human-Readable Documentation and Examples
33+
3034
The following human-readable documentation and examples are also useful for new starters:
3135

3236
- [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).

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@ This is called strong gravitational lensing and **PyAutoLens** makes it simple t
1010

1111
# Getting Started
1212

13+
## PyAutoLens AI Assistant
14+
1315
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.
1416

17+
## Human-Readable Documentation and Examples
18+
1519
The following human-readable documentation and examples are also useful for new starters:
1620

1721
- [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).

docs/overview/overview_1_start_here.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
# Start Here
44

5+
## PyAutoLens AI Assistant
6+
7+
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.
8+
9+
## Human-Readable Overview
10+
511
**PyAutoLens** is software for analysing strong gravitational lenses, an astrophysical phenomenon where a galaxy
612
appears multiple times because its light is bent by the gravitational field of an intervening foreground lens galaxy.
713

docs/overview/overview_2_new_user_guide.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@
22

33
# New User Guide
44

5+
## PyAutoLens AI Assistant
6+
7+
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.
8+
9+
## Human-Readable Guide
10+
511
**PyAutoLens** can analyse strong lens systems across a range of physical scales (e.g. galaxy, group, and cluster) and for
612
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.
713

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

10-
## AI Assistant
11-
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.
13-
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.
16+
This guide begins with two simple questions to help you find the most appropriate example notebook for your science case.
1517

1618
## What Scale Lens?
1719

0 commit comments

Comments
 (0)