allensdk.internal.api.queries.biophysical_module_api module

class allensdk.internal.api.queries.biophysical_module_api.BiophysicalModuleApi(base_uri=None)[source]

Bases: allensdk.api.queries.rma_template.RmaTemplate

get_neuronal_model_runs(self, neuronal_model_run_ids=None)[source]

List Neuronal Model Rusn available through LIMS with associated info needed to run in NEURON.

Parameters:
neuronal_model_run_ids : integer or list of integers, optional

only select specific neuronal_model_runs.

Returns:
dict : neuronal model run metadata
get_neuronal_models(self, neuronal_model_ids=None)[source]

List Neuronal Models available through LIMS with associated info needed to run in NEURON.

Parameters:
neuronal_model_ids : integer or list of integers, optional

only select specific neuronal_models.

Returns:
dict : neuronal model metadata
rma_templates = {'biophysical_lims_queries': [{'name': 'neuronal_model_runs_by_ids', 'description': 'see name', 'model': 'NeuronalModelRun', 'criteria': '[id$in{{ neuronal_model_run_ids }}]', 'include': 'well_known_files(well_known_file_type),neuronal_model(well_known_files(well_known_file_type),specimen(project,specimen_tags,ephys_roi_result(ephys_qc_criteria,well_known_files(well_known_file_type)),neuron_reconstructions(well_known_files(well_known_file_type)),ephys_sweeps(ephys_sweep_tags,ephys_stimulus(ephys_stimulus_type))),neuronal_model_template(neuronal_model_template_type,well_known_files(well_known_file_type)))', 'num_rows': 'all', 'count': False, 'criteria_params': ['neuronal_model_run_ids']}, {'name': 'neuronal_models_by_ids', 'description': 'see name', 'model': 'NeuronalModel', 'criteria': '[id$in{{ neuronal_model_ids }}]', 'include': 'well_known_files(well_known_file_type),specimen(project,specimen_tags,ephys_roi_result(ephys_qc_criteria,well_known_files(well_known_file_type)),neuron_reconstructions(well_known_files(well_known_file_type)),ephys_sweeps(ephys_sweep_tags,ephys_stimulus(ephys_stimulus_type))),neuronal_model_template(neuronal_model_template_type,well_known_files(well_known_file_type))', 'num_rows': 'all', 'count': False, 'criteria_params': ['neuronal_model_ids']}]}