copilot instructions - ISET/isetcam GitHub Wiki
This repository contains the user-facing ISETCam wiki. It does not contain the MATLAB source code.
When documenting current APIs, tutorials, examples, data loading, or tests, consult the sibling ISETCam repository when it is available:
-
../isetcam/.github/copilot-instructions.md— repository-wide code guidance -
../isetcam/.github/skills/<topic>/SKILL.md— task-specific code workflows -
../isetcam/tutorials/,../isetcam/examples/, and../isetcam/validate/— runnable names and current entry points
Do not duplicate MATLAB runtime, testing, or implementation procedures here.
If the sibling repository is unavailable, do not infer current API behavior;
flag the fact for verification or use an authoritative source on ISETCam's
default branch. Confirm the branch rather than assuming it; ISET/isetcam
uses main as of this writing.
ISETCam is the required foundation for both ISETBio and ISET3D. Neither dependent repository can run unless ISETCam is installed and on the MATLAB path. Keep shared scene, optical-image, sensor, image-processing, display, color, and general metric guidance here so the dependent wikis can link to one canonical explanation instead of duplicating it.
Keep repository boundaries clear:
- ISET3D owns 3D recipes, assets, PBRT, and local or remote rendering.
- ISETBio owns human optics, cone mosaics, eye movements, retinal current, and retinal ganglion-cell models.
- ISETCam owns the shared computational representations and pipeline used by both.
When stable ISETCam page or published-tutorial targets change, audit inbound
links from ../isetbio.wiki and ../iset3d.wiki as part of the same
documentation update.
Treat self-contained tutorial HTML generated by iePublish as a first-class
part of the wiki experience. For a recommended tutorial:
- verify the
.msource and committed.htmlcounterpart in the current ISETCam source tree; - make the rendered HTML the primary learning link and put the
.msource link alongside it; - use a served or preview URL that renders the HTML, not GitHub's ordinary
blobpage, which displays HTML source; - run or otherwise verify the tutorial and visually inspect regenerated HTML before presenting it as current; and
- regenerate and commit the HTML when its source tutorial changes.
Consult
../isetcam/.github/skills/publishing-tutorials-examples/SKILL.md for the
publication workflow and
../isetcam/.github/skills/testing-workflow/SKILL.md for tutorial smoke tests.
- Keep the Home page and sidebar task-oriented, concise, and current.
- Use the current ISETCam source tree as the authority for supported public
workflows. Link source files to the
mainbranch, never retired paths. - Clearly distinguish supported user workflows from advanced or experimental workflows and historical or retired material.
- Keep durable user guidance in this wiki. Put developer implementation detail
in ISETCam's
docs/directory or in its task-specific skills. - Preserve useful scientific history through a clearly marked archival or redirect page rather than silently removing context.
- Keep page names stable once ISETBio or ISET3D links to them. When a rename is necessary, preserve the old name with a short moved-page stub.
Before publishing a substantive update, check the affected internal links, GitHub source links, image paths, and names of cited tutorials, examples, and test runners. Use the local-preview skill to expose exact filename/case errors. Update related navigation, published tutorial HTML, and screenshots when a page or tutorial is substantially reorganized.
Do not claim that an API, test, tutorial, data collection, or other workflow is supported unless the current ISETCam source confirms it.