add public generate_channels_by_location function

Author: anilbey

bluepyopt/ephys/create_hoc.py

@@ -49,6 +49,19 @@
     'myelinated']
 
 
+def generate_channels_by_location(mechs, location_order):
+    """Create a OrderedDictionary of all channel mechs for hoc template.
+
+    Args:
+        mechs (list of bluepyopt.ephys.mechanisms.Mechanism): mechanisms
+        location_order (list of str): order of locations
+
+    Returns: tuple of channels, point_channels and location order
+    """
+    loc_desc = _loc_desc
+    return _generate_channels_by_location(mechs, location_order, loc_desc)
+
+
 def _generate_channels_by_location(mechs, location_order, loc_desc):
     """Create a OrderedDictionary of all channel mechs for hoc template."""
     channels = OrderedDict((location, []) for location in location_order)

bluepyopt/tests/test_ephys/test_create_hoc.py

@@ -20,6 +20,19 @@
     'myelinated']
 
 
+@pytest.mark.unit
+def test_generate_channels_by_location():
+    """ephys.create_hoc: Test generate_channels_by_location"""
+    mech = utils.make_mech()
+    public_res = create_hoc.generate_channels_by_location(
+        [mech], DEFAULT_LOCATION_ORDER,
+    )
+    private_res = create_hoc._generate_channels_by_location(
+        [mech], DEFAULT_LOCATION_ORDER, create_hoc._loc_desc
+    )
+    assert public_res == private_res
+
+
 @pytest.mark.unit
 def test__generate_channels_by_location():
     """ephys.create_hoc: Test _generate_channels_by_location"""