diff --git a/README.md b/README.md index 4def83b8..2ad8b394 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,12 @@ ## Getting Started +### PyAutoGalaxy AI Assistant + The [**PyAutoGalaxy AI Assistant**](https://github.com/PyAutoLabs/autogalaxy_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 galaxy structure or describing the task you would like to perform with **PyAutoGalaxy**. 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 PyAutoGalaxy readthedocs](https://pyautogalaxy.readthedocs.io/en/latest), which includes [an overview of PyAutoGalaxy's core features](https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_start_here.html), [a new user starting guide](https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) and [an installation guide](https://pyautogalaxy.readthedocs.io/en/latest/installation/overview.html). diff --git a/docs/index.md b/docs/index.md index e5911b40..8714eba2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,8 +20,12 @@ substitutions: # Getting Started +## PyAutoGalaxy AI Assistant + The [**PyAutoGalaxy AI Assistant**](https://github.com/PyAutoLabs/autogalaxy_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 galaxy structure or describing the task you would like to perform with **PyAutoGalaxy**. 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 PyAutoGalaxy readthedocs](https://pyautogalaxy.readthedocs.io/en/latest/), which includes [an overview of PyAutoGalaxy's core features](https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_start_here.html), [a new user starting guide](https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html) and [an installation guide](https://pyautogalaxy.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 4bfc2c99..b2e9a5e2 100644 --- a/docs/overview/overview_1_start_here.md +++ b/docs/overview/overview_1_start_here.md @@ -2,6 +2,12 @@ # Start Here +## PyAutoGalaxy AI Assistant + +The [**PyAutoGalaxy AI Assistant**](https://github.com/PyAutoLabs/autogalaxy_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 galaxy structure or describing the task you would like to perform with **PyAutoGalaxy**. See the assistant for its full scope and instructions. + +## Human-Readable Overview + **PyAutoGalaxy** is software for analysing the morphologies and structures of galaxies: ```{image} https://raw.githubusercontent.com/PyAutoLabs/PyAutoGalaxy/main/paper/hstcombined.png diff --git a/docs/overview/overview_2_new_user_guide.md b/docs/overview/overview_2_new_user_guide.md index 62dcf2e8..d343e635 100644 --- a/docs/overview/overview_2_new_user_guide.md +++ b/docs/overview/overview_2_new_user_guide.md @@ -2,18 +2,18 @@ # New User Guide +## PyAutoGalaxy AI Assistant + +The [**PyAutoGalaxy AI Assistant**](https://github.com/PyAutoLabs/autogalaxy_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 galaxy structure or describing the task you would like to perform with **PyAutoGalaxy**. See the assistant for its full scope and instructions. + +## Human-Readable Guide + **PyAutoGalaxy** can analyse galaxies for different types of data (e.g. CCD imaging and interferometer observations). Depending on the data you use, the analysis you perform may differ significantly. The autogalaxy_workspace contains a suite of example Jupyter Notebooks, organised by dataset type. To help you find the most appropriate starting point, answer one simple question: -## AI Assistant - -The [**PyAutoGalaxy AI Assistant**](https://github.com/PyAutoLabs/autogalaxy_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 galaxy structure or describing the task you would like to perform with **PyAutoGalaxy**. See the assistant for its full scope and instructions. - -The rest of this human-readable guide helps you find the most appropriate example notebook for your science case. - ## What Dataset Type? You now need to decide what type of data you are interested in: