# Physical units and unit-aware mathematical system in JAX
<p align="center">
<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/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/chaobrain/brainunit/actions/workflows/CI.yml"><img alt="Continuous Integration" src="https://github.com/chaobrain/brainunit/actions/workflows/CI.yml/badge.svg"></a>
<a href="https://pepy.tech/projects/brainunit"><img src="https://static.pepy.tech/badge/brainunit" alt="PyPI Downloads"></a>
</p>
[``brainunit``](https://github.com/chaor/brainunit) provides physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science
## Installation
You can install ``brainunit`` via pip:
```bash
pip install brainunit --upgrade
```
## Documentation
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.
Other unofficial projects include:
- [``diffrax``](https://github.com/chaoming0625/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/).
[``brainunit``](https://github.com/chaobrain/brainunit) has been deeply integrated into our BDP ecosystem.
Raw data
{
"_id": null,
"home_page": "https://github.com/chaoming0625/brainunit",
"name": "brainunit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "physical unit, physical quantity, brain modeling",
"author": "BrainUnit Developers",
"author_email": "BrainUnit Developers <chao.brain@qq.com>",
"download_url": null,
"platform": null,
"description": "\r\n\r\n# Physical units and unit-aware mathematical system in JAX\r\n\r\n<p align=\"center\">\r\n \t<img alt=\"Header image of brainunit.\" src=\"https://github.com/chaobrain/brainunit/blob/main/docs/_static/brainunit.png\" width=50%>\r\n</p> \r\n\r\n\r\n\r\n<p align=\"center\">\r\n\t<a href=\"https://pypi.org/project/brainunit/\"><img alt=\"Supported Python Version\" src=\"https://img.shields.io/pypi/pyversions/brainunit\"></a>\r\n\t<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>\r\n <a href='https://brainunit.readthedocs.io/en/latest/?badge=latest'>\r\n <img src='https://readthedocs.org/projects/brainunit/badge/?version=latest' alt='Documentation Status' />\r\n </a> \t\r\n <a href=\"https://badge.fury.io/py/brainunit\"><img alt=\"PyPI version\" src=\"https://badge.fury.io/py/brainunit.svg\"></a>\r\n <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>\r\n <a href=\"https://pepy.tech/projects/brainunit\"><img src=\"https://static.pepy.tech/badge/brainunit\" alt=\"PyPI Downloads\"></a>\r\n</p>\r\n\r\n\r\n[``brainunit``](https://github.com/chaor/brainunit) provides physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science\r\n\r\n\r\n## Installation\r\n\r\nYou can install ``brainunit`` via pip:\r\n\r\n```bash\r\npip install brainunit --upgrade\r\n```\r\n\r\n## Documentation\r\n\r\nThe official documentation is hosted on Read the Docs: [https://brainunit.readthedocs.io](https://brainunit.readthedocs.io)\r\n\r\n\r\n## Unit-aware computation ecosystem\r\n\r\n\r\n`brainunit` has been deeply integrated into following diverse projects, such as:\r\n\r\n- [``brainstate``](https://github.com/chaobrain/brainstate): A State-based Transformation System for Program Compilation and Augmentation\r\n- [``braintaichi``](https://github.com/chaobrain/braintaichi): Leveraging Taichi Lang to customize brain dynamics operators\r\n- [``braintools``](https://github.com/chaobrain/braintools): The Common Toolbox for Brain Dynamics Programming.\r\n- [``dendritex``](https://github.com/chaobrain/dendritex): Dendritic Modeling in JAX\r\n- [``pinnx``](https://github.com/chaobrain/pinnx): Physics-Informed Neural Networks for Scientific Machine Learning in JAX.\r\n\r\n\r\nOther unofficial projects include:\r\n\r\n- [``diffrax``](https://github.com/chaoming0625/diffrax): Numerical differential equation solvers in JAX.\r\n- [``jax-md``](https://github.com/Routhleck/jax-md): Differentiable Molecular Dynamics in JAX\r\n- [``Catalax``](https://github.com/Routhleck/Catalax): JAX-based framework to model biological systems\r\n- ...\r\n\r\n\r\n\r\n## See also the BDP ecosystem\r\n\r\nWe are building the [brain dynamics programming ecosystem](https://ecosystem-for-brain-dynamics.readthedocs.io/). \r\n[``brainunit``](https://github.com/chaobrain/brainunit) has been deeply integrated into our BDP ecosystem.\r\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Physical Units and Unit-aware Mathematical System in JAX",
"version": "0.0.4.post20241217",
"project_urls": {
"Homepage": "https://github.com/chaoming0625/brainunit",
"homepage": "http://github.com/chaoming0625/brainunit",
"repository": "http://github.com/chaoming0625/brainunit"
},
"split_keywords": [
"physical unit",
" physical quantity",
" brain modeling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "163367fd1f4e91f6bb085d69602813d9d64683131807e133cae8eeb374ea136b",
"md5": "91ccb444fb82fc4aea56da8dd64b4666",
"sha256": "01297713b960258bd23182acb339aaf9bc76166dd749a903856de7972c4ceec3"
},
"downloads": -1,
"filename": "brainunit-0.0.4.post20241217-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "91ccb444fb82fc4aea56da8dd64b4666",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 283112,
"upload_time": "2024-12-17T12:34:19",
"upload_time_iso_8601": "2024-12-17T12:34:19.115191Z",
"url": "https://files.pythonhosted.org/packages/16/33/67fd1f4e91f6bb085d69602813d9d64683131807e133cae8eeb374ea136b/brainunit-0.0.4.post20241217-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 12:34:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaoming0625",
"github_project": "brainunit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "jax",
"specs": []
},
{
"name": "jaxlib",
"specs": []
},
{
"name": "typing_extensions",
"specs": []
}
],
"lcname": "brainunit"
}
JSON
