Skip to content

Commit 312f244

Browse files
Added text describing string combination of instrument_ids when merging instruments (#36)
1 parent 584daa5 commit 312f244

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/source/acquire_upload/prepare_before_acquisition.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ The `instrument_id` for AIND should be the SIPE ID for an instrument. If an inst
309309

310310
#### Multiple instruments
311311

312-
Multiple `instrument.json` files can be provided when two separate instruments are used simultaneously to acquire a data asset. See [metadata merging rules](upload.md#metadata-merging-rules) for information about how metadata files are merged during data upload.
312+
Multiple `instrument.json` files can be provided when multiple separate instruments are used simultaneously to acquire a data asset. The combined instrument metadata stored with the associated data asset will have an `instrument_id` that is the combined names of the individual instruments, joined with the `'_'` character. See [metadata merging rules](upload.md#metadata-merging-rules) for information about how metadata files are merged during data upload.
313313

314314
#### Upload options
315315

@@ -339,7 +339,7 @@ Users have two options for providing instrument metadata files:
339339

340340
Note that it is possible to combine these methods. For example, a user could pass the instrument JSON for the behavior instrument in the data directory (named something like `instrument_behavior.json`) and also specify a physiology rig by instrument ID in the `gather_preliminary_metadata` job type settings. The two instrument files would be merged by the data transfer service. See [metadata merging rules](upload.md#metadata-merging-rules).
341341

342-
Also note that we currently require all devices in the database to have a unique `instrument_id`. It is therefore not possible to store two distinct modality specific instrument.json files that share an `instrument_id` in the database.
342+
Also note that we require all devices in the database to have a unique `instrument_id`.
343343

344344
### Maintenance responsibility
345345

docs/source/acquire_upload/upload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Each file must follow the naming pattern `<metadata_type>*.json` where `*` is an
2020

2121
#### Contraints
2222

23-
1. **Unique fields must match**: Certain identifier fields that should be unique across the dataset (like `subject_id` and `instrument_id`) **must have identical values** in all files being merged. If these fields conflict, the merge will fail and your upload job will be rejected.
23+
1. **Unique fields must match**: Certain identifier fields that should be unique across the dataset (like `subject_id`) **must have identical values** in all files being merged. If these fields conflict, the merge will fail and your upload job will be rejected. An important exception is the `instrument_id` field. If two or more instrument JSON files are joined, the merged instrument JSON file will have an `instrument_id` that is the string combination of the IDs of the unique instruments,
2424

2525
2. **No shared devices, with the exception of a single shared clock**: In general, two instruments can be merged **if and only if there are no shared devices** between them. Devices are identified by their `name` field. If the same device name appears in both instrument files, they should really be defined as a single instrument, not two separate ones.
2626

0 commit comments

Comments
 (0)