Skip to content

Adding basic install instructions#400

Merged
nabobalis merged 8 commits into
LM-SAL:mainfrom
hayesla:adding_install
Apr 28, 2026
Merged

Adding basic install instructions#400
nabobalis merged 8 commits into
LM-SAL:mainfrom
hayesla:adding_install

Conversation

@hayesla
Copy link
Copy Markdown
Contributor

@hayesla hayesla commented Apr 28, 2026

fixes #399

Basically, this is just as several people asked my at a summer school how to install as it wasnt on the webpage and didnt read the sunpy docs properly

Summary by Sourcery

Documentation:

  • Document basic installation steps in the installation guide.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 28, 2026

🧙 Sourcery has finished reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 2 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/installation.rst" line_range="7" />
<code_context>

-The easiest way to install aiapy to follow the instructions on :ref:`sunpy-tutorial-installing`.
-The only difference is that you will need to install aiapy instead of sunpy.
+The easiest way to install aiapy to follow the instructions on :ref:`sunpy-tutorial-installing`. The only difference is that you will need to install aiapy instead of sunpy. 
+
+If you are not using mini-conda:
</code_context>
<issue_to_address>
**issue (typo):** Add the missing verb "is" in the introductory sentence.

The sentence currently reads "The easiest way to install aiapy to follow the instructions...". To be grammatically correct, it should read "The easiest way to install aiapy is to follow the instructions...".

```suggestion
The easiest way to install aiapy is to follow the instructions on :ref:`sunpy-tutorial-installing`. The only difference is that you will need to install aiapy instead of sunpy. 
```
</issue_to_address>

### Comment 2
<location path="docs/installation.rst" line_range="9" />
<code_context>
-The only difference is that you will need to install aiapy instead of sunpy.
+The easiest way to install aiapy to follow the instructions on :ref:`sunpy-tutorial-installing`. The only difference is that you will need to install aiapy instead of sunpy. 
+
+If you are not using mini-conda:
+
+.. code-block:: bash
</code_context>
<issue_to_address>
**issue (typo):** Correct the product name "mini-conda" to "Miniconda".

Use the official spelling and capitalization (“Miniconda”) to match Conda’s documentation and avoid confusion.

```suggestion
If you are not using Miniconda:
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/installation.rst Outdated
Comment thread docs/installation.rst Outdated
Comment thread docs/installation.rst
@nabobalis
Copy link
Copy Markdown
Member

Thanks again @hayesla

hayesla and others added 8 commits April 28, 2026 09:13
@nabobalis nabobalis merged commit 3a04a0b into LM-SAL:main Apr 28, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add explicit install instructions on webpage

2 participants