Skip to content

Commit 9de501d

Browse files
dbirmandbirman
authored
Merge pull request #1569 from AllenNeuralDynamics/release-v2.0.2
chore: release v2.0.2
2 parents d3862f4 + c41d7db commit 9de501d

29 files changed

+541
-160
lines changed

‎docs/source/components/devices.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Named input or output channel on a DAQ device
179179
| `channel_name` | `str` | |
180180
| `channel_type` | [DaqChannelType](../aind_data_schema_models/devices.md#daqchanneltype) | |
181181
| `port` | `Optional[int]` | |
182-
| `channel_index` | `Optional[int]` | |
182+
| <del>`channel_index`</del> | `Optional[int]` | **[DEPRECATED]** Use DAQChannel.port instead. |
183183
| `sample_rate` | `Optional[decimal.Decimal]` | |
184184
| `sample_rate_unit` | Optional[[FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit)] | |
185185
| `event_based_sampling` | `Optional[bool]` | |

‎docs/source/components/stimulus.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
## Model definitions
44

5+
### AuditoryStimulation
6+
7+
Description of an auditory stimulus
8+
9+
| Field | Type | Description |
10+
|-------|------|-------------|
11+
| `stimulus_name` | `str` | |
12+
| `sample_frequency` | `decimal.Decimal` | |
13+
| `amplitude_modulation_frequency` | `Optional[int]` | |
14+
| `frequency_unit` | [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) | |
15+
| `bandpass_low_frequency` | `Optional[decimal.Decimal]` | |
16+
| `bandpass_high_frequency` | `Optional[decimal.Decimal]` | |
17+
| `bandpass_filter_type` | Optional[[FilterType](../aind_data_schema_models/devices.md#filtertype)] | |
18+
| `bandpass_order` | `Optional[int]` | |
19+
| `notes` | `Optional[str]` | |
20+
21+
522
### FilterType
623

724
Types of bandpass filters for auditory stim
@@ -25,6 +42,56 @@ Description of olfactometer channel configurations
2542
| `notes` | `Optional[str]` | |
2643

2744

45+
### OlfactoryStimulation
46+
47+
Description of a olfactory stimulus
48+
49+
| Field | Type | Description |
50+
|-------|------|-------------|
51+
| `stimulus_name` | `str` | |
52+
| `channels` | List[[OlfactometerChannelConfig](#olfactometerchannelconfig)] | |
53+
| `notes` | `Optional[str]` | |
54+
55+
56+
### OptoStimulation
57+
58+
Description of opto stimulation parameters
59+
60+
| Field | Type | Description |
61+
|-------|------|-------------|
62+
| `stimulus_name` | `str` | |
63+
| `pulse_shape` | [PulseShape](#pulseshape) | |
64+
| `pulse_frequency` | `List[decimal.Decimal]` | |
65+
| `pulse_frequency_unit` | [FrequencyUnit](../aind_data_schema_models/units.md#frequencyunit) | |
66+
| `number_pulse_trains` | `List[int]` | |
67+
| `pulse_width` | `List[int]` | |
68+
| `pulse_width_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | |
69+
| `pulse_train_duration` | `List[decimal.Decimal]` | |
70+
| `pulse_train_duration_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | |
71+
| `fixed_pulse_train_interval` | `bool` | |
72+
| `pulse_train_interval` | `Optional[decimal.Decimal]` | Time between pulse trains |
73+
| `pulse_train_interval_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | |
74+
| `baseline_duration` | `decimal.Decimal` | Duration of baseline recording prior to first pulse train |
75+
| `baseline_duration_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | |
76+
| `other_parameters` | `dict` | |
77+
| `notes` | `Optional[str]` | |
78+
79+
80+
### PhotoStimulation
81+
82+
Description of a photostimulation acquisition
83+
84+
| Field | Type | Description |
85+
|-------|------|-------------|
86+
| `stimulus_name` | `str` | |
87+
| `number_groups` | `int` | |
88+
| `groups` | List[[PhotoStimulationGroup](#photostimulationgroup)] | |
89+
| `inter_trial_interval` | `decimal.Decimal` | |
90+
| `inter_trial_interval_unit` | [TimeUnit](../aind_data_schema_models/units.md#timeunit) | |
91+
| `other_parameters` | `dict` | |
92+
| `notes` | `Optional[str]` | |
93+
94+
2895
### PhotoStimulationGroup
2996

3097
Description of a photostimulation group
@@ -56,3 +123,15 @@ Types of Opto stim pulse shapes
56123
| `SINE` | `Sinusoidal` |
57124

58125

126+
### VisualStimulation
127+
128+
Description of visual stimulus parameters. Provides a high level description of stimulus.
129+
130+
| Field | Type | Description |
131+
|-------|------|-------------|
132+
| `stimulus_name` | `str` | |
133+
| `stimulus_parameters` | `dict` | Define and list the parameter values used (e.g. all TF or orientation values) |
134+
| `stimulus_template_name` | `List[str]` | Name of image set or movie displayed |
135+
| `notes` | `Optional[str]` | |
136+
137+

‎docs/source/data_description.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Description of a logical collection of data files
3636
| `project_name` | `str` | A name for a set of coordinated activities intended to achieve one or more objectives. |
3737
| `restrictions` | `Optional[str]` | Detail any restrictions on publishing or sharing these data |
3838
| `modalities` | List[[Modality](aind_data_schema_models/modalities.md#modality)] | A short name for the specific manner, characteristic, pattern of application, or the employment of any technology or formal procedure to generate data for a study |
39+
| `source_data` | `Optional[List[str]]` | For derived assets, list the source data asset names used to create this data |
3940
| `data_summary` | `Optional[str]` | Semantic summary of experimental goal |
4041

4142

‎docs/source/model.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Description of model evaluation
4343
| `experimenters` | `List[str]` | People responsible for processing |
4444
| `pipeline_name` | `Optional[str]` | Pipeline names must exist in Processing.pipelines |
4545
| `start_date_time` | `datetime (timezone-aware)` | |
46-
| `end_date_time` | `datetime (timezone-aware)` | |
46+
| `end_date_time` | `Optional[datetime (timezone-aware)]` | |
4747
| `output_path` | `Optional[AssetPath]` | Path to processing outputs, if stored. |
4848
| `output_parameters` | `dict` | Output parameters |
4949
| `notes` | `Optional[str]` | |
@@ -75,7 +75,7 @@ Description of model training
7575
| `experimenters` | `List[str]` | People responsible for processing |
7676
| `pipeline_name` | `Optional[str]` | Pipeline names must exist in Processing.pipelines |
7777
| `start_date_time` | `datetime (timezone-aware)` | |
78-
| `end_date_time` | `datetime (timezone-aware)` | |
78+
| `end_date_time` | `Optional[datetime (timezone-aware)]` | |
7979
| `output_path` | `Optional[AssetPath]` | Path to processing outputs, if stored. |
8080
| `output_parameters` | `dict` | Output parameters |
8181
| `notes` | `Optional[str]` | |

‎docs/source/processing.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Description of all processes run on data
2424
| `data_processes` | List[[DataProcess](processing.md#dataprocess)] | |
2525
| `pipelines` | Optional[List[[Code](components/identifiers.md#code)]] | For processing done with pipelines, list the repositories here. Pipelines must use the name field ,and be referenced in the pipeline_name field of a DataProcess. |
2626
| `notes` | `Optional[str]` | |
27-
| `dependency_graph` | `Dict[str, List[str]]` | Directed graph of processing step dependencies. Each key is a process name, and the value is a list of process names that are inputs to that process. |
27+
| `dependency_graph` | `Optional[Dict[str, List[str]]]` | Directed graph of processing step dependencies. Each key is a process name, and the value is a list of process names that are inputs to that process. |
2828

2929

3030
## Model definitions
@@ -42,7 +42,7 @@ Description of a single processing step
4242
| `experimenters` | `List[str]` | People responsible for processing |
4343
| `pipeline_name` | `Optional[str]` | Pipeline names must exist in Processing.pipelines |
4444
| `start_date_time` | `datetime (timezone-aware)` | |
45-
| `end_date_time` | `datetime (timezone-aware)` | |
45+
| `end_date_time` | `Optional[datetime (timezone-aware)]` | |
4646
| `output_path` | `Optional[AssetPath]` | Path to processing outputs, if stored. |
4747
| `output_parameters` | `dict` | Output parameters |
4848
| `notes` | `Optional[str]` | |

‎examples/multiplane_ophys_instrument.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,6 @@
337337
channel_name="P0.3",
338338
channel_type=DaqChannelType.DI,
339339
port=0,
340-
channel_index=3,
341340
sample_rate=100.0,
342341
sample_rate_unit=FrequencyUnit.KHZ,
343342
)

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ readme = "README.md"
1414
dynamic = ["version"]
1515

1616
dependencies = [
17-
'aind-data-schema-models>=4.2.7',
17+
'aind-data-schema-models>=4.2.11',
1818
'pydantic>=2.7',
1919
'semver'
2020
]

‎schemas/acquisition_schema.json‎

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1365,6 +1365,7 @@
13651365
"items": {
13661366
"discriminator": {
13671367
"mapping": {
1368+
"EM": "#/$defs/_Em",
13681369
"EMG": "#/$defs/_Emg",
13691370
"ISI": "#/$defs/_Isi",
13701371
"MRI": "#/$defs/_Mri",
@@ -1400,6 +1401,9 @@
14001401
{
14011402
"$ref": "#/$defs/_Emg"
14021403
},
1404+
{
1405+
"$ref": "#/$defs/_Em"
1406+
},
14031407
{
14041408
"$ref": "#/$defs/_Ecephys"
14051409
},
@@ -1588,7 +1592,7 @@
15881592
"type": "string"
15891593
},
15901594
"exposure_time": {
1591-
"title": "Exposure time (ms)",
1595+
"title": "Exposure time",
15921596
"type": "number"
15931597
},
15941598
"exposure_time_unit": {
@@ -2714,13 +2718,14 @@
27142718
"Origin",
27152719
"Bregma",
27162720
"Lambda",
2717-
"C1",
2718-
"C2",
2719-
"C3",
2720-
"C4",
2721-
"C5",
2722-
"C6",
2723-
"C7",
2721+
"Between_C1-C2",
2722+
"Between_C2-C3",
2723+
"Between_C3-C4",
2724+
"Between_C4-C5",
2725+
"Between_C6-C7",
2726+
"Between_C7-C8",
2727+
"Between_C8-T1",
2728+
"Between_T1-T2",
27242729
"Tip",
27252730
"Front_center",
27262731
"Arena_center",
@@ -6286,6 +6291,26 @@
62866291
"title": "_Edmund_Optics",
62876292
"type": "object"
62886293
},
6294+
"_Em": {
6295+
"additionalProperties": false,
6296+
"description": "Model EM",
6297+
"properties": {
6298+
"name": {
6299+
"const": "Electron microscopy",
6300+
"default": "Electron microscopy",
6301+
"title": "Name",
6302+
"type": "string"
6303+
},
6304+
"abbreviation": {
6305+
"const": "EM",
6306+
"default": "EM",
6307+
"title": "Abbreviation",
6308+
"type": "string"
6309+
}
6310+
},
6311+
"title": "_Em",
6312+
"type": "object"
6313+
},
62896314
"_Emg": {
62906315
"additionalProperties": false,
62916316
"description": "Model EMG",
@@ -9757,8 +9782,8 @@
97579782
"type": "string"
97589783
},
97599784
"schema_version": {
9760-
"const": "2.0.35",
9761-
"default": "2.0.35",
9785+
"const": "2.0.36",
9786+
"default": "2.0.36",
97629787
"title": "Schema Version",
97639788
"type": "string"
97649789
},

‎schemas/data_description_schema.json‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,26 @@
527527
"title": "_Ecephys",
528528
"type": "object"
529529
},
530+
"_Em": {
531+
"additionalProperties": false,
532+
"description": "Model EM",
533+
"properties": {
534+
"name": {
535+
"const": "Electron microscopy",
536+
"default": "Electron microscopy",
537+
"title": "Name",
538+
"type": "string"
539+
},
540+
"abbreviation": {
541+
"const": "EM",
542+
"default": "EM",
543+
"title": "Abbreviation",
544+
"type": "string"
545+
}
546+
},
547+
"title": "_Em",
548+
"type": "object"
549+
},
530550
"_Emg": {
531551
"additionalProperties": false,
532552
"description": "Model EMG",
@@ -1478,8 +1498,8 @@
14781498
"type": "string"
14791499
},
14801500
"schema_version": {
1481-
"const": "2.1.0",
1482-
"default": "2.1.0",
1501+
"const": "2.1.1",
1502+
"default": "2.1.1",
14831503
"title": "Schema Version",
14841504
"type": "string"
14851505
},
@@ -1663,6 +1683,7 @@
16631683
"items": {
16641684
"discriminator": {
16651685
"mapping": {
1686+
"EM": "#/$defs/_Em",
16661687
"EMG": "#/$defs/_Emg",
16671688
"ISI": "#/$defs/_Isi",
16681689
"MRI": "#/$defs/_Mri",
@@ -1698,6 +1719,9 @@
16981719
{
16991720
"$ref": "#/$defs/_Emg"
17001721
},
1722+
{
1723+
"$ref": "#/$defs/_Em"
1724+
},
17011725
{
17021726
"$ref": "#/$defs/_Ecephys"
17031727
},

‎schemas/instrument_schema.json‎

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3206,6 +3206,7 @@
32063206
}
32073207
],
32083208
"default": null,
3209+
"deprecated": true,
32093210
"title": "DAQ channel index"
32103211
},
32113212
"sample_rate": {
@@ -13431,13 +13432,14 @@
1343113432
"Origin",
1343213433
"Bregma",
1343313434
"Lambda",
13434-
"C1",
13435-
"C2",
13436-
"C3",
13437-
"C4",
13438-
"C5",
13439-
"C6",
13440-
"C7",
13435+
"Between_C1-C2",
13436+
"Between_C2-C3",
13437+
"Between_C3-C4",
13438+
"Between_C4-C5",
13439+
"Between_C6-C7",
13440+
"Between_C7-C8",
13441+
"Between_C8-T1",
13442+
"Between_T1-T2",
1344113443
"Tip",
1344213444
"Front_center",
1344313445
"Arena_center",
@@ -19648,6 +19650,26 @@
1964819650
"title": "_Edmund_Optics",
1964919651
"type": "object"
1965019652
},
19653+
"_Em": {
19654+
"additionalProperties": false,
19655+
"description": "Model EM",
19656+
"properties": {
19657+
"name": {
19658+
"const": "Electron microscopy",
19659+
"default": "Electron microscopy",
19660+
"title": "Name",
19661+
"type": "string"
19662+
},
19663+
"abbreviation": {
19664+
"const": "EM",
19665+
"default": "EM",
19666+
"title": "Abbreviation",
19667+
"type": "string"
19668+
}
19669+
},
19670+
"title": "_Em",
19671+
"type": "object"
19672+
},
1965119673
"_Emg": {
1965219674
"additionalProperties": false,
1965319675
"description": "Model EMG",
@@ -23766,8 +23788,8 @@
2376623788
"type": "string"
2376723789
},
2376823790
"schema_version": {
23769-
"const": "2.0.39",
23770-
"default": "2.0.39",
23791+
"const": "2.0.40",
23792+
"default": "2.0.40",
2377123793
"title": "Schema Version",
2377223794
"type": "string"
2377323795
},
@@ -23800,6 +23822,7 @@
2380023822
"items": {
2380123823
"discriminator": {
2380223824
"mapping": {
23825+
"EM": "#/$defs/_Em",
2380323826
"EMG": "#/$defs/_Emg",
2380423827
"ISI": "#/$defs/_Isi",
2380523828
"MRI": "#/$defs/_Mri",
@@ -23835,6 +23858,9 @@
2383523858
{
2383623859
"$ref": "#/$defs/_Emg"
2383723860
},
23861+
{
23862+
"$ref": "#/$defs/_Em"
23863+
},
2383823864
{
2383923865
"$ref": "#/$defs/_Ecephys"
2384023866
},

0 commit comments

Comments
 (0)