diff --git a/README.md b/README.md index c8735d7..63810aa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# The Unit System for Brain Dynamics Programming +# Physical units and unit-aware mathematical system in JAX

Header image of brainunit. @@ -19,7 +19,7 @@

-[``brainunit``](https://github.com/brainpy/brainunit) provides a unit-aware mathematical system for brain dynamics programming (BDP). +[``brainunit``](https://github.com/brainpy/brainunit) provides physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science ## Installation @@ -40,7 +40,7 @@ The official documentation is hosted on Read the Docs: [https://brainunit.readth - [``brainstate``](https://github.com/brainpy/brainstate): A ``State``-based transformation system for brain dynamics programming. -- [``brainunit``](https://github.com/brainpy/brainunit): The unit system for brain dynamics programming. +- [``brainunit``](https://github.com/brainpy/brainunit): Physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science. - [``braintaichi``](https://github.com/brainpy/braintaichi): Leveraging Taichi Lang to customize brain dynamics operators. diff --git a/changelog.md b/changelog.md index efb2823..52b250d 100644 --- a/changelog.md +++ b/changelog.md @@ -1,4 +1,8 @@ # Release Notes +## Version 0.0.1 + +The first release of the project. + diff --git a/docs/_static/brainunit.png b/docs/_static/brainunit.png index 665b255..a135b05 100644 Binary files a/docs/_static/brainunit.png and b/docs/_static/brainunit.png differ diff --git a/docs/conf.py b/docs/conf.py index 1b9348b..cfe6fa1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,11 +28,22 @@ import os import sys +import shutil sys.path.insert(0, os.path.abspath('../')) import brainunit +os.makedirs('apis/', exist_ok=True) + +changelogs = [ + ('../changelog.md', 'apis/changelog.md'), +] +for source, dest in changelogs: + if os.path.exists(dest): + os.remove(dest) + shutil.copyfile(source, dest) + # -- Project information ----------------------------------------------------- @@ -100,7 +111,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] html_theme = "sphinx_book_theme" -html_logo = "_static/brainunit.jpg" +html_logo = "_static/brainunit.png" html_title = "brainunit" html_copy_source = True html_sourcelink_suffix = "" diff --git a/docs/index.rst b/docs/index.rst index b27f4a3..8d50620 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,10 @@ ``brainunit`` documentation =========================== -`brainunit `_ provides a unit-aware system for brain dynamics programming (BDP). +`brainunit `_ provides physical units and unit-aware mathematical system in JAX for brain dynamics and AI4Science. + + + ---- @@ -17,12 +20,6 @@ Installation pip install -U brainunit[cpu] - .. tab-item:: GPU (CUDA 11.0) - - .. code-block:: bash - - pip install -U brainunit[cuda11] - .. tab-item:: GPU (CUDA 12.0) .. code-block:: bash @@ -38,70 +35,6 @@ Installation ----- - -Learn more -^^^^^^^^^^ - -.. grid:: - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`rocket_launch;2em` Installation - :class-card: sd-text-black sd-bg-light - :link: quickstart/installation.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`library_books;2em` Core Concepts - :class-card: sd-text-black sd-bg-light - :link: core_concepts.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`science;2em` BDP Tutorials - :class-card: sd-text-black sd-bg-light - :link: tutorials.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`token;2em` Advanced Tutorials - :class-card: sd-text-black sd-bg-light - :link: advanced_tutorials.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`settings;2em` BDP Toolboxes - :class-card: sd-text-black sd-bg-light - :link: toolboxes.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`rocket_launch;2em` FAQ - :class-card: sd-text-black sd-bg-light - :link: FAQ.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`data_exploration;2em` API documentation - :class-card: sd-text-black sd-bg-light - :link: api.html - - .. grid-item:: - :columns: 6 6 6 4 - - .. card:: :material-regular:`settings;2em` Examples - :class-card: sd-text-black sd-bg-light - :link: https://brainpy-examples.readthedocs.io/en/latest/index.html - - ---- @@ -150,7 +83,9 @@ See also the BDP ecosystem :maxdepth: 1 :caption: API Documentation - api.rst + apis/changelog.md + apis/brainunit.rst + apis/brainunit.math.rst diff --git a/setup.py b/setup.py index f0d8274..f1d29fc 100644 --- a/setup.py +++ b/setup.py @@ -64,13 +64,9 @@ "Source Code": "https://github.com/brainpy/brainunit", }, extras_require={ - 'cpu': ['jaxlib', ], - 'cuda11': ['jaxlib[cuda11_pip]', ], + 'cpu': ['jaxlib'], 'cuda12': ['jaxlib[cuda12_pip]', ], 'tpu': ['jaxlib[tpu]'], - 'cpu_mini': ['jaxlib'], - 'cuda11_mini': ['jaxlib[cuda11_pip]'], - 'cuda12_mini': ['jaxlib[cuda12_pip]'], }, keywords=('computational neuroscience, ' 'brain-inspired computation, '