[update] Refine installation instructions and improve docstring formatting#767
Merged
Conversation
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.
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:
README.mdto 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]docs/index.rstby removing dependency links for GPU and TPU installations and added a note about the BrainState rewrite. [1] [2]docs/index.rst.Codebase Improvements:
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:
dependency_linksfromsetup.pyand corrected the TPU extras requirement to includebrainstate[tpu]instead ofbrainstate[cuda12].