api.html 53.60 KiB
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>API reference &mdash; OhmPi v2024rc documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/sphinx_highlight.js"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Troubleshooting" href="troubleshooting.html" />
    <link rel="prev" title="Software and operation" href="software.html" /> 
</head>
<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          <a href="../index.html" class="icon icon-home">
            OhmPi
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Ohmpi.html">OhmPi project</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li>
<li class="toctree-l1"><a class="reference internal" href="software.html">Software and operation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi"><code class="docutils literal notranslate"><span class="pre">OhmPi</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.append_and_save"><code class="docutils literal notranslate"><span class="pre">OhmPi.append_and_save()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.download_data"><code class="docutils literal notranslate"><span class="pre">OhmPi.download_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.get_data"><code class="docutils literal notranslate"><span class="pre">OhmPi.get_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.interrupt"><code class="docutils literal notranslate"><span class="pre">OhmPi.interrupt()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.load_sequence"><code class="docutils literal notranslate"><span class="pre">OhmPi.load_sequence()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.quit"><code class="docutils literal notranslate"><span class="pre">OhmPi.quit()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.remove_data"><code class="docutils literal notranslate"><span class="pre">OhmPi.remove_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.repeat_sequence"><code class="docutils literal notranslate"><span class="pre">OhmPi.repeat_sequence()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.reset_mux"><code class="docutils literal notranslate"><span class="pre">OhmPi.reset_mux()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.restart"><code class="docutils literal notranslate"><span class="pre">OhmPi.restart()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.rs_check"><code class="docutils literal notranslate"><span class="pre">OhmPi.rs_check()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.run_inversion"><code class="docutils literal notranslate"><span class="pre">OhmPi.run_inversion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.run_measurement"><code class="docutils literal notranslate"><span class="pre">OhmPi.run_measurement()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.run_multiple_sequences"><code class="docutils literal notranslate"><span class="pre">OhmPi.run_multiple_sequences()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.run_sequence"><code class="docutils literal notranslate"><span class="pre">OhmPi.run_sequence()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.run_sequence_async"><code class="docutils literal notranslate"><span class="pre">OhmPi.run_sequence_async()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ohmpi.ohmpi.OhmPi.sequence"><code class="docutils literal notranslate"><span class="pre">OhmPi.sequence</span></code></a></li>