Skip to content

[update] Refine installation instructions and improve docstring formatting#767

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

[update] Refine installation instructions and improve docstring formatting#767
chaoming0625 merged 3 commits into
masterfrom
doc

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Aug 1, 2025

Copy link
Copy Markdown
Member

This pull request includes updates to the documentation, codebase, and dependency management for the BrainPy project. The changes focus on improving clarity, updating installation instructions, and ensuring consistency with the project's recent rewrite based on the BrainState framework.

Documentation Updates:

  • Updated the license badge in README.md to use a GNU GPLv3 badge and removed references to OpenI. Added a note about BrainPy's rewrite based on BrainState and updated the Python version requirement to 3.10. [1] [2]
  • Simplified installation instructions in docs/index.rst by removing dependency links for GPU and TPU installations and added a note about the BrainState rewrite. [1] [2]
  • Removed the installation section from the quickstart table of contents in docs/index.rst.

Codebase Improvements:

  • Updated docstrings across multiple files (lowdim_analyzer.py, lowdim_bifurcation.py, random_conn.py) to use raw string literals (r""") for better rendering of mathematical expressions in documentation. [1] [2] [3] [4] [5] [6] [7]

Dependency Management:

  • Removed unused dependency_links from setup.py and corrected the TPU extras requirement to include brainstate[tpu] instead of brainstate[cuda12].

@chaoming0625 chaoming0625 merged commit 62448bf into master Aug 1, 2025
50 checks passed
@chaoming0625 chaoming0625 deleted the doc branch August 1, 2025 05:09
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