Skip to content

Update installation instruction #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chaoming0625 merged 2 commits into from
Mar 5, 2024
Merged

Update installation instruction #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b67dcea
update
chaoming0625 Mar 3, 2024
0e866f4
update installation docs
chaoming0625 Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion brainpylib-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@

## Version 0.3.0

- Support `brainpy>=2.5.0`
- Fix bugs on windows platform
- remove all customized C++ and CUDA operators


## Version 0.2.8

- Support `brainpy>=2.5.0`
- Fix bugs that the DLL cannot be loaded correctly when windows does not have a c++ environment,

## ~~Version 0.2.7(YANKED)~~

## Version 0.2.6

- Support `brainpy>=2.5.0`
- Fix bugs of taichi call function for single result

## Version 0.2.5
Expand Down
14 changes: 11 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,24 @@ Installation

pip install -U brainpy[cpu] # windows, linux, macos

.. tab-item:: GPU (CUDA)
.. tab-item:: GPU (CUDA 11.0)

.. code-block:: bash

# for CUDA 11.0, Linux only
pip install -U brainpy[cuda11] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

# for CUDA 12.0, Linux only
.. tab-item:: GPU (CUDA 12.0)

.. code-block:: bash

pip install -U brainpy[cuda12] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

.. tab-item:: TPU

.. code-block:: bash

pip install -U brainpy[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html


For more information, please see `installation <quickstart/installation.html>`_ section.

Expand Down
18 changes: 16 additions & 2 deletions docs/quickstart/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ To install brainpy with minimum requirements (has installed ``jax`` and ``jaxlib

.. code-block:: bash

pip install brainpy # for CPU

pip install brainpy


Minimum requirements (with dependencies)
Expand All @@ -35,6 +34,9 @@ To install brainpy with minimum requirements (only depends on ``jax``), you can
pip install brainpy[cuda11_mini] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html # for CUDA 11.0
pip install brainpy[cuda12_mini] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html # for CUDA 12.0

# or

pip install brainpy[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html # for google TPU


CPU with all dependencies
Expand All @@ -61,6 +63,18 @@ To install a GPU-only version of BrainPy, you can run



TPU with all dependencies
-------------------------

BrainPy supports Google Cloud TPU. To install BrainPy along with appropriate versions of jax,
you can run the following in your cloud TPU VM:

.. code-block:: bash

pip install brainpy[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html # for google TPU



``brainpylib``
--------------

Expand Down