Add installation instructions to usage documentation page#312
Open
Add installation instructions to usage documentation page#312
Conversation
Co-authored-by: JohnGriffiths <397826+JohnGriffiths@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add installation instructions to documentation page
Add installation instructions to usage documentation page
Mar 16, 2026
JohnGriffiths
approved these changes
Mar 16, 2026
|
📖 Documentation preview for this PR is available at: This preview will be updated as you push new commits to this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The "Installation and Usage" docs page at
doc/documentation/usage/installation.rstwas sparse — only covering installation from source via conda+git, with no pip install path or verification steps.Changes
doc/documentation/usage/installation.rstpip install whobpytpip install -e .)pip install -r requirements.txt)Original prompt
Add installation instructions to the documentation page currently titled 'installation and usage' (found at docs/usage/index.md or the corresponding file powering https://griffithslab.github.io/whobpyt/documentation/usage/index.html).
The new content should provide clear and standard installation steps for users:
Format the content clearly with markdown headings and fenced code blocks.
Do not remove any useful existing content from the page. If other instructions are present, append the new section below them.
The following is the prior conversation context from the user's chat exploration (may be truncated):
User: make me some suggestions to improve the whobpyt website pages at https://github.com/griffithslab/whobpyt
Assistant: Here are some suggestions to improve the whobpyt website pages, based on best practices for open-source scientific software, typical user expectations, and standard GitHub Pages conventions:
1. Enhance the Project Landing Page (README.md)
2. Dedicated Website Content (Docs or GitHub Pages)
3. Navigation and Appearance
4. Technical Improvements
5. Community and Outreach
Would you like detailed example layouts or recommended open-source templates for any of these suggestions? If you have a specific doc generator (Sphinx, MkDocs, etc.), I can tailor guidance accordingly.
User: this is the built website fyi
https://griffithslab.github.io/whobpyt/
Assistant: Thank you for sharing your current built website: https://griffithslab.github.io/whobpyt/
Based on the typical layout and contents of scientific software documentation sites, and combining that with my previous suggestions, here is feedback specifically tailored to improving your whobpyt website:
Review & Suggestions for https://griffithslab.github.io/whobpyt/
1. Homepage Improvements
Open your homepage with a concise summary: “whobpyt is a Whole-Brain Modeling package in PyTorch for large-scale neural activity simulations.”
Make sure it’s immediately clear what the software does, who it’s for, and what problems it solves.
Highlight major features—e.g., modular brain models, PyTorch backend, interoperability, examples.
Offer a short code...
This pull request was created from Copilot chat.
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.