v2.2.0

What's Changed

• feat: adding Manipulation during acquisition by @dbirman in #1607
• docs: update docs for external registries by @dbirman in #1610
• docs: improvements to coordinate system docs by @dbirman in #1606
• fix: modify instrument merge by @dbirman in #1619
• fix: allow acquisition/procedures with None coordinate_system to merge by @dbirman in #1628
• feat: filename_suffix to do what suffix should have done by @dbirman in #1631
• Allow for partial instrument/acquisition compatibility checks without constructing Metadata object by @dbirman in #1623
• feat: DataStream.add and Acquistion._merge_data_stream_lists by @dbirman in #1634

Full Changelog: v2.1.0...v2.2.0

v2.1.0

What's Changed

• Added between-vertebrae coordinate origins by @dougollerenshaw in #1565
• Improve docs by adding title(desc) by @dbirman in #1572
• Set a ceiling on pydantic version to avoid errors with model_validators by @dbirman in #1584
• Moved the subject_details validator out of Acquisition to prevent errors by @dbirman in #1590
• add code now removes duplicates @dbirman in #1593
• Added new OlfactometerConfig to replace old stimulus configuration @dbirman in #1499
• Add DataDescription.from_data_description helper to replace from_raw by @dbirman in #1588
• Allow HarpDevice objects in lick_sensor field by @dbirman in #1595

Full Changelog: v2.0.3...v2.1.0

v2.0.3

What's Changed

• fix: adds check if dependency_graph is None by @jtyoung84 in #1576

Full Changelog: v2.0.2...v2.0.3

v2.0.2

What's Changed

• fix: prevent attribute error being raised when value.species == None by @dbirman in #1539
• fix: deprecate the channel_index field by @dbirman in #1540
• docs: add subclasses of GenericModel by @dbirman in #1551
• chore: remove (ms) annotation in title for exposure_unit by @dbirman in #1554
• refactor: remove custom exceptions, instead raise ValueError by @dbirman in #1558
• fix: check for transforms before checking for matching coord sys by @dbirman in #1559

Full Changelog: v2.0.1...v2.0.2

v2.0.1

This 2.0.1 hotfix release fixes several bugs introduced in the 2.0 upgrade. Some of these are breaking changes against 2.0.0. Please upgrade all scripts to use 2.0.1.

What's Changed

• Removed InjectionDynamics.rate which was redundant with combined volume/duration
• Added a critical description for ProbeConfig.coordinate_system
• Removed requirement that ephys modality experiments include an ephys
• Reduces requirement on Processing.dependency_graph to Optional
• Reduces requirement on DataProcess.end_date_time to
• Adds a model validator that sorts processes into chronological order using the start time
• Add a missing validator that ensure one of the required file sets is present for Metadata() validation
• Recovered a data_description.source_data field which was accidentally removed

Full Changelog: v2.0.0...v2.0.1

v2.0.0

Please view the new documentation to see the changes in aind-data-schema 2.0.

What's Changed

• Overhauled documentation to add classes definition tables and links between classes
• Merged instrument and rig, flattened instrument configurations
• Merged acquisition and session, flattened data stream and stimulus epoch configurations
• Removed connections from DAQ and moved them into their own flattened list
• Refactored Channel to better reflect the real organization of imaging experiments
• Refactored Reagents to better reflect their usage across experiments
• Flattened Processing
• Added Coordinate Systems and standardized the use of transforms
• Added many validators, including cross-file validators that ensure that duplicated fields and key references are valid
• Simplified data description and subject
• Added support for human subjects and calibration objects
• Added support for non-mouse anatomical targeting
• Added the model metadata file
• Simplified the file requirement matrix
• Flattened the quality control schema, removing the concept of evaluations

Technical improvements

• Re-organized files into components/ folder to clean up code base
• Tests now often use imported examples ensuring the schema content remains valid
• Heavily reduced the use of model_construct() in testing

Full Changelog: v1.4.0...v2.0.0

v.1.4.0

This is the final minor release of aind-data-schema v1.X

What's Changed

• Added optional objects in arena to Session
• Added optional encoder fields to Treadmill
• Removed the restriction on $/. character in GenericModel fields
• Fixed some broken developer functionality in schema bump and model_validate_json

Full Changelog: v1.3.0...v1.4.0

v1.3.0

What's Changed

• CCFStructure now used throughout schema, with backward compatibility
• Improvements to QC documentation
• QCEvaluation now has an evaluated state and a created timestamp
• Model schema for machine learning models
• AwareDatetimeWithDefault used throughout schema
• Conductive lick sensor type
• Writing files larger than 500 KB triggers a warning

Full Changelog: v1.2.0...v1.3.0

v1.2.0

What's Changed

• 1061 refactor core file validators based on aind data schema models expected modalities by @dbirman in #1084
• Add explicit default= for schema_version and describedBy fields by @dbirman in #1102
• Support multi session quality control by tracking metric provenance by @dbirman in #1106
• Add SkipValidation to schema_version by @dbirman in #1116
• feat: adding tag field by @dbirman in #1131
• feat: validate fieldnames in AindGeneric by @helen-m-lin in #1134
• feat: create metadata json from core fields by @helen-m-lin in #1136
• Support modality and stage filters by @dbirman in #1124
• fix: backward compatible refactor "sitmulus_name" in AuditoryStimulation by @dbirman in #1144

Full Changelog: v1.1.1...v1.2.0

v1.1.1

What's Changed

• fix: checks type in rig modality serializer by @mekhlakapoor in #1120

Full Changelog: v1.1.0...v1.1.1