simrun ❭ sim_trial_to_cell_object ❭ trial_to_cell_object
trial_to_cell_object¶
-
simrun.sim_trial_to_cell_object.trial_to_cell_object(name=
None, cellName=None, networkName=None, synapse_activation_file=None, range_vars=None, scale_apical=None, allPoints=False, compute=True, tStop=345, neuron_param_modify_functions=[], network_param_modify_functions=[], synapse_activation_modify_functions=[], additional_network_params=[])¶ Recreate and resimulate a single simulation trial from parameter files and return the cell object.
This method also provides functionality to adapt the parameters of the cell, network, and synapse activation data before resimulating the trial. The network and neuron parameter modify functions should take the respective parameter dictionaries as input and return the modified dictionaries. Synapse activation modify functions should take the synapse activation data as input and return the modified data.
- Parameters:¶
cellName (str) – Name of the Cell parameters file.
networkName (str) – Name of the Network parameters file.
synapse_activation_file (str | pandas.DataFrame) – Path to the Synapse activation file or a pandas DataFrame containing the synapse activation data.
range_vars (str | list) – Range variables to record.
scale_apical (callable, DEPRECATED) – Function to scale the apical dendrites.
allPoints (bool) – If True, skip \(d-\lambda\) segmentation and simulate at high resolution.
compute (bool) – If True, compute the simulation. Otherwise return the simulation-ready
Cellobject.tStop (float) – Stop time of the simulation.
neuron_param_modify_functions (list) – List of functions to modify the neuron parameters.
network_param_modify_functions (list) – List of functions to modify the network parameters.
synapse_activation_modify_functions (list) – List of functions to modify the synapse activation data.
Deprecated since version 0.1.0: The scale_apical argument is deprecated and will be removed in a future version. Use the cell_modify_functions key in the Cell parameters file instead.