Merge pull request #45 from int-brain-lab/feat/reward_amount_nate

added `--reward_amount_ul` parameter for `nate_optoBiasedChoiceWorld`

Author: bimac

iblrig_custom_tasks/nate_optoBiasedChoiceWorld/task.py

@@ -85,6 +85,7 @@ def __init__(
         mask_ttl_states: list[str] = DEFAULTS['MASK_TTL_STATES'],
         use_zapit: bool = DEFAULTS['USE_ZAPIT'],
         stim_reverse: float = DEFAULTS['STIM_REVERSE'],
+        reward_amount_ul: float = DEFAULTS['REWARD_AMOUNT_UL'],
         **kwargs,
     ):
         super().__init__(*args, **kwargs)
@@ -94,6 +95,7 @@ def __init__(
         self.task_params['MASK_TTL_STATES'] = mask_ttl_states
         self.task_params['PROBABILITY_OPTO_STIM'] = probability_opto_stim
         self.task_params['STIM_REVERSE'] = stim_reverse
+        self.task_params['REWARD_AMOUNT_UL'] = reward_amount_ul
         self.task_params['USE_ZAPIT'] = use_zapit
         self.current_location_idx = None
         self.num_cond = None
@@ -169,6 +171,14 @@ def extra_parser():
             type=float,
             help=f'probability of opto-genetic stimulation (default: {DEFAULTS["PROBABILITY_OPTO_STIM"]})',
         )
+        parser.add_argument(
+            '--reward_amount_ul',
+            option_strings=['--reward_amount_ul'],
+            dest='reward_amount_ul',
+            default=DEFAULTS['REWARD_AMOUNT_UL'],
+            type=float,
+            help=f'reward amount, ul (default: {DEFAULTS["REWARD_AMOUNT_UL"]})',
+        )
         parser.add_argument(
             '--contrast_set_probability_type',
             option_strings=['--contrast_set_probability_type'],

iblrig_custom_tasks/nate_optoBiasedChoiceWorld/task_parameters.yaml

@@ -22,4 +22,5 @@
   - reward
 'PROBABILITY_OPTO_STIM': 0.2  # probability of optogenetic stimulation
 'STIM_REVERSE': False
-'USE_ZAPIT': False
+'USE_ZAPIT': False
+'REWARD_AMOUNT_UL': 1.5

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "project_extraction"
-version         = "0.8.4"
+version         = "0.8.5"
 description     = "Custom extractors for satellite tasks"
 dynamic         = [ "readme" ]
 keywords        = [ "IBL", "neuro-science" ]