-
Notifications
You must be signed in to change notification settings - Fork 45
Developer Information
This page is for people working on ISETBio's code, not primarily for users.
ISETBio follows the shared programming conventions used across the ISET
family of toolboxes (ISETCam, ISETBio, ISET3d): the create/get/set/
compute/plot/window pattern, nounVerb function naming, the ie-
prefixed namespace, and the ieAddObject/ieGetObject data-management
functions. These are documented in the
ISETCam wiki's Programming Conventions page.
Note: a single, canonical "For Developers" home for all ISET toolboxes is planned for the ISETCam wiki, but has not been written yet. Until it exists, this page and its children carry ISETBio-specific developer notes; some of that content will likely move or merge once the ISETCam-wide version exists.
ISETBio uses ISETCam's shared test engine. isetbioUnitTest runs the core
unit suite; isetbioTutorialTest and isetbioExampleTest run the teaching
scripts. See Validation and the matlab-testing skill in the
ISETBio repository for details.
- Documentation format - function, class, and tutorial header conventions
- Commit hooks - historical notes on pre-commit test hooks; needs review against the current repository layout