Skip to content

Commit beca517

Browse files
Fleshed out language surrounding instrument naming
1 parent be4b785 commit beca517

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

docs/source/acquire_upload/prepare_before_acquisition.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,11 +299,28 @@ Subject metadata is populated by lab animal services (LAS) without your involvem
299299

300300
## Instrument
301301

302-
[Instrument](https://aind-data-schema.readthedocs.io/en/latest/instrument.html) metadata should be prepared in advance of data acquisition.
302+
[Instrument](https://aind-data-schema.readthedocs.io/en/latest/instrument.html) metadata should be prepared in advance of data acquisition. Instrument metadata should describe the full set of devices that are combined into the physical instrument that is used to collect an associated dataset, regardless of whether those devices are active on a given session. This makes it possible to specify an instrument.json as a stable collection of devices (just like a physical instrument in the lab) even if some of those devices are used only in a subset of experimental sessions. The actual list of active devices and their configurable settings should be specified separately in the acquisition.json.
303+
304+
Examples of physical instruments that should have corresponding instrument.json files are:
305+
* Individual behavioral training boxes
306+
* Behavior recording devices that can be combined transiently with physiology rigs
307+
* Physiology rigs (e.g. ephys, fiber photometry, two-photon imaging, etc)
308+
309+
In cases where a devices for multiple modalities are combined in a persistent manner (e.g. behavior equipment that is built into a physiology rig), that combination of devices should generally be tracked as a single instrument with a single corresponding instrument.json file.
310+
311+
When collections of devices are combined transiently (e.g. a physiology system that is combined with a physiology system in a swappable manner), those collections of devices can be described by separate instrument.json files that are combined into a single instrument at the time of upload. See the "Multiple Instruments" section below for details.
312+
303313

304314
### ID
305315

306-
The `instrument_id` for AIND should be the SIPE ID for an instrument. If an instrument is not tracked by SIPE, any string will be accepted.
316+
The `instrument_id` for AIND should be the SIPE ID for an instrument. SIPE instrument IDs are generally tracked relative to the computer(s) included in that instrument. A json-formatted list of SIPE instruments and associated computers can be found [here](http://mpe-computers/v2.0).
317+
318+
Examples of instruments tracked by SIPE:
319+
* a foraging behavior box, "FRG.10-A"
320+
* a mesoscope system, "MESO.1"
321+
* a combined ephys/behavior system, "ND_Ephys.1"
322+
323+
If an instrument is not tracked by SIPE, any string will be accepted.
307324

308325
### Other details
309326

0 commit comments

Comments
 (0)