You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/src/drivers.rst
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,13 @@
3
3
Drivers
4
4
=======
5
5
6
-
To make use of the hub and spoke system, you must come up with a
7
-
driver that instantiates the objects and calls them. Nearly the
6
+
Most new users should use ``mpisppy.generic_cylinders.py`` (see :ref:`generic_cylinders`)
7
+
as their driver. However, advanced users might want features that are not yet
8
+
supported in ``mpisppy.generic_cylinders.py`` and so they might want to create their
9
+
own driver. Also, users who want to maintain, or modify a copy of ``mpisppy.generic_cylinders.py``
10
+
may want some background on drivers, which is provided in this section.
11
+
12
+
Nearly the
8
13
last step in most drivers is a call to ``mpisppy.utils.sputils.spin_the_wheel``
9
14
that calls the hub and spokes. Many of the example drivers take
10
15
advantage of shared code in the ``mpisppy.utils`` directory.
@@ -40,7 +45,7 @@ Extending Examples
40
45
Many developers
41
46
will need to add extensions. Here are few examples:
42
47
43
-
* In the ``farmer_cylinders.py`` example, there is a block of code to add a ``--crops-mult`` argument that is passed to the scenario creator in the ``scenario_creator_kwargs`` dictionary.
48
+
* In the ``examples.farmer.archive.farmer_cylinders.py`` example, there is a block of code to add a ``--crops-mult`` argument that is passed to the scenario creator in the ``scenario_creator_kwargs`` dictionary.
44
49
45
50
* In the ``hydro_cylinders.py`` example (which has three stages). The branching factors are obtained from the command line and passed to the scenario constructor via ``scenario_creator_kwargs`` and also passed to ``sputils.create_nodenames_from_BFs`` to create a node list.
0 commit comments