Modern reorgnizations

.github/workflows/deploy_tests_on_pull_request.yml

@@ -9,4 +9,4 @@ concurrency:  # Cancel previous workflows on the same pull request
 
 jobs:
   TestInstallation:
-    uses: ./.github/workflows/installation.yml
+    uses: ./.github/workflows/test_installation.yml

.github/workflows/installation.yml → .github/workflows/test_installation.yml

@@ -35,5 +35,8 @@ jobs:
       - name: Test import
         run: python -c "import ibl_to_nwb"
 
-      - name: Test import
-        run: python -c "import ibl_to_nwb.brainwide_map"
+      - name: Test data interface imports
+        run: python -c "import ibl_to_nwb.datainterfaces"
+
+      - name: Test converters imports
+        run: python -c "import ibl_to_nwb.converters"

pyproject.toml

@@ -21,6 +21,8 @@ license = {file = "license.txt"}
 requires-python = ">=3.9"
 dependencies = [
     "neuroconv",
+    "spikeinterface",
+    "probeinterface",
     "ndx-pose>=0.1.1",
     "ndx-ibl==0.1.0",
     "ONE-api",

src/ibl_to_nwb/converters/__init__.py

@@ -0,0 +1,7 @@
+from ._brainwide_map_converter import BrainwideMapConverter
+from ._iblconverter import IblConverter
+
+__all__ = [
+    "BrainwideMapConverter",
+    "IblConverter",
+]

src/ibl_to_nwb/brainwide_map/brainwidemapconverter.py → src/ibl_to_nwb/converters/_brainwide_map_converter.py

@@ -2,14 +2,14 @@
 
 from neuroconv.utils import dict_deep_update, load_dict_from_file
 
-from ..iblconverter import IblConverter
+from src.ibl_to_nwb.converters._iblconverter import IblConverter
 
 
 class BrainwideMapConverter(IblConverter):
     def get_metadata(self) -> dict:
         metadata = super().get_metadata()
 
-        experiment_metadata = load_dict_from_file(file_path=Path(__file__).parent / "brainwide_map_metadata.yml")
+        experiment_metadata = load_dict_from_file(file_path=Path(__file__).parent / "brainwide_map_general.yml")
         metadata = dict_deep_update(metadata, experiment_metadata)
 
         return metadata

src/ibl_to_nwb/datainterfaces/__init__.py

@@ -1,8 +1,20 @@
-from .iblposeestimationinterface import IblPoseEstimationInterface
-from .iblsortingextractor import IblSortingExtractor
-from .iblsortinginterface import IblSortingInterface
-from .iblstreaminginterface import IblStreamingApInterface, IblStreamingLfInterface
-from .lickinterface import LickInterface
-from .pupiltrackinginterface import PupilTrackingInterface
-from .roimotionenergyinterface import RoiMotionEnergyInterface
-from .wheelinterface import WheelInterface
+from ._pose_estimation import IblPoseEstimationInterface
+from ._ibl_sorting_extractor import IblSortingExtractor
+from ._ibl_sorting_interface import IblSortingInterface
+from ._ibl_streaming_interface import IblStreamingApInterface, IblStreamingLfInterface
+from ._lick_times import LickInterface
+from ._pupil_tracking import PupilTrackingInterface
+from ._roi_motion_energy import RoiMotionEnergyInterface
+from ._wheel_movement import WheelInterface
+
+__all__ = [
+    "IblPoseEstimationInterface",
+    "IblSortingExtractor",
+    "IblSortingInterface",
+    "IblStreamingApInterface",
+    "IblStreamingLfInterface",
+    "LickInterface",
+    "PupilTrackingInterface",
+    "RoiMotionEnergyInterface",
+    "WheelInterface",
+]

src/ibl_to_nwb/brainwide_map/datainterfaces/brainwidemaptrialsinterface.py → src/ibl_to_nwb/datainterfaces/_brainwide_map_trials.py

@@ -15,7 +15,7 @@ def __init__(self, one: ONE, session: str):
 
     def get_metadata(self) -> dict:
         metadata = super().get_metadata()
-        trial_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "metadata" / "trials.yml")
+        trial_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "_metadata" / "trials.yml")
         metadata.update(trial_metadata)
         return metadata
 

src/ibl_to_nwb/datainterfaces/iblsortinginterface.py → src/ibl_to_nwb/datainterfaces/_ibl_sorting_interface.py

@@ -7,7 +7,7 @@
 )
 from neuroconv.utils import load_dict_from_file
 
-from .iblsortingextractor import IblSortingExtractor
+from ._ibl_sorting_extractor import IblSortingExtractor
 
 
 class IblSortingInterface(BaseSortingExtractorInterface):
@@ -16,7 +16,7 @@ class IblSortingInterface(BaseSortingExtractorInterface):
     def get_metadata(self) -> dict:
         metadata = super().get_metadata()
 
-        ecephys_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "metadata" / "ecephys.yml")
+        ecephys_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "_metadata" / "ecephys.yml")
 
         metadata.update(Ecephys=dict())
         metadata["Ecephys"].update(UnitProperties=ecephys_metadata["Ecephys"]["UnitProperties"])

src/ibl_to_nwb/datainterfaces/iblstreaminginterface.py → src/ibl_to_nwb/datainterfaces/_ibl_streaming_interface.py

@@ -104,7 +104,7 @@ def get_metadata_schema(self) -> dict:
     def get_metadata(self) -> dict:
         metadata = super().get_metadata()
 
-        ecephys_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "metadata" / "ecephys.yml")
+        ecephys_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "_metadata" / "ecephys.yml")
 
         metadata["Ecephys"].update({self.es_key: ecephys_metadata["Ecephys"]["ElectricalSeriesAp"]})
         if len(self.available_streams) > 1:
@@ -176,7 +176,7 @@ def get_metadata(self) -> dict:
         metadata = super().get_metadata()
         metadata["Ecephys"].pop("ElectrodeGroup")
 
-        ecephys_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "metadata" / "ecephys.yml")
+        ecephys_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "_metadata" / "ecephys.yml")
 
         metadata["Ecephys"].update({self.es_key: ecephys_metadata["Ecephys"]["ElectricalSeriesLf"]})
         if len(self.available_streams) > 1:

src/ibl_to_nwb/datainterfaces/pupiltrackinginterface.py → src/ibl_to_nwb/datainterfaces/_pupil_tracking.py

@@ -20,7 +20,7 @@ def __init__(self, one: ONE, session: str, camera_name: str):
     def get_metadata(self) -> dict:
         metadata = super().get_metadata()
 
-        pupils_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "metadata" / "pupils.yml")
+        pupils_metadata = load_dict_from_file(file_path=Path(__file__).parent.parent / "_metadata" / "pupils.yml")
         metadata.update(pupils_metadata)
 
         return metadata

src/ibl_to_nwb/datainterfaces/wheelinterface.py → src/ibl_to_nwb/datainterfaces/_wheel_movement.py

@@ -18,7 +18,7 @@ def __init__(self, one: ONE, session: str):
     def get_metadata(self) -> dict:
         metadata = super().get_metadata()
 
-        metadata.update(load_dict_from_file(file_path=Path(__file__).parent.parent / "metadata" / "wheel.yml"))
+        metadata.update(load_dict_from_file(file_path=Path(__file__).parent.parent / "_metadata" / "wheel.yml"))
 
         return metadata