Skip to content

Commit

Permalink
Update README (#98)
Browse files Browse the repository at this point in the history
* update README

* fix

* fix tests

* update README
  • Loading branch information
chaoming0625 authored Feb 2, 2025
1 parent 0d01b3a commit f9f03d4
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

It is initially designed to enable unit-aware computations in brain dynamics modeling (see our [ecosystem](https://ecosystem-for-brain-dynamics.readthedocs.io/)).

However, its features and capacities can be applied to general domains for scientific computing and AI for science.
However, its features and capacities can be applied to general domains in scientific computing and AI for science.
We also provide ample examples and tutorials to help users integrate ``brainunit`` into their projects
(see [Unit-aware computation ecosystem](#unit-aware-computation-ecosystem) in the below).

Expand All @@ -42,6 +42,20 @@ The uniqueness of ``Brainunit`` lies in that it brings physical units handling a
- Its physical units and unit-aware functions are fully compatible with JAX, including autograd, JIT, vecterization, parallelization, and others.


```mermaid
graph TD
A[BrainUnit] --> B[Physical Units]
A --> C[Mathematical Functions]
A --> D[JAX Integration]
B --> B1[2000+ Units]
B --> B2[Physical Constants]
C --> C1[500+ Unit-aware Functions]
D --> D1[Autograd]
D --> D2[JIT Compilation]
D --> D3[Vectorization]
D --> D4[Parallelization]
```

A quick example:

```python
Expand Down

0 comments on commit f9f03d4

Please sign in to comment.