Prepare for v0.0.14

odoare · Apr 25, 2023 · c2c007c · c2c007c
1 parent 82c2f29
commit c2c007c
Show file tree

Hide file tree

Showing 16 changed files with 214 additions and 181 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # measpy - Measurements with Python
-
+(c) 2020-2023 Olivier Doaré
 Contact: [email protected]
 
 measpy is a set of classes and methods to help data acquisition with DAQ cards or sound cards and analysis of signals. It is mainly acoustics and vibrations oriented.
@@ -13,7 +13,8 @@ The base classes are:
 For now, these daq devices are implemented :
 - Audio cards, via the ```sounddevice``` package,
 - NI DAQ cards, via the ```nidaqmx``` package.
-
+- Picoscope scopes, via the ```picosdk-python-wrappers``` package.
+
 To import the package and perform data acquisition with sound cards:
 ```python
 import measpy as mp
@@ -40,7 +41,7 @@ print(l)
 ## TODO
 
 Things to improve, implement, fix:
-- New processing methods have to be implemented (e.g. Hilbert Transform, more filters, FIR, etc.)
+- New processing methods have to be implemented (e.g. FIR, convolution, etc.)
 - Improve plotting methods
 - Other In/Out synchronization methods (for now a method using a peak sync before measurement is implemented)
 - More documentation

diff --git a/docs/html/README.html b/docs/html/README.html
@@ -81,7 +81,8 @@
 
   <section id="measpy-measurements-with-python">
 <h1>measpy - Measurements with Python<a class="headerlink" href="#measpy-measurements-with-python" title="Permalink to this heading"></a></h1>
-<p>Contact: olivier.doare&#64;ensta-paris.fr</p>
+<p>(c) 2020-2023 Olivier Doaré
+Contact: olivier.doare&#64;ensta-paris.fr</p>
 <p>measpy is a set of classes and methods to help data acquisition with DAQ cards or sound cards and analysis of signals. It is mainly acoustics and vibrations oriented.</p>
 <p>The base classes are:</p>
 <ul class="simple">
@@ -94,6 +95,7 @@ <h1>measpy - Measurements with Python<a class="headerlink" href="#measpy-measure
 <ul class="simple">
 <li><p>Audio cards, via the <code class="docutils literal notranslate"><span class="pre">sounddevice</span></code> package,</p></li>
 <li><p>NI DAQ cards, via the <code class="docutils literal notranslate"><span class="pre">nidaqmx</span></code> package.</p></li>
+<li><p>Picoscope scopes, via the <code class="docutils literal notranslate"><span class="pre">picosdk-python-wrappers</span></code> package.</p></li>
 </ul>
 <p>To import the package and perform data acquisition with sound cards:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">measpy</span> <span class="k">as</span> <span class="nn">mp</span>
@@ -118,7 +120,7 @@ <h1>measpy - Measurements with Python<a class="headerlink" href="#measpy-measure
 <h2>TODO<a class="headerlink" href="#todo" title="Permalink to this heading"></a></h2>
 <p>Things to improve, implement, fix:</p>
 <ul class="simple">
-<li><p>New processing methods have to be implemented (e.g. Hilbert Transform, more filters, FIR, etc.)</p></li>
+<li><p>New processing methods have to be implemented (e.g. FIR, convolution, etc.)</p></li>
 <li><p>Improve plotting methods</p></li>
 <li><p>Other In/Out synchronization methods (for now a method using a peak sync before measurement is implemented)</p></li>
 <li><p>More documentation</p></li>

diff --git a/docs/html/_sources/README.md.txt b/docs/html/_sources/README.md.txt
@@ -1,5 +1,5 @@
 # measpy - Measurements with Python
-
+(c) 2020-2023 Olivier Doaré
 Contact: [email protected]
 
 measpy is a set of classes and methods to help data acquisition with DAQ cards or sound cards and analysis of signals. It is mainly acoustics and vibrations oriented.
@@ -13,7 +13,8 @@ The base classes are:
 For now, these daq devices are implemented :
 - Audio cards, via the ```sounddevice``` package,
 - NI DAQ cards, via the ```nidaqmx``` package.
-
+- Picoscope scopes, via the ```picosdk-python-wrappers``` package.
+
 To import the package and perform data acquisition with sound cards:
 ```python
 import measpy as mp
@@ -40,7 +41,7 @@ print(l)
 ## TODO
 
 Things to improve, implement, fix:
-- New processing methods have to be implemented (e.g. Hilbert Transform, more filters, FIR, etc.)
+- New processing methods have to be implemented (e.g. FIR, convolution, etc.)
 - Improve plotting methods
 - Other In/Out synchronization methods (for now a method using a peak sync before measurement is implemented)
 - More documentation

diff --git a/docs/html/_sources/measpy.rst.txt b/docs/html/_sources/measpy.rst.txt
@@ -28,6 +28,14 @@ measpy.ni module
    :undoc-members:
    :show-inheritance:
 
+measpy.pico module
+----------------
+
+.. automodule:: measpy.pico
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 measpy.signal module
 --------------------
 

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -197,12 +197,14 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="measpy.html#measpy.signal.Spectral.filterout">filterout() (measpy.signal.Spectral method)</a>
 </li>
-      <li><a href="measpy.html#measpy.signal.Spectral.freqs">freqs (measpy.signal.Spectral property)</a>
+      <li><a href="measpy.html#measpy.pico.findindex">findindex() (in module measpy.pico)</a>
 </li>
-      <li><a href="measpy.html#measpy.signal.Weighting.from_csv">from_csv() (measpy.signal.Weighting class method)</a>
+      <li><a href="measpy.html#measpy.signal.Spectral.freqs">freqs (measpy.signal.Spectral property)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="measpy.html#measpy.signal.Weighting.from_csv">from_csv() (measpy.signal.Weighting class method)</a>
+</li>
       <li><a href="measpy.html#measpy.measurement.Measurement.from_csvwav">from_csvwav() (measpy.measurement.Measurement class method)</a>
 
       <ul>
@@ -307,6 +309,13 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="measpy.html#module-measpy.ni">module</a>
+</li>
+      </ul></li>
+      <li>
+    measpy.pico
+
+      <ul>
+        <li><a href="measpy.html#module-measpy.pico">module</a>
 </li>
       </ul></li>
   </ul></td>
@@ -333,6 +342,8 @@ <h2 id="M">M</h2>
         <li><a href="measpy.html#module-measpy.measurement">measpy.measurement</a>
 </li>
         <li><a href="measpy.html#module-measpy.ni">measpy.ni</a>
+</li>
+        <li><a href="measpy.html#module-measpy.pico">measpy.pico</a>
 </li>
         <li><a href="measpy.html#module-measpy.signal">measpy.signal</a>
 </li>
@@ -379,8 +390,16 @@ <h2 id="P">P</h2>
         <li><a href="measpy.html#measpy.signal.Spectral.plot">(measpy.signal.Spectral method)</a>
 </li>
       </ul></li>
+      <li><a href="measpy.html#measpy.pico.ps2000_plot">ps2000_plot() (in module measpy.pico)</a>
+</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="measpy.html#measpy.pico.ps2000_run_measurement">ps2000_run_measurement() (in module measpy.pico)</a>
+</li>
+      <li><a href="measpy.html#measpy.pico.ps4000_plot">ps4000_plot() (in module measpy.pico)</a>
+</li>
+      <li><a href="measpy.html#measpy.pico.ps4000_run_measurement">ps4000_run_measurement() (in module measpy.pico)</a>
+</li>
       <li><a href="measpy.html#measpy.signal.Signal.psd">psd() (measpy.signal.Signal method)</a>
 </li>
   </ul></td>
@@ -428,6 +447,8 @@ <h2 id="S">S</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="measpy.html#measpy.signal.Signal.sine">sine() (measpy.signal.Signal class method)</a>
+</li>
+      <li><a href="measpy.html#measpy.signal.Signal.smooth">smooth() (measpy.signal.Signal method)</a>
 </li>
       <li><a href="measpy.html#measpy.signal.Spectral">Spectral (class in measpy.signal)</a>
 </li>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -117,6 +117,14 @@ <h1>Welcome to measpy’s documentation!<a class="headerlink" href="#welcome-to-
 <li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.ni.ni_run_measurement"><code class="docutils literal notranslate"><span class="pre">ni_run_measurement()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="measpy.html#measpy-pico-module">measpy.pico module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.pico.findindex"><code class="docutils literal notranslate"><span class="pre">findindex()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.pico.ps2000_plot"><code class="docutils literal notranslate"><span class="pre">ps2000_plot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.pico.ps2000_run_measurement"><code class="docutils literal notranslate"><span class="pre">ps2000_run_measurement()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.pico.ps4000_plot"><code class="docutils literal notranslate"><span class="pre">ps4000_plot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.pico.ps4000_run_measurement"><code class="docutils literal notranslate"><span class="pre">ps4000_run_measurement()</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="measpy.html#module-measpy.signal">measpy.signal module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.signal.Signal"><code class="docutils literal notranslate"><span class="pre">Signal</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="measpy.html#measpy.signal.Spectral"><code class="docutils literal notranslate"><span class="pre">Spectral</span></code></a></li>