Skip to content

Add BrainPy citation and update documentation#770

Merged
chaoming0625 merged 5 commits into
masterfrom
doc
Aug 3, 2025
Merged

Add BrainPy citation and update documentation#770
chaoming0625 merged 5 commits into
masterfrom
doc

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Aug 3, 2025

Copy link
Copy Markdown
Member

This pull request includes updates to the README.md and documentation files to improve clarity, provide updated references, and enhance usability. The most important changes include updating references to BrainPy's ecosystem and documentation, adding citation details for the BrainPy framework, and reorganizing the API documentation structure.

Updates to README.md:

  • Updated the description of BrainPy's foundation to specify that it has been rewritten based on brainstate since August 2025.
  • Replaced the outdated link to brainpy-datasets with a more general reference to the "brain modeling ecosystem."
  • Added a detailed BibTeX citation for BrainPy, including publication details in the journal eLife, for users to reference the framework in academic work.

Documentation improvements:

  • Removed changelog links (brainpy-changelog.md and brainpylib-changelog.md) from the docs/api.rst file, likely to streamline the API documentation.
  • Added an "Ecosystem" installation tab in docs/index.rst with commands for installing BrainX on different platforms (CPU, CUDA, TPU).
  • Updated the "Learn more" section in docs/index.rst to include changelog links and fixed an outdated example link. [1] [2]

Summary by Sourcery

Enhance README and documentation by updating BrainPy references, adding citation details, and improving the ecosystem installation and API docs structure

New Features:

  • Add detailed BibTeX citation for the BrainPy framework in README.md
  • Introduce an "Ecosystem" installation tab with CPU, CUDA, and TPU commands in docs/index.rst

Enhancements:

  • Update README to specify rewriting based on brainstate since August 2025
  • Replace the brainpy-datasets link with a generic brain modeling ecosystem reference

Documentation:

  • Remove obsolete changelog links from docs/api.rst
  • Update "Learn more" section in docs/index.rst with corrected example and changelog links

@sourcery-ai

sourcery-ai Bot commented Aug 3, 2025

Copy link
Copy Markdown

Reviewer's Guide

Enhance project documentation by refining the README foundation description, replacing outdated links with a general ecosystem reference, embedding a detailed BibTeX citation, removing stale changelog links from the API docs, and extending the index rst with an Ecosystem installation tab and updated Learn More section.

File-Level Changes

Change Details Files
Enhanced README foundation description and citation details
  • Clarified rewrite origin with “since August 2025”
  • Replaced brainpy-datasets link with a generic ecosystem reference
  • Inserted detailed BibTeX citation block for academic referencing
README.md
Streamlined API documentation by removing outdated links
  • Deleted brainpy-changelog.md link
  • Deleted brainpylib-changelog.md link
docs/api.rst
Reorganized landing page with an Ecosystem install tab and refreshed Learn More section
  • Added Ecosystem installation tab with CPU, CUDA, and TPU commands
  • Updated Learn More section with changelog links
  • Fixed outdated example link
docs/index.rst

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey @chaoming0625 - I've reviewed your changes and they look great!


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.

@chaoming0625

Copy link
Copy Markdown
Member Author

@sourcery-ai title

@sourcery-ai sourcery-ai Bot changed the title [update] Enhance documentation with Ecosystem installation instructions and update citation details Add BrainPy citation and update documentation Aug 3, 2025
@chaoming0625 chaoming0625 merged commit 6e3874f into master Aug 3, 2025
50 of 51 checks passed
@chaoming0625 chaoming0625 deleted the doc branch August 3, 2025 05:19
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.

1 participant