diff --git a/doc/python/probe_sample.rst b/doc/python/probe_sample.rst index 53056ab0201980caee6802a04a74b3fa48553020..983b94d5eb5dc4b1b31dddc76f2f2cdbbfd93f0f 100644 --- a/doc/python/probe_sample.rst +++ b/doc/python/probe_sample.rst @@ -3,6 +3,8 @@ Cable cell probing and sampling =============================== +.. module:: arbor + Cable cell probe addresses are defined analogously to their counterparts in the C++ API (see :ref:`cablecell-probes` for details). Sample data recorded by the Arbor simulation object is returned in the form of a NumPy array, @@ -15,7 +17,7 @@ one, or more probes, one per site. They are evaluated in the context of the cell on which the probe is attached. Each of the functions described below generates an opaque :class:`probe` -object for use in the recipe :py:func:`get_probes` method. +object for use in the recipe :py:func:`recipe.probes` method. More information on probes, probe metadata, and sampling can be found in the documentation for the class :class:`simulation`.