Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
arbor
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Analyze
Contributor analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
arbor-sim
arbor
Commits
5447e2a8
Unverified
Commit
5447e2a8
authored
4 years ago
by
Brent Huisman
Committed by
GitHub
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Clarify sample collection in distributed contexts. (#1331)
parent
782658db
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/python/simulation.rst
+7
-0
7 additions, 0 deletions
doc/python/simulation.rst
with
7 additions
and
0 deletions
doc/python/simulation.rst
+
7
−
0
View file @
5447e2a8
...
@@ -135,6 +135,13 @@ over the local and distributed hardware resources (see :ref:`pydomdec`). Then, t
...
@@ -135,6 +135,13 @@ over the local and distributed hardware resources (see :ref:`pydomdec`). Then, t
Retrieve a list of sample data associated with the given ``handle``.
Retrieve a list of sample data associated with the given ``handle``.
There will be one entry in the list per probe associated with the probe id used when the sampling was set up.
There will be one entry in the list per probe associated with the probe id used when the sampling was set up.
For example, if a probe was placed on a locset describing three positions, the returned list will contain three elements.
An empty list will be returned if no output was recorded for the cell. For simulations
that are distributed using MPI, handles associated with non-local cells will return an
empty list.
It is the responsibility of the caller to gather results over the ranks.
Each entry is a pair ``(samples, meta)`` where ``meta`` is the probe metadata as would be returned by
Each entry is a pair ``(samples, meta)`` where ``meta`` is the probe metadata as would be returned by
``probe_metadata(probe_id)``, and ``samples`` contains the recorded values.
``probe_metadata(probe_id)``, and ``samples`` contains the recorded values.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment