Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
chaoming0625 committed Dec 6, 2024
1 parent d8643d6 commit c534b6b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ io_test_tmp*
brainpy/math/brainpy_object/tests/io_test_tmp*

lib/
.VSCodeCounter

development

Expand Down
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
# Physical units and unit-aware mathematical system in JAX

<p align="center">
<img alt="Header image of brainunit." src="https://github.com/chaoming0625/brainunit/blob/main/docs/_static/brainunit.png" width=50%>
<img alt="Header image of brainunit." src="https://github.com/chaobrain/brainunit/blob/main/docs/_static/brainunit.png" width=50%>
</p>



<p align="center">
<a href="https://pypi.org/project/brainunit/"><img alt="Supported Python Version" src="https://img.shields.io/pypi/pyversions/brainunit"></a>
<a href="https://github.com/chaoming0625/brainunit/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href="https://github.com/chaobrain/brainunit/blob/main/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href='https://brainunit.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/brainunit/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://badge.fury.io/py/brainunit"><img alt="PyPI version" src="https://badge.fury.io/py/brainunit.svg"></a>
<a href="https://github.com/chaoming0625/brainunit/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaoming0625/brainunit/actions/workflows/CI.yml/badge.svg"></a>
<a href="https://github.com/chaobrain/brainunit/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/brainunit/actions/workflows/CI.yml/badge.svg"></a>
</p>


[``brainunit``](https://github.com/chaoming0625/brainunit) provides physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science
[``brainunit``](https://github.com/chaor/brainunit) provides physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science


## Installation
Expand All @@ -35,7 +35,25 @@ pip install brainunit --upgrade
The official documentation is hosted on Read the Docs: [https://brainunit.readthedocs.io](https://brainunit.readthedocs.io)


## Unit-Aware Computation Ecosystem


`brainunit` has been deeply integrated into following diverse projects, such as:

- [``brainstate``](https://github.com/chaobrain/brainstate): A State-based Transformation System for Program Compilation and Augmentation
- [``braintaichi``](https://github.com/chaobrain/braintaichi): Leveraging Taichi Lang to customize brain dynamics operators
- [``braintools``](https://github.com/chaobrain/braintools): The Common Toolbox for Brain Dynamics Programming.
- [``dendritex``](https://github.com/chaobrain/dendritex): Dendritic Modeling in JAX
- [``pinnx``](https://github.com/chaobrain/pinnx): Physics-Informed Neural Networks for Scientific Machine Learning in JAX.

- [``diffrax``](https://github.com/chaobrain/diffrax): Numerical differential equation solvers in JAX.
- [``jax-md``](○https://github.com/Routhleck/jax-md): Differentiable Molecular Dynamics in JAX
- [``Catalax``](https://github.com/Routhleck/Catalax): JAX-based framework to model biological systems
- ...



## See also the BDP ecosystem

We are building the [brain dynamics programming ecosystem](https://ecosystem-for-brain-dynamics.readthedocs.io/).
We are building the [brain dynamics programming ecosystem](https://ecosystem-for-brain-dynamics.readthedocs.io/).
[``brainunit``](https://github.com/chaobrain/brainunit) has been deeply integrated into our BDP ecosystem.

0 comments on commit c534b6b

Please sign in to comment.