From 7d1ee1e31d1d5756c9a06fd0751bce9db1a81f5d Mon Sep 17 00:00:00 2001
From: Nora Abi Akar <nora.abiakar@gmail.com>
Date: Mon, 17 May 2021 17:17:30 +0300
Subject: [PATCH] Docs: fix python tutorials (#1527)
Fix mistakes reported by @Helveg in the Python tutorial docs.
---
doc/tutorial/single_cell_model.rst | 2 +-
doc/tutorial/single_cell_recipe.rst | 4 ++++
python/example/single_cell_model.py | 2 +-
3 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/doc/tutorial/single_cell_model.rst b/doc/tutorial/single_cell_model.rst
index f9668712..a5ce9dd5 100644
--- a/doc/tutorial/single_cell_model.rst
+++ b/doc/tutorial/single_cell_model.rst
@@ -48,7 +48,7 @@ Our *single-segment HH cell* has a simple morphology and dynamics, constructed a
labels = arbor.label_dict({'soma': '(tag 1)',
'midpoint': '(location 0 0.5)'})
- # (3) Create cell and set properties
+ # (3) Create and set up a decor object
decor = arbor.decor()
decor.set_property(Vm=-40)
decor.paint('"soma"', 'hh')
diff --git a/doc/tutorial/single_cell_recipe.rst b/doc/tutorial/single_cell_recipe.rst
index 43a152f3..41963f59 100644
--- a/doc/tutorial/single_cell_recipe.rst
+++ b/doc/tutorial/single_cell_recipe.rst
@@ -93,6 +93,10 @@ It returns `0` by default and models without cells are quite boring!
# (4.7) Override the global_properties method
return self.the_props
+ # (5) Instantiate recipe with a voltage probe located on "midpoint".
+
+ recipe = single_recipe(cell, [arbor.cable_probe_membrane_voltage('"midpoint"')])
+
Step **(4)** describes the recipe that will reflect our single cell model.
Step **(4.1)** defines the class constructor. It can take any shape you need, but it
diff --git a/python/example/single_cell_model.py b/python/example/single_cell_model.py
index 76f0153e..39248517 100755
--- a/python/example/single_cell_model.py
+++ b/python/example/single_cell_model.py
@@ -11,7 +11,7 @@ tree.append(arbor.mnpos, arbor.mpoint(-3, 0, 0, 3), arbor.mpoint(3, 0, 0, 3), ta
labels = arbor.label_dict({'soma': '(tag 1)',
'midpoint': '(location 0 0.5)'})
-# (3) Create cell and set properties
+# (3) Create and set up a decor object
decor = arbor.decor()
decor.set_property(Vm=-40)
decor.paint('"soma"', 'hh')
--
GitLab