[DRAFT] Initial commit ICMS

.gitignore

@@ -7,3 +7,4 @@ build
 cover
 .coverage
 AGENTS.md
+.DS_Store

mozaik/experiments/microstimulation.py

@@ -0,0 +1,58 @@
+from parameters import ParameterSet
+from collections import OrderedDict
+from copy import deepcopy
+
+from mozaik.experiments import Experiment
+from mozaik.stimuli import InternalStimulus
+from mozaik.tools.distribution_parametrization import MozaikExtendedParameterSet
+from mozaik.sheets.direct_stimulator import IntraCorticalMicroStimulation
+
+
+class IntraCorticalMicroStimulationStimulus(Experiment):
+    """
+
+    Parameters
+    ----------
+    model : Model
+          The model on which to execute the experiment.
+
+    Other parameters
+    ----------------
+
+    duration : float
+                Duration of the microstimulation.
+
+    sheet_list : int
+                The list of sheets in which to do stimulation.
+
+    stimulator_parameters: ParameterSet
+                See class IntraCorticalMicroStimulation in direct_stimulator.py
+    """
+
+    required_parameters = ParameterSet({
+        'duration': float,
+        'sheet_list': list,
+        "stimulator_parameters": ParameterSet,
+    })
+
+    def __init__(self, model, parameters):
+        Experiment.__init__(self, model, parameters)
+
+        stimulators = OrderedDict()
+        for sheet in parameters.sheet_list:
+            _params = MozaikExtendedParameterSet(deepcopy(parameters))
+            stimulators[sheet] = [
+                IntraCorticalMicroStimulation(model.sheets[sheet], _params.stimulator_parameters)
+            ]
+        self.direct_stimulation = [stimulators]
+
+        _params = MozaikExtendedParameterSet(deepcopy(parameters))
+        self.stimuli.append(
+            InternalStimulus(
+                frame_duration=_params.duration, 
+                duration=_params.duration,
+                trial=0,
+                direct_stimulation_name='IntraCorticalMicroStimulation',
+                direct_stimulation_parameters=_params.stimulator_parameters
+            )
+        )

mozaik/sheets/__init__.py

@@ -294,6 +294,11 @@ def get_data(self, stimulus_duration=None):
 
         """
 
+        # I am not sure I understand the implication of the new version of the present function
+        # For the ICMS paper I need a to record arbitrary signals. For example, here is what I usually record:
+        # block = self.pop.get_data(['spikes', 'v', 'g_exc', 'g_inh', 'gsyn_inh_a', 'gsyn_inh_b', 'gsyn_exc', 'gsyn_inh', 'k_trace', 'w'], clear=True)
+        # How should I modify the following code to achieve that ?
+
         if self.parameters.cell.native_nest:
             vm_name = ['V_m']
         else:
@@ -307,7 +312,7 @@ def get_data(self, stimulus_duration=None):
             gsyn_names = ['g_ex', 'g_in']
         else: 
             gsyn_names = ['gsyn_exc', 'gsyn_inh']
-            
+
         block = None
         steps = self.model.parameters.steps_get_data 
         if steps: