This release focuses on major dependency updates, code modernization, and extensive refactoring to improve compatibility with the latest BrainPy ecosystem.
Breaking Changes
- Dependency Version Updates
- Updated
brainstatefrom>=0.1.0to>=0.2.0 - Updated
brainpyfrom>=3.0.0to>=2.7.0 - These updates may require users to upgrade their BrainPy ecosystem packages
- Updated
Refactoring & Code Improvements
-
Core Architecture Simplification (2acd212)
- Refactored
HHTypedNeuronto usebrainpydirectly for better integration - Simplified
_base.pywith significant code reduction (221 insertions, 282 deletions) - Removed deprecated
_integrator_diffrax.pymodule (29 lines removed) - Streamlined integrator implementations in
_integrator_runge_kutta.py - Cleaned up
_single_compartment.pyand integration protocol
- Refactored
-
Parameter Initialization Migration (fa71171, a79c306, 18b053c, 77a11ac)
- Migrated parameter initialization from
brainstate.nntobraintoolsacross the entire codebase - Updated parameter initialization in ion channels (calcium, potassium, sodium, hyperpolarization-activated)
- Refactored parameter initialization in synapse models (markov)
- Updated HTC and EINet classes to use
braintools - Updated all example scripts and notebooks to use
braintoolsfor parameter initialization
- Migrated parameter initialization from
-
API Migration (e84351a, bf50e6e)
- Migrated from
brainstate.nntobrainpy.stateandbraintools - Fixed
_baseerrors in brainpy integration - Updated
CurrentProjreferences across the codebase
- Migrated from
Documentation
- Updated Documentation (#54, 2acd212)
- Updated braincell logo image
- Refreshed tutorial notebooks (cell, channel, ion tutorials in both English and Chinese)
- Updated advanced tutorial examples (sc02-sc05 notebooks)
- Revised quickstart concepts documentation
- Updated all documentation to reflect API changes and new parameter initialization patterns
Examples
- Example Updates
- Updated all example scripts to use new APIs:
SC01_fitting_a_hh_neuron.pySC03_COBA_HH_2007_braincell.pySC05_thalamus_single_compartment_neurons.pySC06_unified_thalamus_model.pySC07_Straital_beta_oscillation_2011.pyMC11_simple_dendrite_model.pyMC13_golgi_model/simulations
- Updated all example scripts to use new APIs:
CI/CD
- Publishing Workflow Enhancement (2acd212)
- Updated
.github/workflows/Publish.ymlwith improved configuration
- Updated
Code Statistics
- Overall changes: 48 files changed, 1,307 insertions(+), 1,408 deletions(-)
- Net reduction of ~100 lines while improving code quality and maintainability