e_model_packager.circuit.bluepy_circuit

Contains circuit reading operations.

Functions

read_circuit(circuit_config_path)

Read the circuit into Bluepy object.

Classes

BluepyCircuit(circuit_config_path)	Wrapper over Bluepy's Circuit class.
CellAttributes(cell)	Cell attributes access class.
EmodelAttributes(emodel)	Emodel attributes of a cell.

class BluepyCircuit(circuit_config_path)

Bases: object

Wrapper over Bluepy’s Circuit class.

Use cached method to read the circuit.

extract_circuit_metype_gids(n_gids)

Extracts the metype gids.

Parameters:

n_gids (int) – Number of gids to be retrieved per metype.

Returns:

Dictionary containing gids per mtype and etype.

get_cell_attributes(gid)

Retrieve the cell attributes from circuit.

Parameters:

gid (int) – cell identifier.

get_emodel_attributes(gid)

Retrieve the emodel attributes of a gid.

Parameters:

gid (int) – cell identifier.

get_gid_from_circuit(mtype, etype, region, gidx)

Returns the circuit gid given the index of cell properties dataframe.

Parameters:

• mtype (str) – morphological type

• etype (str) – electrophysiological type

• region (str) – circuit region

• gidx (int) – index of the bluepy circuit cell ids dataframe

Returns:

The gid from the circuit.

Return type:

int

class CellAttributes(cell)

Bases: object

Cell attributes access class.

Store only attributes of interest.

class EmodelAttributes(emodel)

Bases: object

Emodel attributes of a cell.

Attributes of a gid’s emodel.

read_circuit(circuit_config_path)

Read the circuit into Bluepy object.

Parameters:

circuit_config_path (str) – path to the CircuitConfig.

Returns:

Bluepy’s Circuit object.

Return type:

Object