aind-data-schema 2.5.0__tar.gz → 2.6.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {aind_data_schema-2.5.0/src/aind_data_schema.egg-info → aind_data_schema-2.6.0}/PKG-INFO +2 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/procedures.md +3 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/acquisition.md +2 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/devices.md +1 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/organizations.md +54 -53
- aind_data_schema-2.6.0/docs/source/aind_data_schema_models/species.md +35 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/configs.md +33 -44
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/devices.md +20 -13
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/identifiers.md +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/subjects.md +26 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/instrument.md +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/procedures.md +3 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/validation.md +9 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/aibs_smartspim_instrument.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/aibs_smartspim_procedures.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/aind_smartspim_instrument.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/bergamo_ophys_acquisition.py +4 -3
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/data_description.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/ephys_acquisition.py +32 -11
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/exaspim_acquisition.py +4 -3
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/exaspim_instrument.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/fip_behavior_instrument.py +2 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/fip_ophys_acquisition.py +4 -3
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/fip_ophys_instrument.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/mri_acquisition.py +6 -6
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/multiplane_ophys_acquisition.py +4 -3
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/ophys_acquisition.py +4 -3
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/ophys_procedures.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/procedures.py +1 -1
- aind_data_schema-2.6.0/examples/slap2_acquisition.py +423 -0
- aind_data_schema-2.6.0/examples/slap2_instrument.py +398 -0
- aind_data_schema-2.6.0/examples/slap2_structure_acquisition.py +232 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/subject.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/pyproject.toml +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/acquisition_schema.json +160 -227
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/instrument_schema.json +52 -61
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/metadata_schema.json +268 -298
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/procedures_schema.json +3 -3
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/processing_schema.json +2 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/subject_schema.json +50 -4
- aind_data_schema-2.6.0/src/aind_data_schema/__init__.py +3 -0
- aind_data_schema-2.6.0/src/aind_data_schema/components/__init__.py +1 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/configs.py +47 -30
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/coordinates.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/devices.py +17 -13
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/stimulus.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/subjects.py +44 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/wrappers.py +1 -1
- aind_data_schema-2.6.0/src/aind_data_schema/core/__init__.py +1 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/acquisition.py +41 -7
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/data_description.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/instrument.py +3 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/metadata.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/procedures.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/processing.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/quality_control.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/subject.py +2 -2
- aind_data_schema-2.6.0/src/aind_data_schema/utils/__init__.py +1 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/json_writer.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/merge.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/validators.py +18 -9
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0/src/aind_data_schema.egg-info}/PKG-INFO +2 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema.egg-info/SOURCES.txt +3 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema.egg-info/requires.txt +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_acquisition.py +61 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_acquisition_configs.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_aind_generic.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_base.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_compatibility_check.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_composability_merge.py +2 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_coordinates.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_data_description.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_device.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_examples.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_imaging.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_instrument.py +5 -22
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_metadata.py +0 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_procedures.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_quality_control.py +2 -2
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_subject.py +1 -1
- aind_data_schema-2.6.0/tests/test_subjects.py +267 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_utils_merge.py +1 -1
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_utils_validators.py +31 -19
- aind_data_schema-2.5.0/docs/source/aind_data_schema_models/species.md +0 -35
- aind_data_schema-2.5.0/src/aind_data_schema/__init__.py +0 -4
- aind_data_schema-2.5.0/src/aind_data_schema/components/__init__.py +0 -1
- aind_data_schema-2.5.0/src/aind_data_schema/core/__init__.py +0 -1
- aind_data_schema-2.5.0/src/aind_data_schema/utils/__init__.py +0 -1
- aind_data_schema-2.5.0/tests/test_subjects.py +0 -67
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.flake8 +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/ISSUE_TEMPLATE/user-story.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/workflows/publish_dev.yml +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/workflows/run_dev_tests.yml +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/workflows/run_main_tests.yml +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/workflows/tag_and_publish_main.yml +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.github/workflows/update_docs.yml +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.gitignore +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/.readthedocs.yaml +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/CHANGELOG.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/CODE_OF_CONDUCT.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/CONTRIBUTING.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/LICENSE +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/README.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/Makefile +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/acquisition.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/data_description.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/instrument.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/metadata.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/model.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/processing.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/quality_control.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/base/core/subject.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/make.bat +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/bregma_and_lambda2.png +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/coordinates2.png +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/coordinates2_original.png +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/custom.css +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/dark-logo.svg +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/favicon.ico +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/light-logo.svg +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/session_image_1.png +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/session_image_2.png +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/_static/session_image_3.png +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/atlas.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/brain_atlas.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/coordinates.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/data_name_patterns.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/external.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/harp_types.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/licenses.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/modalities.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/pid_names.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/process_names.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/reagent.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/registries.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/specimen_procedure_types.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/stimulus_modality.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/system_architecture.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/aind_data_schema_models/units.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/connections.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/coordinates.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/injection_procedures.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/measurements.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/reagent.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/specimen_procedures.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/stimulus.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/subject_procedures.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components/surgery_procedures.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/components.rst +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/conf.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/coordinate_systems.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/data_description.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/example_workflow/example_workflow.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/example_workflow/example_workflow.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/example_workflow/example_workflow.xlsx +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/general.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/index.rst +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/metadata.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/model.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/processing.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/quality_control.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/registries.rst +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/related_standards.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/docs/source/subject.md +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/__init__.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/ephys_instrument.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/exaspim_quality_control.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/model.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/multiplane_ophys_instrument.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/processing.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/examples/quality_control.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/data_description_schema.json +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/model_schema.json +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/schemas/quality_control_schema.json +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/setup.cfg +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/setup.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/base.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/connections.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/identifiers.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/injection_procedures.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/measurements.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/reagent.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/specimen_procedures.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/subject_procedures.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/components/surgery_procedures.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/core/model.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/compatibility_check.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/docs/doc_generator.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/docs/model_generator.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/docs/registries_generator.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/docs/utils.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/examples_generator.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/exceptions.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema/utils/schema_version_bump.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema.egg-info/dependency_links.txt +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/src/aind_data_schema.egg-info/top_level.txt +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/__init__.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_bump_schema_versions.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_configs.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_identifiers.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_inst_acq_compatibility.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_json_writer.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_measurements.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_model.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_processing.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_stimulus.py +0 -0
- {aind_data_schema-2.5.0 → aind_data_schema-2.6.0}/tests/test_wrappers.py +0 -0
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: aind-data-schema
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.6.0
|
|
4
4
|
Summary: A library that defines AIND data schema and validates JSON files.
|
|
5
5
|
License: MIT
|
|
6
6
|
Classifier: Programming Language :: Python :: 3
|
|
7
7
|
Requires-Python: >=3.10
|
|
8
8
|
Description-Content-Type: text/markdown
|
|
9
9
|
License-File: LICENSE
|
|
10
|
-
Requires-Dist: aind-data-schema-models<6,>=5
|
|
10
|
+
Requires-Dist: aind-data-schema-models<6,>=5.4.1
|
|
11
11
|
Requires-Dist: pydantic<2.12,>=2.7
|
|
12
12
|
Requires-Dist: pydantic-extra-types
|
|
13
13
|
Provides-Extra: dev
|
|
@@ -8,7 +8,9 @@ The `procedures.json` file contains anything done to the subject or specimen pri
|
|
|
8
8
|
|
|
9
9
|
**Subject** procedures are performed on a live subject (e.g. injections, surgeries, implants, perfusions, etc.) whereas **specimen** procedures are performed on tissue extracted after perfusion (e.g. tissue processing, immunolabeling, sectioning, etc.).
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
### SpecimenProcedure.specimen_id
|
|
12
|
+
|
|
13
|
+
After perfusion or death we refer to specimens by the `specimen_id` field. When the tissue has not been sectioned in some way the `specimen_id` should be identical to the `subject_id`. Sectioned specimens should have a unique number appended as a suffix to the subject ID: `<subject_id>_<###>`.
|
|
12
14
|
|
|
13
15
|
## Examples
|
|
14
16
|
|
|
@@ -80,7 +80,7 @@ while the StimulusEpoch represents all stimuli being presented.
|
|
|
80
80
|
| `subject_id` | `str` | Subject ID (Unique identifier for the subject) |
|
|
81
81
|
| `specimen_id` | `Optional[str]` | Specimen ID (Specimen ID is required for in vitro imaging modalities) |
|
|
82
82
|
| `acquisition_start_time` | `datetime (timezone-aware)` | Acquisition start time (During validation, timezone information will be moved into the acquisition_start_tz field.) |
|
|
83
|
-
| `acquisition_start_tz` | `
|
|
83
|
+
| `acquisition_start_tz` | `int or pydantic_extra_types.timezone_name.TimeZoneName or NoneType` | Acquisition start timezone (Automatically populated by a validator based on acquisition_start_time. Will be a TimeZoneName (IANA name) when the datetime uses a ZoneInfo timezone, or an integer UTC offset in hours for fixed-offset timezones. Use ZoneInfo (from the zoneinfo standard library) to preserve the named timezone.) |
|
|
84
84
|
| `acquisition_end_time` | `datetime (timezone-aware)` | Acquisition end time |
|
|
85
85
|
| `experimenters` | `List[str]` | experimenter(s) |
|
|
86
86
|
| `protocol_id` | `Optional[List[str]]` | Protocol ID (DOI for protocols.io) |
|
|
@@ -127,7 +127,7 @@ same time.
|
|
|
127
127
|
| `code` | Optional[List[[Code](components/identifiers.md#code)]] | Acquisition code |
|
|
128
128
|
| `notes` | `Optional[str]` | Notes |
|
|
129
129
|
| `active_devices` | `List[str]` | Active devices (Device names must match devices in the Instrument) |
|
|
130
|
-
| `configurations` | List[[LightEmittingDiodeConfig](components/configs.md#lightemittingdiodeconfig) or [LaserConfig](components/configs.md#laserconfig) or [ManipulatorConfig](components/configs.md#manipulatorconfig) or [DetectorConfig](components/configs.md#detectorconfig) or [PatchCordConfig](components/configs.md#patchcordconfig) or [FiberAssemblyConfig](components/configs.md#fiberassemblyconfig) or [MISCameraConfig](components/configs.md#miscameraconfig) or [MRIScan](components/configs.md#mriscan) or [LickSpoutConfig](components/configs.md#lickspoutconfig) or [AirPuffConfig](components/configs.md#airpuffconfig) or [ImagingConfig](components/configs.md#imagingconfig) or [
|
|
130
|
+
| `configurations` | List[[LightEmittingDiodeConfig](components/configs.md#lightemittingdiodeconfig) or [LaserConfig](components/configs.md#laserconfig) or [ManipulatorConfig](components/configs.md#manipulatorconfig) or [DetectorConfig](components/configs.md#detectorconfig) or [PatchCordConfig](components/configs.md#patchcordconfig) or [FiberAssemblyConfig](components/configs.md#fiberassemblyconfig) or [MISCameraConfig](components/configs.md#miscameraconfig) or [MRIScan](components/configs.md#mriscan) or [LickSpoutConfig](components/configs.md#lickspoutconfig) or [AirPuffConfig](components/configs.md#airpuffconfig) or [ImagingConfig](components/configs.md#imagingconfig) or [SampleChamberConfig](components/configs.md#samplechamberconfig) or [ProbeConfig](components/configs.md#probeconfig) or [EphysAssemblyConfig](components/configs.md#ephysassemblyconfig) or [CatheterConfig](components/configs.md#catheterconfig)] | Device configurations (Configurations are parameters controlling active devices during this stream) |
|
|
131
131
|
| `connections` | List[[Connection](components/connections.md#connection)] | Connections (Connections are links between devices that are specific to this acquisition (i.e. not already defined in the Instrument)) |
|
|
132
132
|
|
|
133
133
|
|
|
@@ -9,97 +9,98 @@ Organization
|
|
|
9
9
|
| Name | abbreviation | name | registry | registry_identifier |
|
|
10
10
|
|------|------|------|------|------|
|
|
11
11
|
| `AA_OPTO_ELECTRONIC` | `None` | `AA Opto Electronic` | `None` | `None` |
|
|
12
|
-
| `ABCAM` | `None` | `Abcam` | `Registry
|
|
13
|
-
| `ADDGENE` | `None` | `Addgene` | `Registry
|
|
14
|
-
| `AI` | `AI` | `Allen Institute` | `Registry
|
|
15
|
-
| `AIBS` | `AIBS` | `Allen Institute for Brain Science` | `Registry
|
|
12
|
+
| `ABCAM` | `None` | `Abcam` | `Research Organization Registry (ROR)` | `02e1wjw63` |
|
|
13
|
+
| `ADDGENE` | `None` | `Addgene` | `Research Organization Registry (ROR)` | `01nn1pw54` |
|
|
14
|
+
| `AI` | `AI` | `Allen Institute` | `Research Organization Registry (ROR)` | `03cpe7c52` |
|
|
15
|
+
| `AIBS` | `AIBS` | `Allen Institute for Brain Science` | `Research Organization Registry (ROR)` | `00dcv1019` |
|
|
16
16
|
| `AILIPU` | `Ailipu` | `Ailipu Technology Co` | `None` | `None` |
|
|
17
|
-
| `AIND` | `AIND` | `Allen Institute for Neural Dynamics` | `Registry
|
|
18
|
-
| `AMS_OSRAM` | `None` | `ams OSRAM` | `Registry
|
|
17
|
+
| `AIND` | `AIND` | `Allen Institute for Neural Dynamics` | `Research Organization Registry (ROR)` | `04szwah67` |
|
|
18
|
+
| `AMS_OSRAM` | `None` | `ams OSRAM` | `Research Organization Registry (ROR)` | `045d0h266` |
|
|
19
19
|
| `ARDUINO` | `None` | `Arduino` | `None` | `None` |
|
|
20
20
|
| `ARECONT_VISION_COSTAR` | `None` | `Arecont Vision Costar` | `None` | `None` |
|
|
21
21
|
| `ASI` | `ASI` | `Applied Scientific Instrumentation` | `None` | `None` |
|
|
22
|
-
| `ASUS` | `None` | `ASUS` | `Registry
|
|
22
|
+
| `ASUS` | `None` | `ASUS` | `Research Organization Registry (ROR)` | `00bxkz165` |
|
|
23
23
|
| `BASLER` | `None` | `Basler` | `None` | `None` |
|
|
24
|
-
| `BCM` | `BCM` | `Baylor College of Medicine` | `Registry
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
24
|
+
| `BCM` | `BCM` | `Baylor College of Medicine` | `Research Organization Registry (ROR)` | `02pttbw34` |
|
|
25
|
+
| `BRUKER` | `None` | `Bruker` | `Research Organization Registry (ROR)` | `04r739x86` |
|
|
26
|
+
| `BU` | `BU` | `Boston University` | `Research Organization Registry (ROR)` | `05qwgg493` |
|
|
27
|
+
| `CAJAL` | `Cajal` | `Cajal Neuroscience` | `Research Organization Registry (ROR)` | `05pdc0q70` |
|
|
27
28
|
| `CAMBRIDGE_TECHNOLOGY` | `None` | `Cambridge Technology` | `None` | `None` |
|
|
28
|
-
| `CARL_ZEISS` | `None` | `Carl Zeiss` | `Registry
|
|
29
|
+
| `CARL_ZEISS` | `None` | `Carl Zeiss` | `Research Organization Registry (ROR)` | `01xk5xs43` |
|
|
29
30
|
| `CATHETER_IMPLANT_INSTITUTIONS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
30
|
-
| `CHAMPALIMAUD` | `Champalimaud` | `Champalimaud Foundation` | `Registry
|
|
31
|
+
| `CHAMPALIMAUD` | `Champalimaud` | `Champalimaud Foundation` | `Research Organization Registry (ROR)` | `03g001n57` |
|
|
31
32
|
| `CHROMA` | `None` | `Chroma` | `None` | `None` |
|
|
32
|
-
| `COHERENT_SCIENTIFIC` | `None` | `Coherent Scientific` | `Registry
|
|
33
|
-
| `COLUMBIA` | `Columbia` | `Columbia University` | `Registry
|
|
33
|
+
| `COHERENT_SCIENTIFIC` | `None` | `Coherent Scientific` | `Research Organization Registry (ROR)` | `031tysd23` |
|
|
34
|
+
| `COLUMBIA` | `Columbia` | `Columbia University` | `Research Organization Registry (ROR)` | `00hj8s172` |
|
|
34
35
|
| `COMPUTAR` | `None` | `Computar` | `None` | `None` |
|
|
35
36
|
| `CONOPTICS` | `None` | `Conoptics` | `None` | `None` |
|
|
36
37
|
| `CRESTOPTICS` | `None` | `CrestOptics` | `None` | `None` |
|
|
37
|
-
| `CRL` | `CRL` | `Charles River Laboratories` | `Registry
|
|
38
|
+
| `CRL` | `CRL` | `Charles River Laboratories` | `Research Organization Registry (ROR)` | `03ndmsg87` |
|
|
38
39
|
| `CUSTOM` | `None` | `Custom` | `None` | `None` |
|
|
39
|
-
| `CZI` | `CZI` | `Chan Zuckerberg Initiative` | `Registry
|
|
40
|
+
| `CZI` | `CZI` | `Chan Zuckerberg Initiative` | `Research Organization Registry (ROR)` | `02qenvm24` |
|
|
40
41
|
| `DAQ_DEVICE_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
41
42
|
| `DETECTOR_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
42
43
|
| `DIGIKEY` | `None` | `DigiKey` | `None` | `None` |
|
|
43
44
|
| `DODOTRONIC` | `None` | `Dodotronic` | `None` | `None` |
|
|
44
|
-
| `DORIC` | `None` | `Doric` | `Registry
|
|
45
|
+
| `DORIC` | `None` | `Doric` | `Research Organization Registry (ROR)` | `059n53q30` |
|
|
45
46
|
| `EALING` | `None` | `Ealing` | `None` | `None` |
|
|
46
|
-
| `EDMUND_OPTICS` | `None` | `Edmund Optics` | `Registry
|
|
47
|
-
| `EMORY` | `Emory` | `Emory University` | `Registry
|
|
47
|
+
| `EDMUND_OPTICS` | `None` | `Edmund Optics` | `Research Organization Registry (ROR)` | `01j1gwp17` |
|
|
48
|
+
| `EMORY` | `Emory` | `Emory University` | `Research Organization Registry (ROR)` | `03czfpz43` |
|
|
48
49
|
| `EURESYS` | `None` | `Euresys` | `None` | `None` |
|
|
49
50
|
| `FILTER_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
50
|
-
| `FLIR` | `FLIR` | `Teledyne FLIR` | `Registry
|
|
51
|
+
| `FLIR` | `FLIR` | `Teledyne FLIR` | `Research Organization Registry (ROR)` | `01j1gwp17` |
|
|
51
52
|
| `FUJINON` | `None` | `Fujinon` | `None` | `None` |
|
|
52
53
|
| `FUNDERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
53
|
-
| `HAMAMATSU` | `None` | `Hamamatsu` | `Registry
|
|
54
|
+
| `HAMAMATSU` | `None` | `Hamamatsu` | `Research Organization Registry (ROR)` | `03natb733` |
|
|
54
55
|
| `HAMILTON` | `None` | `Hamilton` | `None` | `None` |
|
|
55
|
-
| `HUST` | `HUST` | `Huazhong University of Science and Technology` | `Registry
|
|
56
|
-
| `IDT` | `IDT` | `Integrated DNA Technologies` | `Registry
|
|
57
|
-
| `IMEC` | `IMEC` | `Interuniversity Microelectronics Center` | `Registry
|
|
56
|
+
| `HUST` | `HUST` | `Huazhong University of Science and Technology` | `Research Organization Registry (ROR)` | `00p991c53` |
|
|
57
|
+
| `IDT` | `IDT` | `Integrated DNA Technologies` | `Research Organization Registry (ROR)` | `009jvpf03` |
|
|
58
|
+
| `IMEC` | `IMEC` | `Interuniversity Microelectronics Center` | `Research Organization Registry (ROR)` | `02kcbn207` |
|
|
58
59
|
| `INFINITY_PHOTO_OPTICAL` | `None` | `Infinity Photo-Optical` | `None` | `None` |
|
|
59
|
-
| `INVITROGEN` | `None` | `Invitrogen` | `Registry
|
|
60
|
+
| `INVITROGEN` | `None` | `Invitrogen` | `Research Organization Registry (ROR)` | `03x1ewr52` |
|
|
60
61
|
| `IR_ROBOT_CO` | `None` | `IR Robot Co` | `None` | `None` |
|
|
61
62
|
| `ISL` | `ISL` | `ISL Products International` | `None` | `None` |
|
|
62
63
|
| `ITEM` | `None` | `Item` | `None` | `None` |
|
|
63
|
-
| `JANELIA` | `Janelia` | `Janelia Research Campus` | `Registry
|
|
64
|
-
| `JAX` | `JAX` | `Jackson Laboratory` | `Registry
|
|
65
|
-
| `JENOPTIK` | `None` | `Jenoptik` | `Registry
|
|
66
|
-
| `JHU` | `JHU` | `Johns Hopkins University` | `Registry
|
|
64
|
+
| `JANELIA` | `Janelia` | `Janelia Research Campus` | `Research Organization Registry (ROR)` | `013sk6x84` |
|
|
65
|
+
| `JAX` | `JAX` | `Jackson Laboratory` | `Research Organization Registry (ROR)` | `021sy4w91` |
|
|
66
|
+
| `JENOPTIK` | `None` | `Jenoptik` | `Research Organization Registry (ROR)` | `05g7t5c49` |
|
|
67
|
+
| `JHU` | `JHU` | `Johns Hopkins University` | `Research Organization Registry (ROR)` | `00za53h95` |
|
|
67
68
|
| `JULABO` | `None` | `Julabo` | `None` | `None` |
|
|
68
|
-
| `KOWA` | `None` | `Kowa` | `Registry
|
|
69
|
+
| `KOWA` | `None` | `Kowa` | `Research Organization Registry (ROR)` | `03zbwg482` |
|
|
69
70
|
| `LASER_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
70
71
|
| `LASOS` | `LASOS` | `LASOS Lasertechnik` | `None` | `None` |
|
|
71
72
|
| `LED_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
72
73
|
| `LEICA` | `None` | `Leica` | `None` | `None` |
|
|
73
74
|
| `LENS_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
74
|
-
| `LG` | `None` | `LG` | `Registry
|
|
75
|
+
| `LG` | `None` | `LG` | `Research Organization Registry (ROR)` | `02b948n83` |
|
|
75
76
|
| `LIFECANVAS` | `None` | `LifeCanvas` | `None` | `None` |
|
|
76
77
|
| `LUMENCOR` | `None` | `Lumencor` | `None` | `None` |
|
|
77
78
|
| `LUMEN_DYNAMICS` | `None` | `Lumen Dynamics` | `None` | `None` |
|
|
78
79
|
| `MANIPULATOR_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
79
|
-
| `MBF` | `MBF` | `MBF Bioscience` | `Registry
|
|
80
|
-
| `MEADOWLARK_OPTICS` | `None` | `Meadowlark Optics` | `Registry
|
|
81
|
-
| `MIBR` | `MIBR` | `McGovern Institute for Brain Research` | `Registry
|
|
80
|
+
| `MBF` | `MBF` | `MBF Bioscience` | `Research Organization Registry (ROR)` | `02zynam48` |
|
|
81
|
+
| `MEADOWLARK_OPTICS` | `None` | `Meadowlark Optics` | `Research Organization Registry (ROR)` | `00n8qbq54` |
|
|
82
|
+
| `MIBR` | `MIBR` | `McGovern Institute for Brain Research` | `Research Organization Registry (ROR)` | `05ymca674` |
|
|
82
83
|
| `MIDOPT` | `MidOpt` | `Midwest Optical Systems, Inc.` | `None` | `None` |
|
|
83
|
-
| `MIT` | `MIT` | `Massachusetts Institute of Technology` | `Registry
|
|
84
|
+
| `MIT` | `MIT` | `Massachusetts Institute of Technology` | `Research Organization Registry (ROR)` | `042nb2s44` |
|
|
84
85
|
| `MITUTUYO` | `None` | `Mitutuyo` | `None` | `None` |
|
|
85
86
|
| `MIT_BCS` | `MIT-BCS` | `MIT Department of Brain and Cognitive Sciences` | `None` | `None` |
|
|
86
|
-
| `MJFF` | `MJFF` | `Michael J. Fox Foundation for Parkinson's Research` | `Registry
|
|
87
|
-
| `MKS_NEWPORT` | `None` | `MKS Newport` | `Registry
|
|
87
|
+
| `MJFF` | `MJFF` | `Michael J. Fox Foundation for Parkinson's Research` | `Research Organization Registry (ROR)` | `03arq3225` |
|
|
88
|
+
| `MKS_NEWPORT` | `None` | `MKS Newport` | `Research Organization Registry (ROR)` | `00k17f049` |
|
|
88
89
|
| `MONITOR_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
89
90
|
| `MPI` | `MPI` | `MPI` | `None` | `None` |
|
|
90
|
-
| `NATIONAL_INSTRUMENTS` | `None` | `National Instruments` | `Registry
|
|
91
|
+
| `NATIONAL_INSTRUMENTS` | `None` | `National Instruments` | `Research Organization Registry (ROR)` | `026exqw73` |
|
|
91
92
|
| `NAVITAR` | `None` | `Navitar` | `None` | `None` |
|
|
92
|
-
| `NCCIH` | `NCCIH` | `National Center for Complementary and Integrative Health` | `Registry
|
|
93
|
+
| `NCCIH` | `NCCIH` | `National Center for Complementary and Integrative Health` | `Research Organization Registry (ROR)` | `00190t495` |
|
|
93
94
|
| `NEURALYNX` | `None` | `NeuraLynx` | `None` | `None` |
|
|
94
95
|
| `NEUROPHOTOMETRICS` | `None` | `Neurophotometrics` | `None` | `None` |
|
|
95
96
|
| `NEW_SCALE_TECHNOLOGIES` | `None` | `New Scale Technologies` | `None` | `None` |
|
|
96
|
-
| `NIKON` | `None` | `Nikon` | `Registry
|
|
97
|
-
| `NIMH` | `NIMH` | `National Institute of Mental Health` | `Registry
|
|
98
|
-
| `NINDS` | `NINDS` | `National Institute of Neurological Disorders and Stroke` | `Registry
|
|
97
|
+
| `NIKON` | `None` | `Nikon` | `Research Organization Registry (ROR)` | `0280y9h11` |
|
|
98
|
+
| `NIMH` | `NIMH` | `National Institute of Mental Health` | `Research Organization Registry (ROR)` | `04xeg9z08` |
|
|
99
|
+
| `NINDS` | `NINDS` | `National Institute of Neurological Disorders and Stroke` | `Research Organization Registry (ROR)` | `01s5ya894` |
|
|
99
100
|
| `NRESEARCH_INC` | `None` | `NResearch Inc` | `None` | `None` |
|
|
100
|
-
| `NYU` | `NYU` | `New York University` | `Registry
|
|
101
|
-
| `OEPS` | `OEPS` | `Open Ephys Production Site` | `Registry
|
|
102
|
-
| `OLYMPUS` | `None` | `Olympus` | `Registry
|
|
101
|
+
| `NYU` | `NYU` | `New York University` | `Research Organization Registry (ROR)` | `0190ak572` |
|
|
102
|
+
| `OEPS` | `OEPS` | `Open Ephys Production Site` | `Research Organization Registry (ROR)` | `007rkz355` |
|
|
103
|
+
| `OLYMPUS` | `None` | `Olympus` | `Research Organization Registry (ROR)` | `02vcdte90` |
|
|
103
104
|
| `OPTOTUNE` | `None` | `Optotune` | `None` | `None` |
|
|
104
105
|
| `OTHER` | `None` | `Other` | `None` | `None` |
|
|
105
106
|
| `OXXIUS` | `None` | `Oxxius` | `None` | `None` |
|
|
@@ -114,25 +115,25 @@ Organization
|
|
|
114
115
|
| `SEMROCK` | `None` | `Semrock` | `None` | `None` |
|
|
115
116
|
| `SICGEN` | `None` | `SICGEN` | `None` | `None` |
|
|
116
117
|
| `SIGMA_ALDRICH` | `None` | `Sigma-Aldrich` | `None` | `None` |
|
|
117
|
-
| `SIMONS_FOUNDATION` | `None` | `Simons Foundation` | `Registry
|
|
118
|
+
| `SIMONS_FOUNDATION` | `None` | `Simons Foundation` | `Research Organization Registry (ROR)` | `01cmst727` |
|
|
118
119
|
| `SPEAKER_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
119
|
-
| `SPECTRA_PHYSICS` | `None` | `Spectra-Physics` | `Registry
|
|
120
|
+
| `SPECTRA_PHYSICS` | `None` | `Spectra-Physics` | `Research Organization Registry (ROR)` | `02ad9kp97` |
|
|
120
121
|
| `SPINNAKER` | `None` | `Spinnaker` | `None` | `None` |
|
|
121
122
|
| `SUBJECT_SOURCES` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
122
123
|
| `TAMRON` | `None` | `Tamron` | `None` | `None` |
|
|
123
124
|
| `TELEDYNE_VISION_SOLUTIONS` | `None` | `Teledyne Vision Solutions` | `None` | `None` |
|
|
124
|
-
| `TE_CONNECTIVITY` | `None` | `TE Connectivity` | `Registry
|
|
125
|
-
| `THERMO_FISHER_SCIENTIFIC` | `None` | `Thermo Fisher Scientific` | `Registry
|
|
125
|
+
| `TE_CONNECTIVITY` | `None` | `TE Connectivity` | `Research Organization Registry (ROR)` | `034frgp20` |
|
|
126
|
+
| `THERMO_FISHER_SCIENTIFIC` | `None` | `Thermo Fisher Scientific` | `Research Organization Registry (ROR)` | `03x1ewr52` |
|
|
126
127
|
| `THE_IMAGING_SOURCE` | `None` | `The Imaging Source` | `None` | `None` |
|
|
127
128
|
| `THE_LEE_COMPANY` | `None` | `The Lee Company` | `None` | `None` |
|
|
128
|
-
| `THORLABS` | `None` | `Thorlabs` | `Registry
|
|
129
|
+
| `THORLABS` | `None` | `Thorlabs` | `Research Organization Registry (ROR)` | `04gsnvb07` |
|
|
129
130
|
| `TMC` | `TMC` | `Technical Manufacturing Corporation` | `None` | `None` |
|
|
130
131
|
| `TRANSDUCER_TECHNIQUES` | `None` | `Transducer Techniques` | `None` | `None` |
|
|
131
|
-
| `TWCF` | `TWCF` | `Templeton World Charity Foundation` | `Registry
|
|
132
|
+
| `TWCF` | `TWCF` | `Templeton World Charity Foundation` | `Research Organization Registry (ROR)` | `00x0z1472` |
|
|
132
133
|
| `TYMPHANY` | `None` | `Tymphany` | `None` | `None` |
|
|
133
|
-
| `UCSD` | `UCSD` | `University of California, San Diego` | `Registry
|
|
134
|
+
| `UCSD` | `UCSD` | `University of California, San Diego` | `Research Organization Registry (ROR)` | `0168r3w48` |
|
|
134
135
|
| `UNKNOWN` | `UNKNOWN` | `Unknown` | `None` | `None` |
|
|
135
|
-
| `UPENN` | `UPENN` | `University of Pennsylvania` | `Registry
|
|
136
|
+
| `UPENN` | `UPENN` | `University of Pennsylvania` | `Research Organization Registry (ROR)` | `00b30xv10` |
|
|
136
137
|
| `VIEWORKS` | `None` | `Vieworks` | `None` | `None` |
|
|
137
138
|
| `VORTRAN` | `None` | `Vortran` | `None` | `None` |
|
|
138
139
|
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Species
|
|
2
|
+
|
|
3
|
+
## Model definitions
|
|
4
|
+
|
|
5
|
+
### Species
|
|
6
|
+
|
|
7
|
+
Species
|
|
8
|
+
|
|
9
|
+
| Name | name | common_name | registry | registry_identifier |
|
|
10
|
+
|------|------|------|------|------|
|
|
11
|
+
| `ALPACA` | `Vicuna pacos` | `Alpaca` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid30538` |
|
|
12
|
+
| `CHICKEN` | `Gallus gallus` | `Chicken` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9031` |
|
|
13
|
+
| `COMMON_MARMOSET` | `Callithrix jacchus` | `Common marmoset` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9483` |
|
|
14
|
+
| `DONKEY` | `Equus asinus` | `Donkey` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9793` |
|
|
15
|
+
| `EUROPEAN_RABBIT` | `Oryctolagus cuniculus` | `European rabbit` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9986` |
|
|
16
|
+
| `GOAT` | `Carpa hircus` | `Goat` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9925` |
|
|
17
|
+
| `GUINEA_PIG` | `Cavia porcellus` | `Guinea pig` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid10141` |
|
|
18
|
+
| `HOUSE_MOUSE` | `Mus musculus` | `House mouse` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid10090` |
|
|
19
|
+
| `HUMAN` | `Homo sapiens` | `Human` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9606` |
|
|
20
|
+
| `LLAMA` | `Lama glama` | `Llama` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9844` |
|
|
21
|
+
| `NORWAY_RAT` | `Rattus norvegicus` | `Norway rat` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid10116` |
|
|
22
|
+
| `RHESUS_MACAQUE` | `Macaca mulatta` | `Rhesus macaque` | `National Center for Biotechnology Information (NCBI)` | `NCBI:txid9544` |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Strain
|
|
26
|
+
|
|
27
|
+
Strain
|
|
28
|
+
|
|
29
|
+
| Name | name | species | registry | registry_identifier |
|
|
30
|
+
|------|------|------|------|------|
|
|
31
|
+
| `BALB_C` | `BALB/c` | `Mus musculus` | `Mouse Genome Informatics (MGI)` | `MGI:2159737` |
|
|
32
|
+
| `C57BL_6J` | `C57BL/6J` | `Mus musculus` | `Mouse Genome Informatics (MGI)` | `MGI:3028467` |
|
|
33
|
+
| `UNKNOWN` | `Unknown` | `Mus musculus` | `None` | `None` |
|
|
34
|
+
|
|
35
|
+
|
|
@@ -68,10 +68,15 @@ Configuration of detector settings
|
|
|
68
68
|
|
|
69
69
|
| Field | Type | Title (Description) |
|
|
70
70
|
|-------|------|-------------|
|
|
71
|
-
| `exposure_time` | `float` | Exposure time |
|
|
71
|
+
| `exposure_time` | `Optional[float]` | Exposure time |
|
|
72
72
|
| `exposure_time_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | Exposure time unit |
|
|
73
73
|
| `trigger_type` | [TriggerType](#triggertype) | Trigger type |
|
|
74
74
|
| `compression` | Optional[[Code](identifiers.md#code)] | Compression (Compression algorithm used during acquisition) |
|
|
75
|
+
| `crop_offset_x` | `Optional[int]` | Crop offset x (Overrides any value set in the Instrument metadata) |
|
|
76
|
+
| `crop_offset_y` | `Optional[int]` | Crop offset y (Overrides any value set in the Instrument metadata) |
|
|
77
|
+
| `crop_width` | `Optional[int]` | Crop width (Overrides any value set in the Instrument metadata) |
|
|
78
|
+
| `crop_height` | `Optional[int]` | Crop height (Overrides any value set in the Instrument metadata) |
|
|
79
|
+
| `crop_unit` | Optional[[SizeUnit](../aind_data_schema_models/units.md#sizeunit)] | Crop size unit |
|
|
75
80
|
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
|
76
81
|
|
|
77
82
|
|
|
@@ -143,7 +148,7 @@ Configuration of an imaging instrument
|
|
|
143
148
|
|
|
144
149
|
| Field | Type | Title (Description) |
|
|
145
150
|
|-------|------|-------------|
|
|
146
|
-
| `channels` | List[[Channel
|
|
151
|
+
| `channels` | `List[typing.Annotated[aind_data_schema.components.configs.Channel, FieldInfo(annotation=NoneType, required=True, discriminator='object_type')]]` | |
|
|
147
152
|
| `coordinate_system` | Optional[[CoordinateSystem](coordinates.md#coordinatesystem)] | Coordinate system (Required for ImageSPIM objects and when the imaging coordinate system differs from the Acquisition.coordinate_system) |
|
|
148
153
|
| `images` | List[[PlanarImage](#planarimage) or [PlanarImageStack](#planarimagestack) or [ImageSPIM](#imagespim)] | Images |
|
|
149
154
|
| `sampling_strategy` | Optional[[SamplingStrategy](#samplingstrategy)] | Sampling strategy |
|
|
@@ -312,6 +317,18 @@ Configuration for mouse platforms
|
|
|
312
317
|
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
|
313
318
|
|
|
314
319
|
|
|
320
|
+
### NeuronStructure
|
|
321
|
+
|
|
322
|
+
Neuronal structures captured in imaging planes
|
|
323
|
+
|
|
324
|
+
| Name | Value |
|
|
325
|
+
|------|-------|
|
|
326
|
+
| `SOMA` | `Soma` |
|
|
327
|
+
| `DENDRITE` | `Dendrite` |
|
|
328
|
+
| `AXON` | `Axon` |
|
|
329
|
+
| `OTHER` | `Other` |
|
|
330
|
+
|
|
331
|
+
|
|
315
332
|
### OlfactometerChannelInfo
|
|
316
333
|
|
|
317
334
|
Configuration of a channel in an olfactometer
|
|
@@ -350,7 +367,7 @@ Description of an N-D image acquired in a specific imaging plane
|
|
|
350
367
|
|
|
351
368
|
| Field | Type | Title (Description) |
|
|
352
369
|
|-------|------|-------------|
|
|
353
|
-
| `planes` | List[[Plane](#plane) or [CoupledPlane](#coupledplane) or [
|
|
370
|
+
| `planes` | List[[Plane](#plane) or [CoupledPlane](#coupledplane) or [Slap2Plane](#slap2plane)] | Imaging planes |
|
|
354
371
|
| `channel_name` | `str` | Channel name |
|
|
355
372
|
| `dimensions_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Dimensions unit |
|
|
356
373
|
| `image_to_acquisition_transform` | List[[Translation](coordinates.md#translation) or [Rotation](coordinates.md#rotation) or [Scale](coordinates.md#scale) or [Affine](coordinates.md#affine)] | Image to acquisition transform (Position, rotation, and scale of the image. Note that depth should be in the planes.) |
|
|
@@ -368,7 +385,7 @@ Description of a stack of images acquired in a specific imaging plane
|
|
|
368
385
|
| `depth_end` | `float` | Ending depth |
|
|
369
386
|
| `depth_step` | `float` | Step size |
|
|
370
387
|
| `depth_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Depth unit |
|
|
371
|
-
| `planes` | List[[Plane](#plane) or [CoupledPlane](#coupledplane) or [
|
|
388
|
+
| `planes` | List[[Plane](#plane) or [CoupledPlane](#coupledplane) or [Slap2Plane](#slap2plane)] | Imaging planes |
|
|
372
389
|
| `channel_name` | `str` | Channel name |
|
|
373
390
|
| `dimensions_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Dimensions unit |
|
|
374
391
|
| `image_to_acquisition_transform` | List[[Translation](coordinates.md#translation) or [Rotation](coordinates.md#rotation) or [Scale](coordinates.md#scale) or [Affine](coordinates.md#affine)] | Image to acquisition transform (Position, rotation, and scale of the image. Note that depth should be in the planes.) |
|
|
@@ -449,50 +466,21 @@ Description of an image sampling strategy
|
|
|
449
466
|
| `frame_rate_unit` | [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) | Frame rate unit |
|
|
450
467
|
|
|
451
468
|
|
|
452
|
-
###
|
|
453
|
-
|
|
454
|
-
Type of slap acquisition
|
|
455
|
-
|
|
456
|
-
| Name | Value |
|
|
457
|
-
|------|-------|
|
|
458
|
-
| `PARENT` | `Parent` |
|
|
459
|
-
| `BRANCH` | `Branch` |
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
### SlapChannel
|
|
463
|
-
|
|
464
|
-
Configuration of a channel for Slap
|
|
465
|
-
|
|
466
|
-
| Field | Type | Title (Description) |
|
|
467
|
-
|-------|------|-------------|
|
|
468
|
-
| `dilation` | `int` | Dilation |
|
|
469
|
-
| `dilation_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Dilation unit |
|
|
470
|
-
| `description` | `Optional[str]` | Description |
|
|
471
|
-
| `channel_name` | `str` | Channel |
|
|
472
|
-
| `intended_measurement` | `Optional[str]` | Intended measurement (What signal is this channel measuring) |
|
|
473
|
-
| `detector` | [DetectorConfig](#detectorconfig) | Detector configuration |
|
|
474
|
-
| `additional_device_names` | Optional[List[[DeviceConfig](#deviceconfig)]] | Additional device names (Mirrors, dichroics, etc) |
|
|
475
|
-
| `light_sources` | List[[LaserConfig](#laserconfig) or [LightEmittingDiodeConfig](#lightemittingdiodeconfig)] | Light source configurations |
|
|
476
|
-
| `variable_power` | `Optional[bool]` | Variable power (Set to true when the power varies across Planes -- put the power in the Plane.power field) |
|
|
477
|
-
| `excitation_filters` | Optional[List[[DeviceConfig](#deviceconfig)]] | Excitation filters |
|
|
478
|
-
| `emission_filters` | Optional[List[[DeviceConfig](#deviceconfig)]] | Emission filters |
|
|
479
|
-
| `emission_wavelength` | `Optional[int]` | Emission wavelength |
|
|
480
|
-
| `emission_wavelength_unit` | Optional[[SizeUnit](../aind_data_schema_models/units.md#sizeunit)] | Emission wavelength unit |
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
### SlapPlane
|
|
469
|
+
### Slap2Plane
|
|
484
470
|
|
|
485
|
-
Configuration of
|
|
471
|
+
Configuration of a SLAP2 imaging plane (all imaging ROIs of a specific acquisition type at a particular depth)
|
|
486
472
|
|
|
487
473
|
| Field | Type | Title (Description) |
|
|
488
474
|
|-------|------|-------------|
|
|
489
|
-
| `
|
|
490
|
-
| `
|
|
491
|
-
| `
|
|
492
|
-
| `
|
|
493
|
-
| `
|
|
494
|
-
| `
|
|
495
|
-
| `
|
|
475
|
+
| `slap2_acquisition_type` | {Slap2AcquisitionType} | SLAP2 ROI acquisition type |
|
|
476
|
+
| `specimen_id` | `Optional[str]` | Specimen ID (Unique index identifying the cell being imaged: <subject_id>_###) |
|
|
477
|
+
| `fov_index` | `Optional[int]` | Field of view index (For FOVs that are imaged multiple times, assign a shared index to each instance of the FOV) |
|
|
478
|
+
| `structure_types` | Optional[List[[NeuronStructure](#neuronstructure)]] | Structure type |
|
|
479
|
+
| `target_name` | `Optional[str]` | Name of imaged target |
|
|
480
|
+
| `y_dilations` | `List[int]` | Unique Y dilations |
|
|
481
|
+
| `y_dilations_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Dilation unit |
|
|
482
|
+
| `frame_rates` | `List[float]` | Unique frame rates |
|
|
483
|
+
| `frame_rates_unit` | [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) | Frame rate unit |
|
|
496
484
|
| `depth` | `float` | Depth |
|
|
497
485
|
| `depth_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Depth unit |
|
|
498
486
|
| `power` | `float` | Power |
|
|
@@ -541,6 +529,7 @@ Types of detector triggers
|
|
|
541
529
|
|------|-------|
|
|
542
530
|
| `INTERNAL` | `Internal` |
|
|
543
531
|
| `EXTERNAL` | `External` |
|
|
532
|
+
| `ANALOG` | `Analog` |
|
|
544
533
|
|
|
545
534
|
|
|
546
535
|
### Valence
|
|
@@ -275,19 +275,15 @@ Description of a Digital Micromirror Device (DMD)
|
|
|
275
275
|
| Field | Type | Title (Description) |
|
|
276
276
|
|-------|------|-------------|
|
|
277
277
|
| `max_dmd_patterns` | `int` | Max DMD patterns |
|
|
278
|
-
| `double_bounce_design` | `bool` | Double bounce design |
|
|
279
278
|
| `invert_pixel_values` | `bool` | Invert pixel values |
|
|
280
279
|
| `motion_padding_x` | `int` | Motion padding X (pixels) |
|
|
281
280
|
| `motion_padding_y` | `int` | Motion padding Y (pixels) |
|
|
282
281
|
| `padding_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Padding unit |
|
|
283
|
-
| `pixel_size` | `
|
|
284
|
-
| `
|
|
285
|
-
| `
|
|
286
|
-
| `
|
|
287
|
-
| `
|
|
288
|
-
| `dmd_curtain_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | dmd_curtain_unit |
|
|
289
|
-
| `line_shear` | `List[int]` | Line shear (pixels) |
|
|
290
|
-
| `line_shear_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Line shear unit |
|
|
282
|
+
| `pixel_size` | `float` | DMD Pixel size (fraction of line scan period) |
|
|
283
|
+
| `start_phase` | `float` | DMD Start phase (fraction of line scan period) |
|
|
284
|
+
| `dmd_curtain` | `List[float]` | DMD Curtain (fraction of DMD scan period) |
|
|
285
|
+
| `line_shear_anchors` | `List[float]` | Line shear anchors at top and bottom of field of view (pixels) |
|
|
286
|
+
| `line_shear_anchors_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Line shear anchors unit |
|
|
291
287
|
| `name` | `str` | Device name |
|
|
292
288
|
| `serial_number` | `Optional[str]` | Serial number |
|
|
293
289
|
| `manufacturer` | Optional[[Organization](../aind_data_schema_models/organizations.md#organization)] | Manufacturer |
|
|
@@ -340,7 +336,7 @@ Description of an enclosure
|
|
|
340
336
|
|
|
341
337
|
### EphysAssembly
|
|
342
338
|
|
|
343
|
-
Named assembly for combining a manipulator and ephys probes
|
|
339
|
+
Named assembly for combining a manipulator and extracellular ephys probes
|
|
344
340
|
|
|
345
341
|
| Field | Type | Title (Description) |
|
|
346
342
|
|-------|------|-------------|
|
|
@@ -351,7 +347,7 @@ Named assembly for combining a manipulator and ephys probes
|
|
|
351
347
|
|
|
352
348
|
### EphysProbe
|
|
353
349
|
|
|
354
|
-
Probe used in an ephys experiment
|
|
350
|
+
Probe used in an extracellular ephys experiment
|
|
355
351
|
|
|
356
352
|
| Field | Type | Title (Description) |
|
|
357
353
|
|-------|------|-------------|
|
|
@@ -760,7 +756,7 @@ description of a Olfactometer channel
|
|
|
760
756
|
|-------|------|-------------|
|
|
761
757
|
| `channel_index` | `int` | Channel index |
|
|
762
758
|
| `channel_type` | [OlfactometerChannelType](#olfactometerchanneltype) | Channel type |
|
|
763
|
-
| `flow_capacity` | `
|
|
759
|
+
| `flow_capacity` | `int` | Flow capacity |
|
|
764
760
|
| `flow_unit` | `str` | Flow unit |
|
|
765
761
|
|
|
766
762
|
|
|
@@ -781,7 +777,7 @@ Multichannel electrophysiology DAQ
|
|
|
781
777
|
| Field | Type | Title (Description) |
|
|
782
778
|
|-------|------|-------------|
|
|
783
779
|
| `ports` | List[[ProbePort](#probeport)] | Acquisition board ports |
|
|
784
|
-
| `data_interface` | `"
|
|
780
|
+
| `data_interface` | `"USB"` | |
|
|
785
781
|
| `manufacturer` | [Organization](../aind_data_schema_models/organizations.md#organization) | |
|
|
786
782
|
| `channels` | List[[DAQChannel](#daqchannel)] | DAQ channels |
|
|
787
783
|
| `firmware_version` | `Optional[str]` | Firmware version |
|
|
@@ -793,6 +789,17 @@ Multichannel electrophysiology DAQ
|
|
|
793
789
|
| `notes` | `Optional[str]` | Notes |
|
|
794
790
|
|
|
795
791
|
|
|
792
|
+
### PatchClampEphysAssembly
|
|
793
|
+
|
|
794
|
+
Assembly combining a manipulator and headstage used for Patch clamp ephys
|
|
795
|
+
|
|
796
|
+
| Field | Type | Title (Description) |
|
|
797
|
+
|-------|------|-------------|
|
|
798
|
+
| `name` | `str` | Patch clamp Assembly Name |
|
|
799
|
+
| `manipulator` | [Manipulator](#manipulator) | Manipulator |
|
|
800
|
+
| `headstage` | [Device](#device) | Headstage |
|
|
801
|
+
|
|
802
|
+
|
|
796
803
|
### PockelsCell
|
|
797
804
|
|
|
798
805
|
Description of a Pockels Cell
|
|
@@ -12,7 +12,7 @@ Code or script identifier
|
|
|
12
12
|
| `name` | `Optional[str]` | Name |
|
|
13
13
|
| `version` | `Optional[str]` | Code version |
|
|
14
14
|
| `container` | Optional[[Container](#container)] | Container |
|
|
15
|
-
| `run_script` | `Optional[pathlib.
|
|
15
|
+
| `run_script` | `Optional[pathlib.Path]` | Run script (Path to run script) |
|
|
16
16
|
| `language` | `Optional[str]` | Programming language (Programming language used) |
|
|
17
17
|
| `language_version` | `Optional[str]` | Programming language version |
|
|
18
18
|
| `input_data` | Optional[List[[DataAsset](#dataasset) or [CombinedData](#combineddata)]] | Input data (Input data used in the code or script) |
|
|
@@ -58,6 +58,7 @@ Description of a human subject
|
|
|
58
58
|
|
|
59
59
|
| Field | Type | Title (Description) |
|
|
60
60
|
|-------|------|-------------|
|
|
61
|
+
| `species` | `aind_data_schema_models.species.SpeciesModel` | Species |
|
|
61
62
|
| `sex` | [Sex](#sex) | Sex |
|
|
62
63
|
| `year_of_birth` | `int` | Year of birth |
|
|
63
64
|
| `source` | [Organization](../aind_data_schema_models/organizations.md#organization) | Source (Where the subject was acquired from.) |
|
|
@@ -73,6 +74,17 @@ Description of vivarium light cycle times
|
|
|
73
74
|
| `lights_off_time` | `datetime.time` | Lights off time (Time in UTC that lights were turned off) |
|
|
74
75
|
|
|
75
76
|
|
|
77
|
+
### MatingStatus
|
|
78
|
+
|
|
79
|
+
Subject mating status
|
|
80
|
+
|
|
81
|
+
| Name | Value |
|
|
82
|
+
|------|-------|
|
|
83
|
+
| `MATED` | `Mated` |
|
|
84
|
+
| `UNMATED` | `Un-mated` |
|
|
85
|
+
| `UNKNOWN` | `Unknown` |
|
|
86
|
+
|
|
87
|
+
|
|
76
88
|
### MouseSubject
|
|
77
89
|
|
|
78
90
|
Description of a mouse subject
|
|
@@ -93,6 +105,20 @@ Description of a mouse subject
|
|
|
93
105
|
| `rrid` | Optional[[PIDName](../aind_data_schema_models/pid_names.md#pidname)] | RRID (RRID of mouse if acquired from supplier) |
|
|
94
106
|
|
|
95
107
|
|
|
108
|
+
### NonHumanPrimateSubject
|
|
109
|
+
|
|
110
|
+
Description of a non-human primate subject
|
|
111
|
+
|
|
112
|
+
| Field | Type | Title (Description) |
|
|
113
|
+
|-------|------|-------------|
|
|
114
|
+
| `species` | [Species](../aind_data_schema_models/species.md#species) | species |
|
|
115
|
+
| `sex` | [Sex](#sex) | Sex |
|
|
116
|
+
| `date_of_birth` | `Optional[datetime.date]` | Date of birth |
|
|
117
|
+
| `year_of_birth` | `int` | Year of birth |
|
|
118
|
+
| `mating_status` | [MatingStatus](#matingstatus) | Mating status |
|
|
119
|
+
| `source` | [Organization](../aind_data_schema_models/organizations.md#organization) | Source (Where the subject was acquired from.) |
|
|
120
|
+
|
|
121
|
+
|
|
96
122
|
### Sex
|
|
97
123
|
|
|
98
124
|
Subject sex name
|
|
@@ -64,4 +64,4 @@ Description of an instrument
|
|
|
64
64
|
| `temperature_control` | `Optional[bool]` | Temperature control (Does the instrument maintain a constant temperature?) |
|
|
65
65
|
| `notes` | `Optional[str]` | Notes |
|
|
66
66
|
| `connections` | List[[Connection](components/connections.md#connection)] | Connections (List of all connections between devices in the instrument) |
|
|
67
|
-
| `components` | List[[Monitor](components/devices.md#monitor) or [Olfactometer](components/devices.md#olfactometer) or [LickSpout](components/devices.md#lickspout) or [LickSpoutAssembly](components/devices.md#lickspoutassembly) or [AirPuffDevice](components/devices.md#airpuffdevice) or [Speaker](components/devices.md#speaker) or [CameraAssembly](components/devices.md#cameraassembly) or [Enclosure](components/devices.md#enclosure) or [EphysAssembly](components/devices.md#ephysassembly) or [FiberAssembly](components/devices.md#fiberassembly) or [LaserAssembly](components/devices.md#laserassembly) or [FiberPatchCord](components/devices.md#fiberpatchcord) or [Laser](components/devices.md#laser) or [LightEmittingDiode](components/devices.md#lightemittingdiode) or [Lamp](components/devices.md#lamp) or [Detector](components/devices.md#detector) or [Camera](components/devices.md#camera) or [Objective](components/devices.md#objective) or [Scanner](components/devices.md#scanner) or [Filter](components/devices.md#filter) or [Lens](components/devices.md#lens) or [DigitalMicromirrorDevice](components/devices.md#digitalmicromirrordevice) or [PolygonalScanner](components/devices.md#polygonalscanner) or [PockelsCell](components/devices.md#pockelscell) or [HarpDevice](components/devices.md#harpdevice) or [NeuropixelsBasestation](components/devices.md#neuropixelsbasestation) or [OpenEphysAcquisitionBoard](components/devices.md#openephysacquisitionboard) or [MotorizedStage](components/devices.md#motorizedstage) or [ScanningStage](components/devices.md#scanningstage) or [AdditionalImagingDevice](components/devices.md#additionalimagingdevice) or [Disc](components/devices.md#disc) or [Wheel](components/devices.md#wheel) or [Tube](components/devices.md#tube) or [Treadmill](components/devices.md#treadmill) or [Arena](components/devices.md#arena) or [DAQDevice](components/devices.md#daqdevice) or [Computer](components/devices.md#computer) or [Microscope](components/devices.md#microscope) or [Device](components/devices.md#device)] | Components (List of all devices in the instrument) |
|
|
67
|
+
| `components` | List[[Monitor](components/devices.md#monitor) or [Olfactometer](components/devices.md#olfactometer) or [LickSpout](components/devices.md#lickspout) or [LickSpoutAssembly](components/devices.md#lickspoutassembly) or [AirPuffDevice](components/devices.md#airpuffdevice) or [Speaker](components/devices.md#speaker) or [CameraAssembly](components/devices.md#cameraassembly) or [Enclosure](components/devices.md#enclosure) or [EphysAssembly](components/devices.md#ephysassembly) or [FiberAssembly](components/devices.md#fiberassembly) or [LaserAssembly](components/devices.md#laserassembly) or [FiberPatchCord](components/devices.md#fiberpatchcord) or [Laser](components/devices.md#laser) or [LightEmittingDiode](components/devices.md#lightemittingdiode) or [Lamp](components/devices.md#lamp) or [Detector](components/devices.md#detector) or [Camera](components/devices.md#camera) or [Objective](components/devices.md#objective) or [Scanner](components/devices.md#scanner) or [Filter](components/devices.md#filter) or [Lens](components/devices.md#lens) or [DigitalMicromirrorDevice](components/devices.md#digitalmicromirrordevice) or [PatchClampEphysAssembly](components/devices.md#patchclampephysassembly) or [PolygonalScanner](components/devices.md#polygonalscanner) or [PockelsCell](components/devices.md#pockelscell) or [HarpDevice](components/devices.md#harpdevice) or [NeuropixelsBasestation](components/devices.md#neuropixelsbasestation) or [OpenEphysAcquisitionBoard](components/devices.md#openephysacquisitionboard) or [MotorizedStage](components/devices.md#motorizedstage) or [ScanningStage](components/devices.md#scanningstage) or [AdditionalImagingDevice](components/devices.md#additionalimagingdevice) or [Disc](components/devices.md#disc) or [Wheel](components/devices.md#wheel) or [Tube](components/devices.md#tube) or [Treadmill](components/devices.md#treadmill) or [Arena](components/devices.md#arena) or [DAQDevice](components/devices.md#daqdevice) or [Computer](components/devices.md#computer) or [Microscope](components/devices.md#microscope) or [Device](components/devices.md#device)] | Components (List of all devices in the instrument) |
|
|
@@ -8,7 +8,9 @@ The `procedures.json` file contains anything done to the subject or specimen pri
|
|
|
8
8
|
|
|
9
9
|
**Subject** procedures are performed on a live subject (e.g. injections, surgeries, implants, perfusions, etc.) whereas **specimen** procedures are performed on tissue extracted after perfusion (e.g. tissue processing, immunolabeling, sectioning, etc.).
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
### SpecimenProcedure.specimen_id
|
|
12
|
+
|
|
13
|
+
After perfusion or death we refer to specimens by the `specimen_id` field. When the tissue has not been sectioned in some way the `specimen_id` should be identical to the `subject_id`. Sectioned specimens should have a unique number appended as a suffix to the subject ID: `<subject_id>_<###>`.
|
|
12
14
|
|
|
13
15
|
## Examples
|
|
14
16
|
|
|
@@ -4,7 +4,15 @@ To ensure that your metadata is valid you need to construct the full [Metadata](
|
|
|
4
4
|
|
|
5
5
|
## Instrument and Acquisition
|
|
6
6
|
|
|
7
|
-
If you are validating your `Instrument` and `Acquisition` on your rig, you may not have access to the other metadata files like the procedures. To allow for partial validation of these files we include an `InstrumentAcquisitionCompatibility` class.
|
|
7
|
+
If you are validating your `Instrument` and `Acquisition` on your rig, you may not have access to the other metadata files like the procedures. To allow for partial validation of these files we include an `InstrumentAcquisitionCompatibility` class.
|
|
8
|
+
|
|
9
|
+
The following consistency rules are enforced:
|
|
10
|
+
|
|
11
|
+
- `Acquisition.instrument_id` must match `Instrument.instrument_id`
|
|
12
|
+
- Device names in `DataStream.active_devices` must match device names in the `Instrument`
|
|
13
|
+
- Device names in `StimulusEpoch.active_devices` must match device names in the `Instrument`
|
|
14
|
+
|
|
15
|
+
Construct it as follows:
|
|
8
16
|
|
|
9
17
|
```{python}
|
|
10
18
|
from aind_data_schema.utils.compatibility_check import InstrumentAcquisitionCompatibility
|