Docs preview for PR #581.

pr-581/api/languages/cpp_api.html

@@ -2787,7 +2787,7 @@ <h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N5cudaq9set_noiseERN5cudaq11noise_modelE">
 <span id="_CPPv3N5cudaq9set_noiseERN5cudaq11noise_modelE"></span><span id="_CPPv2N5cudaq9set_noiseERN5cudaq11noise_modelE"></span><span id="cudaq::set_noise__cudaq::noise_modelR"></span><span class="target" id="cudaq_8h_1a29a2fd140ac6b2296a73c2dbdbc2c08a"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-prename descclassname"><a class="reference internal" href="#_CPPv45cudaq" title="cudaq"><span class="n"><span class="pre">cudaq</span></span></a><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">set_noise</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv45cudaq" title="cudaq"><span class="n"><span class="pre">cudaq</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5cudaq11noise_modelE" title="cudaq::noise_model"><span class="n"><span class="pre">noise_model</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">model</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5cudaq9set_noiseERN5cudaq11noise_modelE" title="Permalink to this definition">¶</a><br /></dt>
-<dd><p>Set a custom noise model for simulation. </p>
+<dd><p>Set a custom noise model for simulation. The caller must also call <code class="docutils literal notranslate"><span class="pre">cudaq::unset_noise</span></code> before <code class="docutils literal notranslate"><span class="pre">model</span></code> gets deallocated or goes out of scope. </p>
 </dd></dl>
 
 <dl class="cpp function">

pr-581/sphinx/examples/cpp/basics/noise_modeling.cpp

@@ -49,4 +49,8 @@ int main() {
   // Run the noisy simulation
   counts = cudaq::sample(xgate);
   counts.dump();
+
+  // Unset the noise model when done. This is not necessary in this case but is
+  // good practice in order to not interfere with future simulations.
+  cudaq::unset_noise();
 }

pr-581/sphinx/using/advanced/_noise.rst

@@ -47,7 +47,10 @@ apply to the simulated state via a :code:`noise_model::get_channel(...)` call.
 Noise models can be constructed via the :code:`cudaq::noise_model` and specified for 
 execution via a public :code:`cudaq::set_noise(cudaq::noise_model&)` function. This function 
 should forward the :code:`noise_model` to the current :code:`quantum_platform` which can attach it 
-to the current :code:`ExecutionContext` and retrieved by backend simulators. 
+to the current :code:`ExecutionContext` and retrieved by backend simulators. The
+:code:`noise_model` must stay in scope in order to be successfully used by the
+backend simulators, and you must call :code:`cudaq::unset_noise()` when you are
+done with the noise model.
 
 The :code:`kraus_op` matrix data assumes a LSB qubit ordering.