Skip to content

Commit

Permalink
Added section in the tutorial getting_started about propagating ana…
Browse files Browse the repository at this point in the history
…lysis option
  • Loading branch information
ItamarGoldman committed Oct 2, 2023
1 parent c37552f commit bdf443e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/tutorials/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -393,4 +393,17 @@ into one level:
parallel_data = parallel_exp.run(backend, seed_simulator=101).block_for_results()

for result in parallel_data.analysis_results():
print(result)
print(result)

Broadcating analysis option to child experiments
-----------------------------

If we would like to set analysis options to each of the child experiments, we can use the keyword
'broadcast' when configuring an analysis option for a composite experiment.

.. jupyter-execute::

parallel_exp.analysis.set_options(plot=False, broadcast=True)

When the 'broadcast' flag is set, the specified option will be applied to each child experiment.
In this instance, the analysis will not generate a figure for the child experiment after the analysis.

0 comments on commit bdf443e

Please sign in to comment.