Skip to content

Commit

Permalink
Update cell.rst (#2318)
Browse files Browse the repository at this point in the history
<!-- Please make sure your PR follows our [contribution
guidelines](https://github.com/arbor-sim/arbor/tree/master/doc/contrib)
and agree to the terms outlined in the [PR
procedure](https://github.com/arbor-sim/arbor/tree/master/doc/contrib/pr.rst).
-->

---------

Co-authored-by: Thorsten Hater <[email protected]>
  • Loading branch information
ErbB4 and thorstenhater authored Jul 30, 2024
1 parent e09c69a commit 5dfba2f
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions doc/concepts/cell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Cells interact with each other via spike exchange and gap junctions.
============================= =========================================== ===========================================================
.. generic:: gid integral The unique global identifier of a cell.
.. generic:: tag string The label of a group of items in a cell-local collection.
For example the synapses "syns_0" on a cell.
For example, the synapses labelled ``"syns_0"`` on a cell.
.. generic:: selection_policy enum The policy for selecting a single item out of a group
identified by its label.
.. generic:: local_label tuple (:gen:`tag`, :gen:`selection_policy`) The local identification of an cell-local item from a
.. generic:: local_label tuple (:gen:`tag`, :gen:`selection_policy`) The local identification of a cell-local item from a
cell-local collection on an unspecified cell.
.. generic:: global_label tuple (:gen:`gid`, :gen:`local_lable`) The global identification of a cell-local item from a
cell-local collection on the cell identified by `gid`.
Expand All @@ -29,17 +29,17 @@ to targets. Gap junctions are formed between two gap junction sites. An example
:ref:`cable cell<modelcablecell>` is a :ref:`threshold detector <cablecell-threshold-detectors>`;
an example of a target on a cable cell is a :ref:`synapse <cablecell-synapses>`.

**Sources**, **targets** and **gap junction sites** are placed on sets of one or more locations on a cell.
The number of locations in each set (and hence the number of sources/targets/gap junctions), depends on the cell
**Sources**, **targets**, and **gap junction sites** are placed on sets of one or more locations on a cell.
The number of locations in each set (and hence the number of sources/targets/gap junctions) depends on the cell
description. For example, a user may choose to place a synapse at the end of every branch of a cell: the number of
synapses in this case depends on the underlying morphology.
synapses, in this case, depends on the underlying morphology.

A set of one or more items of the same type (source/target/gap junction) are grouped under a label which can
be when used when forming connections in a network. However, connections are one-to-one, so a :gen:`selection_policy`
A set of one or more items of the same type (source/target/gap junction) are grouped under a label, which can
be used when forming connections in a network. However, connections are one-to-one, so a :gen:`selection_policy`
is needed to select an item of the group, for both ends of a connection or gap junction.

The combination of :gen:`tag` and :gen:`selection_policy` forms a :gen:`local_label`. When the global identifier of
the cell :gen:`gid` is added, a :gen:`global_label` is formed, capable of globally identifying a source, target or
the cell :gen:`gid` is added, a :gen:`global_label` is formed, capable of globally identifying a source, target, or
gap junction site in the network. These :gen:`global_labels` are used to form connections and gap junctions in the
:ref:`recipe <modelrecipe>`.

Expand All @@ -51,12 +51,12 @@ The :gen:`gid` of a cell is also used to determine its cell :ref:`kind <modelcel
Cell kind
---------

.. table:: The 4 types of cell supported by Arbor
.. table:: The 4 types of cells supported by Arbor

======================== ===========================================================
Cell Kind Description
======================== ===========================================================
**Cable cell** Cell with morphology and user configurable dynamics.
**Cable cell** Cell with morphology and user-configurable dynamics.
**LIF cell** Leaky integrate-and-fire neuron.
**Spiking cell** Proxy cell that generates spikes.
**Benchmark cell** Proxy cell used for benchmarking (developer use only).
Expand All @@ -66,11 +66,11 @@ Cell kind

1. **Cable Cells**

Cable cells are morphologically-detailed cells. They can be coupled to other cells via the following
Cable cells are morphologically detailed cells. They can be coupled to other cells via the following
mechanisms:

1. Spike exchange over a :ref:`connection <modelconnections>` with fixed latency.
Cable cells can *receive* spikes from any kind of cell, and can be a *source* of spikes
Cable cells can *receive* spikes from any kind of cell and can be a *source* of spikes
to cells that have target sites (i.e. *cable* and *lif* cells).
2. Direct electrical coupling between two cable cells via :ref:`gap junctions <modelgapjunctions>`.

Expand Down Expand Up @@ -100,7 +100,7 @@ Cell kind

4. **Benchmark Cells**

Benchmark cells are proxy cells used for benchmarking, and used by developers to benchmark the spike
Benchmark cells are proxy cells used for benchmarking and used by developers to benchmark the spike
exchange and event delivery infrastructure.

.. _modelcelldesc:
Expand Down

0 comments on commit 5dfba2f

Please sign in to comment.