gridcell deprecation warning

Author: TomGeorge1234

ratinabox/Neurons.py

@@ -858,6 +858,8 @@ class GridCells(Neurons):
 
     GridCells defines a set of 'n' grid cells with random orientations, grid scales and offsets (these can be set non-randomly of course). Grids are modelled as the rectified sum of three cosine waves at 60 degrees to each other.
 
+    To initialise grid cells you specify three things: (i) params['gridscale'], (ii) params['orientation'] and (iii) params['phase_offset']. These are all sampled from a distribution (specified as, e.g. params['phase_offset_distribution']) and then used to calculate the firing rate of each grid cell. For each of these there quantities the value you specify parameterises the distribution from which it is sampled. For example params['gridscale':0.45,'gridscale_distribution':'uniform'] will pull gridscales from a uniform distribution between 0 and 0.45m. The 'delta' distribution means a constant will be taken. For all three of these you can optionally just pass an array of length GridCells.n (in which case the corresponding distribution parameter is ignored). This array is set a the value for each grid cell.
+
     List of functions:
         • get_state()
         • set_phase_offsets()
@@ -879,7 +881,7 @@ class GridCells(Neurons):
 
     default_params = {
         "n": 10,
-        "gridscale": 0.45, 
+        "gridscale": 0.50, 
         "gridscale_distribution": "rayleigh",
         "orientation": None, 
         "orientation_distribution": "uniform",
@@ -901,7 +903,10 @@ def __init__(self, Agent, params={}):
         self.params = copy.deepcopy(__class__.default_params)
         self.params.update(params)
 
-        
+        # deprecation warnings
+        if ("random_gridscales" in self.params) or ("random_orientations" in self.params) or ("random_phase_offsets" in self.params):
+            warnings.warn("the GridCell API has changed slightly, 'random_gridscales', 'random_orientations' and 'random_phase_offsets' are no longer accepted as parameters. Please use 'gridscale','gridscale_distribution','orientation','orientation_distribution','phase_offset' and 'phase_offset_distribution' instead. See docstring or 1.7.0 release notes for instructions.")
+
         # Initialise the gridscales
         if hasattr(self.params["gridscale"],"__len__"):
             self.gridscales = np.array(self.params["gridscale"])