refactor(quad): remove diffrax + docs cleanup#94
Merged
Conversation
The diffrax-backed step functions in braincell.quad pulled in a heavy optional dependency for adaptive-stepsize solvers that overlapped with the in-tree explicit, implicit, exponential-Euler, and staggered families already covering every multi-compartment use case. - Deleted braincell/quad/_diffrax.py and its test module. - Dropped the diffrax_*_step re-exports and __all__ entries from braincell/quad/__init__.py and the diffrax mention from the module docstring. - Removed "diffrax" from the IntegratorEntry.category enumeration in braincell/quad/_registry.py. - Removed the diffrax extra and the diffrax entries from the all/ testing dep groups in pyproject.toml. - Scrubbed diffrax references from README.md, TODO.md, docs/interface-map.md, and the section 5.6 catalog block of examples/multi_compartment/quad.ipynb.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Sorry @chaoming0625, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
…ion artifacts - docs/Makefile: rename SPHINXPROJ from the leftover "brainpy" value to "braincell" so the Sphinx build identifies the project correctly. - Remove docs/architecture.xml and examples/multi_compartment/vis_outputs/publication.pdf — generated artifacts left over from an earlier branch that should not be tracked.
chaoming0625
changed the title
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Commit 1 —
refactor(quad): remove diffrax integrator familydiffrax-backed integrator family frombraincell.quad— the explicit, implicit, exponential-Euler, and staggered families already in-tree cover every multi-compartment use case, so the heavy optional dependency was carrying its weight only as duplication.braincell/quad/_diffrax.pyand its test module, drops the 12diffrax_*_stepre-exports +__all__entries frombraincell/quad/__init__.py, and removes"diffrax"from theIntegratorEntry.categoryenumeration docstring inbraincell/quad/_registry.py.quad = ["diffrax"]extra and the two"diffrax"entries (inall/testingdep groups) frompyproject.toml; scrubs the user-facing mentions inREADME.md,TODO.md,docs/interface-map.md, and section 5.6 ofexamples/multi_compartment/quad.ipynb.changelog.md,dev/legacy/...,dev/superpowers/..., dated.claude/CLAUDE-26.04.*.mdsnapshots) were left intact by design.Commit 2 —
chore(docs): fix SPHINXPROJ name and drop stale architecture/publication artifactsdocs/Makefile: renameSPHINXPROJfrom the leftover"brainpy"to"braincell"so the Sphinx build identifies the project correctly.docs/architecture.xmlandexamples/multi_compartment/vis_outputs/publication.pdf— generated artifacts left over from an earlier branch.Test plan
python -c "import braincell.quad as q; print(len(q.get_registry().names()))"succeeds and registers nodiffrax_*entriespytest braincell/quad/collects and passesgrep -rn diffrax braincell/ pyproject.toml docs/ examples/ README.md TODO.mdreturns no matchespip install -e ".[all]"does not pulldiffraxmake -C docs htmlbuilds withSPHINXPROJ=braincell