Merge pull request #1749 from AllenInstitute/bugfix-LIMS_jobID_105618…

…8052

WriteNWB Needs to be used by non-mesoscope data

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.3.1] = 2020-10-13
+
+### Bug Fixes
+- (Internal) Fixed a write_nwb bug for behavior ophys experiments involving the BehaviorOphysJsonApi expecting a mesoscope-specific method.
+
 ## [2.3.0] = 2020-10-09
 
 ### Added

allensdk/__init__.py

@@ -37,7 +37,7 @@
 
 
 
-__version__ = '2.3.0'
+__version__ = '2.3.1'
 
 
 try:

allensdk/brain_observatory/behavior/write_nwb/__main__.py

@@ -16,6 +16,9 @@
 
 
 class BehaviorOphysJsonApi(BehaviorOphysLimsApi):
+    """
+        This class is used by both Scientifica and Mesoscope ophys experiments.
+    """
 
     def __init__(self, data):
         self.data = data
@@ -96,7 +99,12 @@ def get_external_specimen_name(self):
         return self.data['external_specimen_name']
 
     def get_imaging_plane_group(self):
-        return self.data["imaging_plane_group"]
+        try:
+            # Will only contain the "imaging_plane_group" key if we are
+            # dealing with Mesoscope data
+            return self.data["imaging_plane_group"]
+        except KeyError:
+            return None
 
 
 def write_behavior_ophys_nwb(session_data, nwb_filepath):
@@ -120,7 +128,6 @@ def write_behavior_ophys_nwb(session_data, nwb_filepath):
         raise e
 
 
-
 def main():
 
     logging.basicConfig(format='%(asctime)s - %(process)s - %(levelname)s - %(message)s')

doc_template/index.rst

@@ -91,6 +91,12 @@ The Allen SDK provides Python code for accessing experimental metadata along wit
 See the `mouse connectivity section <connectivity.html>`_ for more details.
 
 
+What's New - 2.3.1 (October 13, 2020)
+-----------------------------------------------------------------------
+As of the 2.3.1 release:
+
+- (Internal) Fixed a write_nwb bug for behavior ophys experiments involving the BehaviorOphysJsonApi expecting a mesoscope-specific method.
+
 What's New - 2.3.0 (October 9, 2020)
 -----------------------------------------------------------------------
 As of the 2.3.0 release: