aind-data-schema 2.4.0__tar.gz → 2.5.1__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.4.0 → aind_data_schema-2.5.1}/.github/workflows/update_docs.yml +0 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/CONTRIBUTING.md +2 -2
- {aind_data_schema-2.4.0/src/aind_data_schema.egg-info → aind_data_schema-2.5.1}/PKG-INFO +3 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/acquisition.md +5 -4
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/coordinates.md +8 -7
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/devices.md +1 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/modalities.md +7 -1
- aind_data_schema-2.5.1/docs/source/aind_data_schema_models/organizations.md +140 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/process_names.md +1 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/registries.md +2 -0
- aind_data_schema-2.5.1/docs/source/aind_data_schema_models/species.md +35 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/configs.md +47 -31
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/devices.md +16 -5
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/measurements.md +2 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/specimen_procedures.md +38 -11
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/stimulus.md +4 -4
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/coordinate_systems.md +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/data_description.md +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/instrument.md +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/model.md +3 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/processing.md +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/quality_control.md +2 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/aibs_smartspim_instrument.py +6 -1
- aind_data_schema-2.5.1/examples/aibs_smartspim_procedures.py +102 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/aind_smartspim_instrument.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/bergamo_ophys_acquisition.py +9 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/data_description.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/ephys_acquisition.py +39 -12
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/ephys_instrument.py +59 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/exaspim_acquisition.py +9 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/exaspim_instrument.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/exaspim_quality_control.py +9 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/fip_behavior_instrument.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/fip_ophys_acquisition.py +23 -13
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/fip_ophys_instrument.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/model.py +7 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/mri_acquisition.py +33 -28
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/multiplane_ophys_acquisition.py +55 -6
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/multiplane_ophys_instrument.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/ophys_acquisition.py +9 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/ophys_procedures.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/procedures.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/processing.py +7 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/quality_control.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/subject.py +6 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/pyproject.toml +3 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/acquisition_schema.json +1048 -77
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/data_description_schema.json +4 -4
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/instrument_schema.json +741 -4
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/metadata_schema.json +2030 -240
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/procedures_schema.json +620 -20
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/processing_schema.json +2 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/quality_control_schema.json +4 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/subject_schema.json +232 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/__init__.py +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/configs.py +44 -28
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/devices.py +10 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/specimen_procedures.py +77 -10
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/acquisition.py +75 -11
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/data_description.py +6 -3
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/instrument.py +9 -6
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/metadata.py +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/procedures.py +2 -14
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/processing.py +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/quality_control.py +6 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/subject.py +1 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/docs/model_generator.py +19 -14
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/docs/registries_generator.py +5 -2
- aind_data_schema-2.5.1/src/aind_data_schema/utils/examples_generator.py +54 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/merge.py +10 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/validators.py +45 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1/src/aind_data_schema.egg-info}/PKG-INFO +3 -1
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema.egg-info/SOURCES.txt +0 -6
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema.egg-info/requires.txt +2 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_acquisition.py +72 -65
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_acquisition_configs.py +23 -21
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_composability_merge.py +12 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_examples.py +14 -16
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_instrument.py +4 -5
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_metadata.py +19 -2
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_procedures.py +39 -42
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_utils_merge.py +40 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_utils_validators.py +73 -3
- aind_data_schema-2.4.0/docs/source/aind_data_schema.components.rst +0 -125
- aind_data_schema-2.4.0/docs/source/aind_data_schema.core.rst +0 -85
- aind_data_schema-2.4.0/docs/source/aind_data_schema.rst +0 -31
- aind_data_schema-2.4.0/docs/source/aind_data_schema.utils.rst +0 -69
- aind_data_schema-2.4.0/docs/source/aind_data_schema_models/organizations.md +0 -133
- aind_data_schema-2.4.0/docs/source/aind_data_schema_models/species.md +0 -35
- aind_data_schema-2.4.0/docs/source/modules.rst +0 -7
- aind_data_schema-2.4.0/examples/aibs_smartspim_procedures.py +0 -169
- aind_data_schema-2.4.0/src/aind_data_schema/utils/examples_generator.py +0 -38
- aind_data_schema-2.4.0/tests/test_examples_generator.py +0 -28
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.flake8 +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/ISSUE_TEMPLATE/user-story.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/workflows/publish_dev.yml +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/workflows/run_dev_tests.yml +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/workflows/run_main_tests.yml +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.github/workflows/tag_and_publish_main.yml +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.gitignore +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/.readthedocs.yaml +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/CHANGELOG.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/CODE_OF_CONDUCT.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/LICENSE +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/README.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/Makefile +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/acquisition.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/data_description.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/instrument.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/metadata.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/model.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/procedures.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/processing.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/quality_control.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/base/core/subject.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/make.bat +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/bregma_and_lambda2.png +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/coordinates2.png +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/coordinates2_original.png +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/custom.css +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/dark-logo.svg +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/favicon.ico +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/light-logo.svg +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/session_image_1.png +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/session_image_2.png +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/_static/session_image_3.png +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/atlas.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/brain_atlas.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/data_name_patterns.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/external.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/harp_types.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/licenses.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/pid_names.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/reagent.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/specimen_procedure_types.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/stimulus_modality.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/system_architecture.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/units.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/connections.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/coordinates.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/identifiers.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/injection_procedures.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/reagent.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/subject_procedures.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/subjects.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/surgery_procedures.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components.rst +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/conf.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/example_workflow/example_workflow.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/example_workflow/example_workflow.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/example_workflow/example_workflow.xlsx +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/general.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/index.rst +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/metadata.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/procedures.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/registries.rst +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/related_standards.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/subject.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/validation.md +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/examples/__init__.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/schemas/model_schema.json +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/setup.cfg +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/setup.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/base.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/__init__.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/connections.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/coordinates.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/identifiers.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/injection_procedures.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/measurements.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/reagent.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/stimulus.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/subject_procedures.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/subjects.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/surgery_procedures.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/components/wrappers.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/__init__.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/core/model.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/__init__.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/compatibility_check.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/docs/doc_generator.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/docs/utils.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/exceptions.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/json_writer.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema/utils/schema_version_bump.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema.egg-info/dependency_links.txt +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/src/aind_data_schema.egg-info/top_level.txt +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/__init__.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_aind_generic.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_base.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_bump_schema_versions.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_compatibility_check.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_configs.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_coordinates.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_data_description.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_device.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_identifiers.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_imaging.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_inst_acq_compatibility.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_json_writer.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_measurements.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_model.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_processing.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_quality_control.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_stimulus.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_subject.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_subjects.py +0 -0
- {aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/tests/test_wrappers.py +0 -0
|
@@ -62,9 +62,6 @@ jobs:
|
|
|
62
62
|
run: |
|
|
63
63
|
sudo apt install graphviz libgraphviz-dev -y
|
|
64
64
|
python -m pip install -e .[dev] -e .[docs] --no-cache-dir
|
|
65
|
-
- name: Generate new rst files
|
|
66
|
-
run: |
|
|
67
|
-
sphinx-apidoc -o docs/source/ src
|
|
68
65
|
- name: Commit changes
|
|
69
66
|
uses: EndBug/add-and-commit@v9
|
|
70
67
|
with:
|
|
@@ -179,6 +179,6 @@ When you are ready to open a pull request, please link any relevant issues and r
|
|
|
179
179
|
- Manually increment the major/minor/patch versions of the core files as needed
|
|
180
180
|
- Push the branch and open a PR into main
|
|
181
181
|
- After this push, any last minute changes to the release-vX.Y.Z will have to done to via a PR
|
|
182
|
-
- After review, use a merge commit to merge into main
|
|
183
|
-
- Open a PR from main back into dev so they're synced again
|
|
182
|
+
- After review, use a **merge commit** to merge into main, DO NOT SQUASH INTO MAIN
|
|
183
|
+
- Open a PR from main back into dev so they're synced again, bypass the rules to use a **merge commit**, DO NOT SQUASH MAIN INTO DEV
|
|
184
184
|
- Create a Github release with the corresponding tag, modify the auto-generated release notes to focus on the major changes that occurred
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: aind-data-schema
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.5.1
|
|
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
|
|
@@ -9,12 +9,14 @@ Description-Content-Type: text/markdown
|
|
|
9
9
|
License-File: LICENSE
|
|
10
10
|
Requires-Dist: aind-data-schema-models<6,>=5
|
|
11
11
|
Requires-Dist: pydantic<2.12,>=2.7
|
|
12
|
+
Requires-Dist: pydantic-extra-types
|
|
12
13
|
Provides-Extra: dev
|
|
13
14
|
Requires-Dist: aind_data_schema[linters]; extra == "dev"
|
|
14
15
|
Requires-Dist: pydantic!=2.9.0,!=2.9.1,>=2.7; extra == "dev"
|
|
15
16
|
Requires-Dist: scipy; extra == "dev"
|
|
16
17
|
Requires-Dist: dictdiffer; extra == "dev"
|
|
17
18
|
Requires-Dist: semver; extra == "dev"
|
|
19
|
+
Requires-Dist: argparse; extra == "dev"
|
|
18
20
|
Provides-Extra: linters
|
|
19
21
|
Requires-Dist: codespell; extra == "linters"
|
|
20
22
|
Requires-Dist: black; extra == "linters"
|
|
@@ -79,7 +79,8 @@ while the StimulusEpoch represents all stimuli being presented.
|
|
|
79
79
|
|-------|------|-------------|
|
|
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
|
-
| `acquisition_start_time` | `datetime (timezone-aware)` | Acquisition start time
|
|
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` | `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.) |
|
|
83
84
|
| `acquisition_end_time` | `datetime (timezone-aware)` | Acquisition end time |
|
|
84
85
|
| `experimenters` | `List[str]` | experimenter(s) |
|
|
85
86
|
| `protocol_id` | `Optional[List[str]]` | Protocol ID (DOI for protocols.io) |
|
|
@@ -108,7 +109,7 @@ Details about the subject during an acquisition
|
|
|
108
109
|
| `animal_weight_post` | `Optional[decimal.Decimal]` | Animal weight (g) (Animal weight after procedure) |
|
|
109
110
|
| `weight_unit` | [MassUnit](aind_data_schema_models/units.md#massunit) | Weight unit |
|
|
110
111
|
| `anaesthesia` | Optional[[Anaesthetic](components/surgery_procedures.md#anaesthetic)] | Anaesthesia (Anaesthesia present during entire acquisition, use Manipulation for partial anaesthesia) |
|
|
111
|
-
| `mouse_platform_name` | `str` | Mouse platform
|
|
112
|
+
| `mouse_platform_name` | `str` | Mouse platform (The surface that the mouse is on during the acquisition) |
|
|
112
113
|
| `reward_consumed_total` | `Optional[decimal.Decimal]` | Total reward consumed (mL) |
|
|
113
114
|
| `reward_consumed_unit` | Optional[[VolumeUnit](aind_data_schema_models/units.md#volumeunit)] | Reward consumed unit |
|
|
114
115
|
|
|
@@ -126,7 +127,7 @@ same time.
|
|
|
126
127
|
| `code` | Optional[List[[Code](components/identifiers.md#code)]] | Acquisition code |
|
|
127
128
|
| `notes` | `Optional[str]` | Notes |
|
|
128
129
|
| `active_devices` | `List[str]` | Active devices (Device names must match devices in the Instrument) |
|
|
129
|
-
| `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 [MRIScan](components/configs.md#mriscan) or [LickSpoutConfig](components/configs.md#lickspoutconfig) or [AirPuffConfig](components/configs.md#airpuffconfig) or [ImagingConfig](components/configs.md#imagingconfig) or [SlapPlane](components/configs.md#slapplane) 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) |
|
|
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 [SlapPlane](components/configs.md#slapplane) 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) |
|
|
130
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)) |
|
|
131
132
|
|
|
132
133
|
|
|
@@ -149,7 +150,7 @@ Summary of a StimulusEpoch
|
|
|
149
150
|
|
|
150
151
|
| Field | Type | Title (Description) |
|
|
151
152
|
|-------|------|-------------|
|
|
152
|
-
| `output_parameters` | `dict` | Additional metrics |
|
|
153
|
+
| `output_parameters` | `Optional[dict]` | Additional metrics |
|
|
153
154
|
| `reward_consumed_during_epoch` | `Optional[decimal.Decimal]` | Reward consumed during training (uL) |
|
|
154
155
|
| `reward_consumed_unit` | Optional[[VolumeUnit](aind_data_schema_models/units.md#volumeunit)] | Reward consumed unit |
|
|
155
156
|
| `trials_total` | `Optional[int]` | Total trials |
|
{aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/coordinates.md
RENAMED
|
@@ -64,13 +64,14 @@ Origin positions for coordinate systems
|
|
|
64
64
|
| `ORIGIN` | `Origin` |
|
|
65
65
|
| `BREGMA` | `Bregma` |
|
|
66
66
|
| `LAMBDA` | `Lambda` |
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
70
|
-
| `
|
|
71
|
-
| `
|
|
72
|
-
| `
|
|
73
|
-
| `
|
|
67
|
+
| `BETWEEN_C1_C2` | `Between_C1-C2` |
|
|
68
|
+
| `BETWEEN_C2_C3` | `Between_C2-C3` |
|
|
69
|
+
| `BETWEEN_C3_C4` | `Between_C3-C4` |
|
|
70
|
+
| `BETWEEN_C4_C5` | `Between_C4-C5` |
|
|
71
|
+
| `BETWEEN_C6_C7` | `Between_C6-C7` |
|
|
72
|
+
| `BETWEEN_C7_C8` | `Between_C7-C8` |
|
|
73
|
+
| `BETWEEN_C8_T1` | `Between_C8-T1` |
|
|
74
|
+
| `BETWEEN_T1_T2` | `Between_T1-T2` |
|
|
74
75
|
| `TIP` | `Tip` |
|
|
75
76
|
| `FRONT_CENTER` | `Front_center` |
|
|
76
77
|
| `ARENA_CENTER` | `Arena_center` |
|
{aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/modalities.md
RENAMED
|
@@ -8,19 +8,25 @@ Modalities
|
|
|
8
8
|
|
|
9
9
|
| Name | name | abbreviation |
|
|
10
10
|
|------|------|------|
|
|
11
|
+
| `BARSEQ` | `Barcoded anatomy resolved by sequencing` | `BARseq` |
|
|
11
12
|
| `BEHAVIOR` | `Behavior` | `behavior` |
|
|
12
13
|
| `BEHAVIOR_VIDEOS` | `Behavior videos` | `behavior-videos` |
|
|
14
|
+
| `BRIGHTFIELD` | `Brightfield microscopy` | `brightfield` |
|
|
13
15
|
| `CONFOCAL` | `Confocal microscopy` | `confocal` |
|
|
14
16
|
| `ECEPHYS` | `Extracellular electrophysiology` | `ecephys` |
|
|
17
|
+
| `EM` | `Electron microscopy` | `EM` |
|
|
15
18
|
| `EMG` | `Electromyography` | `EMG` |
|
|
16
19
|
| `FIB` | `Fiber photometry` | `fib` |
|
|
17
20
|
| `FMOST` | `Fluorescence micro-optical sectioning tomography` | `fMOST` |
|
|
18
21
|
| `ICEPHYS` | `Intracellular electrophysiology` | `icephys` |
|
|
19
22
|
| `ISI` | `Intrinsic signal imaging` | `ISI` |
|
|
23
|
+
| `MAPSEQ` | `Multiplexed analysis of projections by sequencing` | `MAPseq` |
|
|
20
24
|
| `MERFISH` | `Multiplexed error-robust fluorescence in situ hybridization` | `merfish` |
|
|
21
25
|
| `MRI` | `Magnetic resonance imaging` | `MRI` |
|
|
22
26
|
| `POPHYS` | `Planar optical physiology` | `pophys` |
|
|
23
|
-
| `
|
|
27
|
+
| `SCRNASEQ` | `Single cell RNA sequencing` | `scRNAseq` |
|
|
28
|
+
| `SLAP2` | `Random access projection microscopy` | `slap2` |
|
|
24
29
|
| `SPIM` | `Selective plane illumination microscopy` | `SPIM` |
|
|
30
|
+
| `STPT` | `Serial two-photon tomogrophy` | `STPT` |
|
|
25
31
|
|
|
26
32
|
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# Organizations
|
|
2
|
+
|
|
3
|
+
## Model definitions
|
|
4
|
+
|
|
5
|
+
### Organization
|
|
6
|
+
|
|
7
|
+
Organization
|
|
8
|
+
|
|
9
|
+
| Name | abbreviation | name | registry | registry_identifier |
|
|
10
|
+
|------|------|------|------|------|
|
|
11
|
+
| `AA_OPTO_ELECTRONIC` | `None` | `AA Opto Electronic` | `None` | `None` |
|
|
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
|
+
| `AILIPU` | `Ailipu` | `Ailipu Technology Co` | `None` | `None` |
|
|
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
|
+
| `ARDUINO` | `None` | `Arduino` | `None` | `None` |
|
|
20
|
+
| `ARECONT_VISION_COSTAR` | `None` | `Arecont Vision Costar` | `None` | `None` |
|
|
21
|
+
| `ASI` | `ASI` | `Applied Scientific Instrumentation` | `None` | `None` |
|
|
22
|
+
| `ASUS` | `None` | `ASUS` | `Research Organization Registry (ROR)` | `00bxkz165` |
|
|
23
|
+
| `BASLER` | `None` | `Basler` | `None` | `None` |
|
|
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` |
|
|
28
|
+
| `CAMBRIDGE_TECHNOLOGY` | `None` | `Cambridge Technology` | `None` | `None` |
|
|
29
|
+
| `CARL_ZEISS` | `None` | `Carl Zeiss` | `Research Organization Registry (ROR)` | `01xk5xs43` |
|
|
30
|
+
| `CATHETER_IMPLANT_INSTITUTIONS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
31
|
+
| `CHAMPALIMAUD` | `Champalimaud` | `Champalimaud Foundation` | `Research Organization Registry (ROR)` | `03g001n57` |
|
|
32
|
+
| `CHROMA` | `None` | `Chroma` | `None` | `None` |
|
|
33
|
+
| `COHERENT_SCIENTIFIC` | `None` | `Coherent Scientific` | `Research Organization Registry (ROR)` | `031tysd23` |
|
|
34
|
+
| `COLUMBIA` | `Columbia` | `Columbia University` | `Research Organization Registry (ROR)` | `00hj8s172` |
|
|
35
|
+
| `COMPUTAR` | `None` | `Computar` | `None` | `None` |
|
|
36
|
+
| `CONOPTICS` | `None` | `Conoptics` | `None` | `None` |
|
|
37
|
+
| `CRESTOPTICS` | `None` | `CrestOptics` | `None` | `None` |
|
|
38
|
+
| `CRL` | `CRL` | `Charles River Laboratories` | `Research Organization Registry (ROR)` | `03ndmsg87` |
|
|
39
|
+
| `CUSTOM` | `None` | `Custom` | `None` | `None` |
|
|
40
|
+
| `CZI` | `CZI` | `Chan Zuckerberg Initiative` | `Research Organization Registry (ROR)` | `02qenvm24` |
|
|
41
|
+
| `DAQ_DEVICE_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
42
|
+
| `DETECTOR_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
43
|
+
| `DIGIKEY` | `None` | `DigiKey` | `None` | `None` |
|
|
44
|
+
| `DODOTRONIC` | `None` | `Dodotronic` | `None` | `None` |
|
|
45
|
+
| `DORIC` | `None` | `Doric` | `Research Organization Registry (ROR)` | `059n53q30` |
|
|
46
|
+
| `EALING` | `None` | `Ealing` | `None` | `None` |
|
|
47
|
+
| `EDMUND_OPTICS` | `None` | `Edmund Optics` | `Research Organization Registry (ROR)` | `01j1gwp17` |
|
|
48
|
+
| `EMORY` | `Emory` | `Emory University` | `Research Organization Registry (ROR)` | `03czfpz43` |
|
|
49
|
+
| `EURESYS` | `None` | `Euresys` | `None` | `None` |
|
|
50
|
+
| `FILTER_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
51
|
+
| `FLIR` | `FLIR` | `Teledyne FLIR` | `Research Organization Registry (ROR)` | `01j1gwp17` |
|
|
52
|
+
| `FUJINON` | `None` | `Fujinon` | `None` | `None` |
|
|
53
|
+
| `FUNDERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
54
|
+
| `HAMAMATSU` | `None` | `Hamamatsu` | `Research Organization Registry (ROR)` | `03natb733` |
|
|
55
|
+
| `HAMILTON` | `None` | `Hamilton` | `None` | `None` |
|
|
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` |
|
|
59
|
+
| `INFINITY_PHOTO_OPTICAL` | `None` | `Infinity Photo-Optical` | `None` | `None` |
|
|
60
|
+
| `INVITROGEN` | `None` | `Invitrogen` | `Research Organization Registry (ROR)` | `03x1ewr52` |
|
|
61
|
+
| `IR_ROBOT_CO` | `None` | `IR Robot Co` | `None` | `None` |
|
|
62
|
+
| `ISL` | `ISL` | `ISL Products International` | `None` | `None` |
|
|
63
|
+
| `ITEM` | `None` | `Item` | `None` | `None` |
|
|
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` |
|
|
68
|
+
| `JULABO` | `None` | `Julabo` | `None` | `None` |
|
|
69
|
+
| `KOWA` | `None` | `Kowa` | `Research Organization Registry (ROR)` | `03zbwg482` |
|
|
70
|
+
| `LASER_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
71
|
+
| `LASOS` | `LASOS` | `LASOS Lasertechnik` | `None` | `None` |
|
|
72
|
+
| `LED_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
73
|
+
| `LEICA` | `None` | `Leica` | `None` | `None` |
|
|
74
|
+
| `LENS_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
75
|
+
| `LG` | `None` | `LG` | `Research Organization Registry (ROR)` | `02b948n83` |
|
|
76
|
+
| `LIFECANVAS` | `None` | `LifeCanvas` | `None` | `None` |
|
|
77
|
+
| `LUMENCOR` | `None` | `Lumencor` | `None` | `None` |
|
|
78
|
+
| `LUMEN_DYNAMICS` | `None` | `Lumen Dynamics` | `None` | `None` |
|
|
79
|
+
| `MANIPULATOR_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
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` |
|
|
83
|
+
| `MIDOPT` | `MidOpt` | `Midwest Optical Systems, Inc.` | `None` | `None` |
|
|
84
|
+
| `MIT` | `MIT` | `Massachusetts Institute of Technology` | `Research Organization Registry (ROR)` | `042nb2s44` |
|
|
85
|
+
| `MITUTUYO` | `None` | `Mitutuyo` | `None` | `None` |
|
|
86
|
+
| `MIT_BCS` | `MIT-BCS` | `MIT Department of Brain and Cognitive Sciences` | `None` | `None` |
|
|
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` |
|
|
89
|
+
| `MONITOR_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
90
|
+
| `MPI` | `MPI` | `MPI` | `None` | `None` |
|
|
91
|
+
| `NATIONAL_INSTRUMENTS` | `None` | `National Instruments` | `Research Organization Registry (ROR)` | `026exqw73` |
|
|
92
|
+
| `NAVITAR` | `None` | `Navitar` | `None` | `None` |
|
|
93
|
+
| `NCCIH` | `NCCIH` | `National Center for Complementary and Integrative Health` | `Research Organization Registry (ROR)` | `00190t495` |
|
|
94
|
+
| `NEURALYNX` | `None` | `NeuraLynx` | `None` | `None` |
|
|
95
|
+
| `NEUROPHOTOMETRICS` | `None` | `Neurophotometrics` | `None` | `None` |
|
|
96
|
+
| `NEW_SCALE_TECHNOLOGIES` | `None` | `New Scale Technologies` | `None` | `None` |
|
|
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` |
|
|
100
|
+
| `NRESEARCH_INC` | `None` | `NResearch Inc` | `None` | `None` |
|
|
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` |
|
|
104
|
+
| `OPTOTUNE` | `None` | `Optotune` | `None` | `None` |
|
|
105
|
+
| `OTHER` | `None` | `Other` | `None` | `None` |
|
|
106
|
+
| `OXXIUS` | `None` | `Oxxius` | `None` | `None` |
|
|
107
|
+
| `PLACID_INDUSTRIES` | `None` | `Placid Industries` | `None` | `None` |
|
|
108
|
+
| `PRIZMATIX` | `None` | `Prizmatix` | `None` | `None` |
|
|
109
|
+
| `QUANTIFI` | `None` | `Quantifi` | `None` | `None` |
|
|
110
|
+
| `RASPBERRY_PI` | `None` | `Raspberry Pi` | `None` | `None` |
|
|
111
|
+
| `RESEARCH_INSTITUTIONS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
112
|
+
| `SAME_SKY` | `None` | `Same Sky` | `None` | `None` |
|
|
113
|
+
| `SCHNEIDER_KREUZNACH` | `None` | `Schneider-Kreuznach` | `None` | `None` |
|
|
114
|
+
| `SECOND_ORDER_EFFECTS` | `None` | `Second Order Effects` | `None` | `None` |
|
|
115
|
+
| `SEMROCK` | `None` | `Semrock` | `None` | `None` |
|
|
116
|
+
| `SICGEN` | `None` | `SICGEN` | `None` | `None` |
|
|
117
|
+
| `SIGMA_ALDRICH` | `None` | `Sigma-Aldrich` | `None` | `None` |
|
|
118
|
+
| `SIMONS_FOUNDATION` | `None` | `Simons Foundation` | `Research Organization Registry (ROR)` | `01cmst727` |
|
|
119
|
+
| `SPEAKER_MANUFACTURERS` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
120
|
+
| `SPECTRA_PHYSICS` | `None` | `Spectra-Physics` | `Research Organization Registry (ROR)` | `02ad9kp97` |
|
|
121
|
+
| `SPINNAKER` | `None` | `Spinnaker` | `None` | `None` |
|
|
122
|
+
| `SUBJECT_SOURCES` | `N/A` | `N/A` | `N/A` | `N/A` |
|
|
123
|
+
| `TAMRON` | `None` | `Tamron` | `None` | `None` |
|
|
124
|
+
| `TELEDYNE_VISION_SOLUTIONS` | `None` | `Teledyne Vision Solutions` | `None` | `None` |
|
|
125
|
+
| `TE_CONNECTIVITY` | `None` | `TE Connectivity` | `Research Organization Registry (ROR)` | `034frgp20` |
|
|
126
|
+
| `THERMO_FISHER_SCIENTIFIC` | `None` | `Thermo Fisher Scientific` | `Research Organization Registry (ROR)` | `03x1ewr52` |
|
|
127
|
+
| `THE_IMAGING_SOURCE` | `None` | `The Imaging Source` | `None` | `None` |
|
|
128
|
+
| `THE_LEE_COMPANY` | `None` | `The Lee Company` | `None` | `None` |
|
|
129
|
+
| `THORLABS` | `None` | `Thorlabs` | `Research Organization Registry (ROR)` | `04gsnvb07` |
|
|
130
|
+
| `TMC` | `TMC` | `Technical Manufacturing Corporation` | `None` | `None` |
|
|
131
|
+
| `TRANSDUCER_TECHNIQUES` | `None` | `Transducer Techniques` | `None` | `None` |
|
|
132
|
+
| `TWCF` | `TWCF` | `Templeton World Charity Foundation` | `Research Organization Registry (ROR)` | `00x0z1472` |
|
|
133
|
+
| `TYMPHANY` | `None` | `Tymphany` | `None` | `None` |
|
|
134
|
+
| `UCSD` | `UCSD` | `University of California, San Diego` | `Research Organization Registry (ROR)` | `0168r3w48` |
|
|
135
|
+
| `UNKNOWN` | `UNKNOWN` | `Unknown` | `None` | `None` |
|
|
136
|
+
| `UPENN` | `UPENN` | `University of Pennsylvania` | `Research Organization Registry (ROR)` | `00b30xv10` |
|
|
137
|
+
| `VIEWORKS` | `None` | `Vieworks` | `None` | `None` |
|
|
138
|
+
| `VORTRAN` | `None` | `Vortran` | `None` | `None` |
|
|
139
|
+
|
|
140
|
+
|
|
@@ -37,6 +37,7 @@ Process names
|
|
|
37
37
|
| `IMAGE_TILE_PROJECTION` | `Image tile projection` |
|
|
38
38
|
| `MODEL_EVALUATION` | `Model evaluation` |
|
|
39
39
|
| `MODEL_TRAINING` | `Model training` |
|
|
40
|
+
| `NEURON_SKELETON_PROCESSING` | `Neuron skeleton processing` |
|
|
40
41
|
| `NEUROPIL_SUBTRACTION` | `Neuropil subtraction` |
|
|
41
42
|
| `OTHER` | `Other` |
|
|
42
43
|
| `PIPELINE` | `Pipeline` |
|
{aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/aind_data_schema_models/registries.md
RENAMED
|
@@ -9,8 +9,10 @@ Registries
|
|
|
9
9
|
| Name | Value |
|
|
10
10
|
|------|-------|
|
|
11
11
|
| `ADDGENE` | `Addgene (ADDGENE)` |
|
|
12
|
+
| `DOI` | `Digital Object Identifier (DOI)` |
|
|
12
13
|
| `EMAPA` | `Edinburgh Mouse Atlas Project (EMAPA)` |
|
|
13
14
|
| `MGI` | `Mouse Genome Informatics (MGI)` |
|
|
15
|
+
| `GENBANK` | `NCBI GenBank (GENBANK)` |
|
|
14
16
|
| `NCBI` | `National Center for Biotechnology Information (NCBI)` |
|
|
15
17
|
| `ORCID` | `Open Researcher and Contributor ID (ORCID)` |
|
|
16
18
|
| `ROR` | `Research Organization Registry (ROR)` |
|
|
@@ -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
|
+
|
|
@@ -227,6 +227,20 @@ Solution names
|
|
|
227
227
|
| `OTHER` | `Other` |
|
|
228
228
|
|
|
229
229
|
|
|
230
|
+
### MISCameraConfig
|
|
231
|
+
|
|
232
|
+
Configuration for a camera used in a New Scale modular insertion system
|
|
233
|
+
|
|
234
|
+
| Field | Type | Title (Description) |
|
|
235
|
+
|-------|------|-------------|
|
|
236
|
+
| `detector_config` | [DetectorConfig](#detectorconfig) | Detector configuration |
|
|
237
|
+
| `module` | [MISModuleConfig](#mismoduleconfig) | Module |
|
|
238
|
+
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
|
239
|
+
| `relative_position` | List[[AnatomicalRelative](../aind_data_schema_models/coordinates.md#anatomicalrelative)] | Relative position |
|
|
240
|
+
| `coordinate_system` | Optional[[CoordinateSystem](coordinates.md#coordinatesystem)] | Device coordinate system |
|
|
241
|
+
| `transform` | Optional[List[[Translation](coordinates.md#translation) or [Rotation](coordinates.md#rotation) or [Scale](coordinates.md#scale) or [Affine](coordinates.md#affine)]] | Device to instrument transform (Position and orientation of the device in the instrument coordinate system) |
|
|
242
|
+
|
|
243
|
+
|
|
230
244
|
### MISModuleConfig
|
|
231
245
|
|
|
232
246
|
Modular insertion system module configuration
|
|
@@ -240,28 +254,38 @@ Modular insertion system module configuration
|
|
|
240
254
|
| `notes` | `Optional[str]` | Notes |
|
|
241
255
|
|
|
242
256
|
|
|
257
|
+
### MRAcquisitionType
|
|
258
|
+
|
|
259
|
+
MRI acquisition type
|
|
260
|
+
|
|
261
|
+
| Name | Value |
|
|
262
|
+
|------|-------|
|
|
263
|
+
| `SCAN_2D` | `2D` |
|
|
264
|
+
| `SCAN_3D` | `3D` |
|
|
265
|
+
|
|
266
|
+
|
|
243
267
|
### MRIScan
|
|
244
268
|
|
|
245
269
|
Configuration of a 3D scan
|
|
246
270
|
|
|
247
271
|
| Field | Type | Title (Description) |
|
|
248
272
|
|-------|------|-------------|
|
|
249
|
-
| `
|
|
250
|
-
| `
|
|
251
|
-
| `
|
|
252
|
-
| `
|
|
273
|
+
| `index` | `int` | Index (Index of the scan in the session, starting at 1) |
|
|
274
|
+
| `setup` | `bool` | Setup (Positioning, shim, and other pre-scan adjustments) |
|
|
275
|
+
| `pulse_sequence_type` | [PulseSequenceType](#pulsesequencetype) | Scan sequence (BIDS PulseSequenceType) |
|
|
276
|
+
| `mr_acquisition_type` | [MRAcquisitionType](#mracquisitiontype) | MR acquisition type (BIDS MRAcquisitionType / DICOM Tag 0018,0023) |
|
|
277
|
+
| `resolution` | Optional[[Scale](coordinates.md#scale)] | Voxel resolution |
|
|
278
|
+
| `resolution_unit` | Optional[[SizeUnit](../aind_data_schema_models/units.md#sizeunit)] | Voxel resolution unit |
|
|
279
|
+
| `additional_scan_parameters` | `Optional[dict]` | Parameters |
|
|
253
280
|
| `rare_factor` | `Optional[int]` | RARE factor |
|
|
254
|
-
| `echo_time` | `decimal.Decimal` | Echo time
|
|
281
|
+
| `echo_time` | `decimal.Decimal` | Echo time (s) (BIDS EchoTime / DICOM Tag 0018,0081) |
|
|
255
282
|
| `echo_time_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | Echo time unit |
|
|
256
283
|
| `effective_echo_time` | `Optional[decimal.Decimal]` | Effective echo time |
|
|
257
|
-
| `repetition_time` | `decimal.Decimal` | Repetition time
|
|
284
|
+
| `repetition_time` | `decimal.Decimal` | Repetition time (s) (BIDS RepetitionTime / DICOM Tag 0018,0080) |
|
|
258
285
|
| `repetition_time_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | Repetition time unit |
|
|
259
|
-
| `
|
|
260
|
-
| `
|
|
286
|
+
| `scanner_coordinate_system` | Optional[[CoordinateSystem](coordinates.md#coordinatesystem)] | Scanner coordinate system |
|
|
287
|
+
| `affine_transform` | Optional[List[[Translation](coordinates.md#translation) or [Rotation](coordinates.md#rotation) or [Scale](coordinates.md#scale) or [Affine](coordinates.md#affine)]] | MRI Scan affine transform (NIFTI sform/qform, Bruker vc_transform, etc) |
|
|
261
288
|
| `subject_position` | [SubjectPosition](#subjectposition) | Subject position |
|
|
262
|
-
| `resolution` | Optional[[Scale](coordinates.md#scale)] | Voxel resolution |
|
|
263
|
-
| `resolution_unit` | Optional[[SizeUnit](../aind_data_schema_models/units.md#sizeunit)] | Voxel resolution unit |
|
|
264
|
-
| `additional_scan_parameters` | `dict` | Parameters |
|
|
265
289
|
| `notes` | `Optional[str]` | Notes |
|
|
266
290
|
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
|
267
291
|
|
|
@@ -288,16 +312,6 @@ Configuration for mouse platforms
|
|
|
288
312
|
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
|
289
313
|
|
|
290
314
|
|
|
291
|
-
### MriScanSequence
|
|
292
|
-
|
|
293
|
-
MRI scan sequence
|
|
294
|
-
|
|
295
|
-
| Name | Value |
|
|
296
|
-
|------|-------|
|
|
297
|
-
| `RARE` | `RARE` |
|
|
298
|
-
| `OTHER` | `Other` |
|
|
299
|
-
|
|
300
|
-
|
|
301
315
|
### OlfactometerChannelInfo
|
|
302
316
|
|
|
303
317
|
Configuration of a channel in an olfactometer
|
|
@@ -402,6 +416,18 @@ Configuration for a device inserted into a brain
|
|
|
402
416
|
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
|
403
417
|
|
|
404
418
|
|
|
419
|
+
### PulseSequenceType
|
|
420
|
+
|
|
421
|
+
MRI pulse sequence type
|
|
422
|
+
|
|
423
|
+
| Name | Value |
|
|
424
|
+
|------|-------|
|
|
425
|
+
| `RARE` | `RARE` |
|
|
426
|
+
| `FLASH` | `FLASH` |
|
|
427
|
+
| `MSME` | `MSME` |
|
|
428
|
+
| `OTHER` | `Other` |
|
|
429
|
+
|
|
430
|
+
|
|
405
431
|
### SampleChamberConfig
|
|
406
432
|
|
|
407
433
|
Configuration of a sample chamber
|
|
@@ -423,16 +449,6 @@ Description of an image sampling strategy
|
|
|
423
449
|
| `frame_rate_unit` | [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) | Frame rate unit |
|
|
424
450
|
|
|
425
451
|
|
|
426
|
-
### ScanType
|
|
427
|
-
|
|
428
|
-
Type of scan
|
|
429
|
-
|
|
430
|
-
| Name | Value |
|
|
431
|
-
|------|-------|
|
|
432
|
-
| `SETUP` | `Set Up` |
|
|
433
|
-
| `SCAN_3D` | `3D Scan` |
|
|
434
|
-
|
|
435
|
-
|
|
436
452
|
### SlapAcquisitionType
|
|
437
453
|
|
|
438
454
|
Type of slap acquisition
|
|
@@ -340,7 +340,7 @@ Description of an enclosure
|
|
|
340
340
|
|
|
341
341
|
### EphysAssembly
|
|
342
342
|
|
|
343
|
-
Named assembly for combining a manipulator and ephys probes
|
|
343
|
+
Named assembly for combining a manipulator and extracellular ephys probes
|
|
344
344
|
|
|
345
345
|
| Field | Type | Title (Description) |
|
|
346
346
|
|-------|------|-------------|
|
|
@@ -351,7 +351,7 @@ Named assembly for combining a manipulator and ephys probes
|
|
|
351
351
|
|
|
352
352
|
### EphysProbe
|
|
353
353
|
|
|
354
|
-
Probe used in an ephys experiment
|
|
354
|
+
Probe used in an extracellular ephys experiment
|
|
355
355
|
|
|
356
356
|
| Field | Type | Title (Description) |
|
|
357
357
|
|-------|------|-------------|
|
|
@@ -622,9 +622,9 @@ Description of visual display for visual stimuli
|
|
|
622
622
|
| `viewing_distance` | `decimal.Decimal` | Viewing distance (cm) |
|
|
623
623
|
| `viewing_distance_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) | Viewing distance unit |
|
|
624
624
|
| `contrast` | `Optional[int]` | Contrast (Monitor's contrast setting) |
|
|
625
|
-
| `contrast_unit` |
|
|
625
|
+
| `contrast_unit` | Optional[[UnitlessUnit](../aind_data_schema_models/units.md#unitlessunit)] | Contrast unit |
|
|
626
626
|
| `brightness` | `Optional[int]` | Brightness (Monitor's brightness setting) |
|
|
627
|
-
| `brightness_unit` |
|
|
627
|
+
| `brightness_unit` | Optional[[UnitlessUnit](../aind_data_schema_models/units.md#unitlessunit)] | Brightness unit |
|
|
628
628
|
| `name` | `str` | Device name |
|
|
629
629
|
| `serial_number` | `Optional[str]` | Serial number |
|
|
630
630
|
| `model` | `Optional[str]` | Model |
|
|
@@ -781,7 +781,7 @@ Multichannel electrophysiology DAQ
|
|
|
781
781
|
| Field | Type | Title (Description) |
|
|
782
782
|
|-------|------|-------------|
|
|
783
783
|
| `ports` | List[[ProbePort](#probeport)] | Acquisition board ports |
|
|
784
|
-
| `data_interface` | `"
|
|
784
|
+
| `data_interface` | `"USB"` | |
|
|
785
785
|
| `manufacturer` | [Organization](../aind_data_schema_models/organizations.md#organization) | |
|
|
786
786
|
| `channels` | List[[DAQChannel](#daqchannel)] | DAQ channels |
|
|
787
787
|
| `firmware_version` | `Optional[str]` | Firmware version |
|
|
@@ -793,6 +793,17 @@ Multichannel electrophysiology DAQ
|
|
|
793
793
|
| `notes` | `Optional[str]` | Notes |
|
|
794
794
|
|
|
795
795
|
|
|
796
|
+
### PatchClampEphysAssembly
|
|
797
|
+
|
|
798
|
+
Assembly combining a manipulator and headstage used for Patch clamp ephys
|
|
799
|
+
|
|
800
|
+
| Field | Type | Title (Description) |
|
|
801
|
+
|-------|------|-------------|
|
|
802
|
+
| `name` | `str` | Patch clamp Assembly Name |
|
|
803
|
+
| `manipulator` | [Manipulator](#manipulator) | Manipulator |
|
|
804
|
+
| `headstage` | [Device](#device) | Headstage |
|
|
805
|
+
|
|
806
|
+
|
|
796
807
|
### PockelsCell
|
|
797
808
|
|
|
798
809
|
Description of a Pockels Cell
|
|
@@ -13,10 +13,10 @@ Generic calibration class
|
|
|
13
13
|
| `protocol_id` | `Optional[str]` | Protocol ID (DOI for protocols.io) |
|
|
14
14
|
| `measured_at` | `Optional[str]` | Measurement location |
|
|
15
15
|
| `input` | `List[float or str]` | Inputs (Calibration input) |
|
|
16
|
-
| `input_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) or [MassUnit](../aind_data_schema_models/units.md#massunit) or [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) or [SpeedUnit](../aind_data_schema_models/units.md#speedunit) or [VolumeUnit](../aind_data_schema_models/units.md#volumeunit) or [AngleUnit](../aind_data_schema_models/units.md#angleunit) or [TimeUnit](../aind_data_schema_models/units.md#timeunit) or [PowerUnit](../aind_data_schema_models/units.md#powerunit) or [CurrentUnit](../aind_data_schema_models/units.md#currentunit) or [ConcentrationUnit](../aind_data_schema_models/units.md#concentrationunit) or [TemperatureUnit](../aind_data_schema_models/units.md#temperatureunit) or [SoundIntensityUnit](../aind_data_schema_models/units.md#soundintensityunit) or [VoltageUnit](../aind_data_schema_models/units.md#voltageunit) or [MemoryUnit](../aind_data_schema_models/units.md#memoryunit) or [UnitlessUnit](../aind_data_schema_models/units.md#unitlessunit) or [MagneticFieldUnit](../aind_data_schema_models/units.md#magneticfieldunit) or [PressureUnit](../aind_data_schema_models/units.md#pressureunit) | Input unit |
|
|
16
|
+
| `input_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) or [MassUnit](../aind_data_schema_models/units.md#massunit) or [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) or [SpeedUnit](../aind_data_schema_models/units.md#speedunit) or [VolumeUnit](../aind_data_schema_models/units.md#volumeunit) or [AngleUnit](../aind_data_schema_models/units.md#angleunit) or [TimeUnit](../aind_data_schema_models/units.md#timeunit) or [PowerUnit](../aind_data_schema_models/units.md#powerunit) or [CurrentUnit](../aind_data_schema_models/units.md#currentunit) or [ConcentrationUnit](../aind_data_schema_models/units.md#concentrationunit) or [TemperatureUnit](../aind_data_schema_models/units.md#temperatureunit) or [SoundIntensityUnit](../aind_data_schema_models/units.md#soundintensityunit) or [VoltageUnit](../aind_data_schema_models/units.md#voltageunit) or [MemoryUnit](../aind_data_schema_models/units.md#memoryunit) or [UnitlessUnit](../aind_data_schema_models/units.md#unitlessunit) or [MagneticFieldUnit](../aind_data_schema_models/units.md#magneticfieldunit) or [PressureUnit](../aind_data_schema_models/units.md#pressureunit) or {TorqueUnit} | Input unit |
|
|
17
17
|
| `repeats` | `Optional[int]` | Number of repeats (If each input was repeated multiple times, provide the number of repeats) |
|
|
18
18
|
| `output` | `List[float or str]` | Outputs (Calibration output (provide the average if repeated)) |
|
|
19
|
-
| `output_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) or [MassUnit](../aind_data_schema_models/units.md#massunit) or [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) or [SpeedUnit](../aind_data_schema_models/units.md#speedunit) or [VolumeUnit](../aind_data_schema_models/units.md#volumeunit) or [AngleUnit](../aind_data_schema_models/units.md#angleunit) or [TimeUnit](../aind_data_schema_models/units.md#timeunit) or [PowerUnit](../aind_data_schema_models/units.md#powerunit) or [CurrentUnit](../aind_data_schema_models/units.md#currentunit) or [ConcentrationUnit](../aind_data_schema_models/units.md#concentrationunit) or [TemperatureUnit](../aind_data_schema_models/units.md#temperatureunit) or [SoundIntensityUnit](../aind_data_schema_models/units.md#soundintensityunit) or [VoltageUnit](../aind_data_schema_models/units.md#voltageunit) or [MemoryUnit](../aind_data_schema_models/units.md#memoryunit) or [UnitlessUnit](../aind_data_schema_models/units.md#unitlessunit) or [MagneticFieldUnit](../aind_data_schema_models/units.md#magneticfieldunit) or [PressureUnit](../aind_data_schema_models/units.md#pressureunit) | Output unit |
|
|
19
|
+
| `output_unit` | [SizeUnit](../aind_data_schema_models/units.md#sizeunit) or [MassUnit](../aind_data_schema_models/units.md#massunit) or [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) or [SpeedUnit](../aind_data_schema_models/units.md#speedunit) or [VolumeUnit](../aind_data_schema_models/units.md#volumeunit) or [AngleUnit](../aind_data_schema_models/units.md#angleunit) or [TimeUnit](../aind_data_schema_models/units.md#timeunit) or [PowerUnit](../aind_data_schema_models/units.md#powerunit) or [CurrentUnit](../aind_data_schema_models/units.md#currentunit) or [ConcentrationUnit](../aind_data_schema_models/units.md#concentrationunit) or [TemperatureUnit](../aind_data_schema_models/units.md#temperatureunit) or [SoundIntensityUnit](../aind_data_schema_models/units.md#soundintensityunit) or [VoltageUnit](../aind_data_schema_models/units.md#voltageunit) or [MemoryUnit](../aind_data_schema_models/units.md#memoryunit) or [UnitlessUnit](../aind_data_schema_models/units.md#unitlessunit) or [MagneticFieldUnit](../aind_data_schema_models/units.md#magneticfieldunit) or [PressureUnit](../aind_data_schema_models/units.md#pressureunit) or {TorqueUnit} | Output unit |
|
|
20
20
|
| `fit` | Optional[[CalibrationFit](#calibrationfit)] | Fit (Fit equation for the calibration data used during data acquisition) |
|
|
21
21
|
| `notes` | `Optional[str]` | Notes |
|
|
22
22
|
| `device_name` | `str` | Device name (Must match a device defined in the instrument.json) |
|
{aind_data_schema-2.4.0 → aind_data_schema-2.5.1}/docs/source/components/specimen_procedures.md
RENAMED
|
@@ -29,31 +29,49 @@ Description of an HCR staining round
|
|
|
29
29
|
| `probe_concentration_unit` | `str` | Probe concentration unit |
|
|
30
30
|
|
|
31
31
|
|
|
32
|
+
### PlanarSection
|
|
33
|
+
|
|
34
|
+
Description of a single planar section of brain tissue
|
|
35
|
+
|
|
36
|
+
| Field | Type | Title (Description) |
|
|
37
|
+
|-------|------|-------------|
|
|
38
|
+
| `coordinate_system_name` | `str` | Coordinate system name |
|
|
39
|
+
| `start_coordinate` | [Translation](coordinates.md#translation) | Start coordinate |
|
|
40
|
+
| `end_coordinate` | Optional[[Translation](coordinates.md#translation)] | End coordinate |
|
|
41
|
+
| `thickness` | `Optional[float]` | Slice thickness |
|
|
42
|
+
| `thickness_unit` | Optional[[SizeUnit](../aind_data_schema_models/units.md#sizeunit)] | Slice thickness unit |
|
|
43
|
+
| `partial_slice` | Optional[List[[AnatomicalRelative](../aind_data_schema_models/coordinates.md#anatomicalrelative)]] | Partial slice (If sectioning does not include the entire slice, indicate which part of the slice is retained.) |
|
|
44
|
+
| `output_specimen_id` | `str` | Specimen ID |
|
|
45
|
+
| `targeted_structure` | Optional[[BrainAtlas](../aind_data_schema_models/brain_atlas.md#ccfv3)] | Targeted structure |
|
|
46
|
+
| `includes_surrounding_tissue` | `Optional[bool]` | Includes surrounding tissue (Whether the section includes additional tissue surrounding the targeted structure.) |
|
|
47
|
+
|
|
48
|
+
|
|
32
49
|
### PlanarSectioning
|
|
33
50
|
|
|
34
51
|
Description of a sectioning procedure performed on the coronal, sagittal, or transverse/axial plane
|
|
35
52
|
|
|
36
53
|
| Field | Type | Title (Description) |
|
|
37
54
|
|-------|------|-------------|
|
|
38
|
-
| `coordinate_system` |
|
|
39
|
-
| `sections` | List[[Section](#section)] |
|
|
55
|
+
| `coordinate_system` | [CoordinateSystem](coordinates.md#coordinatesystem) or [Atlas](coordinates.md#atlas) or NoneType | Sectioning coordinate system (Only required if different from the Procedures.coordinate_system) |
|
|
56
|
+
| `sections` | List[[Section](#section) or [PlanarSection](#planarsection)] | Planar sections (Use PlanarSection for new implementations) |
|
|
40
57
|
| `section_orientation` | [SectionOrientation](#sectionorientation) | Sectioning orientation |
|
|
41
58
|
|
|
42
59
|
|
|
43
60
|
### Section
|
|
44
61
|
|
|
45
|
-
Description of a
|
|
62
|
+
Description of a single section of brain tissue. Slices should use PlanarSection.
|
|
46
63
|
|
|
47
64
|
| Field | Type | Title (Description) |
|
|
48
65
|
|-------|------|-------------|
|
|
49
66
|
| `output_specimen_id` | `str` | Specimen ID |
|
|
50
67
|
| `targeted_structure` | Optional[[BrainAtlas](../aind_data_schema_models/brain_atlas.md#ccfv3)] | Targeted structure |
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
| `
|
|
56
|
-
|
|
|
68
|
+
| `includes_surrounding_tissue` | `Optional[bool]` | Includes surrounding tissue (Whether the section includes additional tissue surrounding the targeted structure.) |
|
|
69
|
+
| <del>`coordinate_system_name`</del> | `Optional[str]` | **[DEPRECATED]** Use PlanarSection instead. Coordinate system name |
|
|
70
|
+
| <del>`start_coordinate`</del> | Optional[[Translation](coordinates.md#translation)] | **[DEPRECATED]** Use PlanarSection instead. Start coordinate |
|
|
71
|
+
| <del>`end_coordinate`</del> | Optional[[Translation](coordinates.md#translation)] | **[DEPRECATED]** Use PlanarSection instead. End coordinate |
|
|
72
|
+
| <del>`thickness`</del> | `Optional[float]` | **[DEPRECATED]** Use PlanarSection instead. Slice thickness |
|
|
73
|
+
| <del>`thickness_unit`</del> | Optional[[SizeUnit](../aind_data_schema_models/units.md#sizeunit)] | **[DEPRECATED]** Use PlanarSection instead. Slice thickness unit |
|
|
74
|
+
| <del>`partial_slice`</del> | Optional[List[[AnatomicalRelative](../aind_data_schema_models/coordinates.md#anatomicalrelative)]] | **[DEPRECATED]** Use PlanarSection instead. Partial slice (If sectioning does not include the entire slice, indicate which part of the slice is retained.) |
|
|
57
75
|
|
|
58
76
|
|
|
59
77
|
### SectionOrientation
|
|
@@ -67,6 +85,15 @@ Orientation of sectioning
|
|
|
67
85
|
| `TRANSVERSE` | `Transverse` |
|
|
68
86
|
|
|
69
87
|
|
|
88
|
+
### Sectioning
|
|
89
|
+
|
|
90
|
+
Description of a sectioning procedure targeting a specific structure
|
|
91
|
+
|
|
92
|
+
| Field | Type | Title (Description) |
|
|
93
|
+
|-------|------|-------------|
|
|
94
|
+
| `sections` | List[[Section](#section)] | Sections |
|
|
95
|
+
|
|
96
|
+
|
|
70
97
|
### SpecimenProcedure
|
|
71
98
|
|
|
72
99
|
Description of surgical or other procedure performed on a specimen
|
|
@@ -75,13 +102,13 @@ Description of surgical or other procedure performed on a specimen
|
|
|
75
102
|
|-------|------|-------------|
|
|
76
103
|
| `procedure_type` | [SpecimenProcedureType](../aind_data_schema_models/specimen_procedure_types.md#specimenproceduretype) | Procedure type |
|
|
77
104
|
| `procedure_name` | `Optional[str]` | Procedure name |
|
|
78
|
-
| `specimen_id` | `str` | Specimen ID |
|
|
105
|
+
| `specimen_id` | `str or List[str]` | Specimen ID(s) |
|
|
79
106
|
| `start_date` | `datetime.date` | Start date |
|
|
80
107
|
| `end_date` | `datetime.date` | End date |
|
|
81
108
|
| `experimenters` | `List[str]` | experimenter(s) |
|
|
82
109
|
| `protocol_id` | `Optional[List[str]]` | Protocol ID (DOI for protocols.io) |
|
|
83
110
|
| `protocol_parameters` | `Optional[Dict[str, str]]` | Protocol parameters (Parameters defined in the protocol and their value during this procedure) |
|
|
84
|
-
| `procedure_details` | List[[HCRSeries](#hcrseries) or [FluorescentStain](reagent.md#fluorescentstain) or [PlanarSectioning](#planarsectioning) or [ProbeReagent](reagent.md#probereagent) or [Reagent](reagent.md#reagent) or [GeneProbeSet](reagent.md#geneprobeset)] | Procedure details (Details of the procedures, including reagents and sectioning information.) |
|
|
111
|
+
| `procedure_details` | List[[HCRSeries](#hcrseries) or [FluorescentStain](reagent.md#fluorescentstain) or [Sectioning](#sectioning) or [PlanarSectioning](#planarsectioning) or [ProbeReagent](reagent.md#probereagent) or [Reagent](reagent.md#reagent) or [GeneProbeSet](reagent.md#geneprobeset)] | Procedure details (Details of the procedures, including reagents and sectioning information.) |
|
|
85
112
|
| `notes` | `Optional[str]` | Notes |
|
|
86
113
|
|
|
87
114
|
|