Skip to content

Add diagram of modular experiments#162

Open
bruno-f-cruz wants to merge 18 commits into
mainfrom
feat-add-composable-experiments-diagram
Open

Add diagram of modular experiments#162
bruno-f-cruz wants to merge 18 commits into
mainfrom
feat-add-composable-experiments-diagram

Conversation

@bruno-f-cruz

@bruno-f-cruz bruno-f-cruz commented Jun 2, 2026

Copy link
Copy Markdown
Member

This PR adds documentation on the initial proposal from 1.5 years ago on how modular experiments should be designed (this is the initial architecture designed for vr-foraging, but likely applicable for other platforms)


📚 Documentation preview 📚: https://scicomp-docs--162.org.readthedocs.build/en/162/

arielleleon and others added 17 commits May 18, 2026 10:32
#134)

* refactor: move low level diagrams from dynamic-foraging to dynamic_foraging

* fix: clean up bad files
* Update index linking for outreach.md page

* Update headers

* Minor text edit
Fixes #126
also adds sphinx-copybutton extension
* Added readme about github backing of CO capsules

---------

Co-authored-by: Doug Ollerenshaw <doug.ollerenshaw@alleninstitute.org>
* update pipeline versioning doc

* move file and update links

* minor glossary updates
* docs: calibration

* docs: clarify archive practice

* docs: move to the calibration file previously added

* docs: typo

* docs: rewrite calibration section

* Update calibration.md
…ix typo (#159)

* fix: expose full contents of error messages

* fix: allow 400 responses for subject/procedures

* docs: typo
* docs: rework the find data sections

* docs: move data portal up

* docs: typo

* docs: generalize

![Modular experiments architecture](modular-experiments.svg)

The diagram describes how independent acquisition **platforms** are composed into a single **experiment** and carried through the AIND data pipeline. It follows the architecture proposed for the `Aind.Behavior.Services` framework (see *"Towards modular platforms and composable experiments"*). The example shown is a typical session combining **one behavior platform** (Behavior + Behavior Videos) with **two physiology platforms** (Fiber Photometry and Electrophysiology) acquired simultaneously.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(see "Towards modular platforms and composable experiments")

Should/can this refer to something accessible?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually now that the acquisition architecture exists I shiuld drop the AIND.behavior.services mention. I think this is compatible with the instrument architecture, what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants