Skip to content
GitLab
Commit fabc65ea authored by Olivier Kaufmann's avatar Olivier Kaufmann
Browse files

Updates the sphinx docs after UMONS review

parent 6627d765
master 144-create-testing-framework-for-tests-automation EGU23 MB.2024.ter_restored MUX_board_v2024 Refactor_mb_2023 battery_charger board_v4 code_refactor dev/dummy mqtt update_V2023 v2024_rc v2025_alpha v2024.0.34 v2024.0.33 v2024.0.32 v2024.0.31 v2024.0.30 v2024.0.29 v2024.0.28 v2024.0.27 v2024.0.26 v2024.0.25 v2024.0.24 v2024.0.23 v2024.0.22 v2024.0.21 v2024.0.20 v2024.0.19 v2024.0.18 v2024.0.17 v2024.0.16 v2024.0.15 v2024.0.14 v2024.0.13 v2024.0.12 v2024.0.11 v2024.0.10 v2024.0.9 v2024.0.8 v2024.0.7 v2024.0.0 v2023.0.1 v2023.0.0 archives/mqtt
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 2098 additions and 1867 deletions
+2098 -1867
sphinx/build/doctrees/Ohmpi.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/Ohmpi_V2_00/V2_00_step_01.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/Ohmpi_V2_00/V2_00_step_02.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/Ohmpi_V2_00/V2_00_step_03.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/V1_01.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/V1_02.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/V2_00.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/environment.pickle
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/doctrees/index.doctree
+ 0
− 0
View file @ fabc65ea
No preview for this file type
sphinx/build/html/.buildinfo
+ 1
− 1
View file @ fabc65ea
# Sphinx build info version 1 # Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6a8dddc6f305065c6e165846b2728f15 config: 4ac17d5203f4fed9801b331b002090ea
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7
sphinx/build/html/Ohmpi.html
+ 31
− 39
View file @ fabc65ea
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html4" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>OhmPi project &mdash; Ohmpi: open hardware resistivity-meter documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <title>OhmPi project &mdash; Ohmpi: open hardware resistivity-meter documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'open hardware resistivity-meter',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
...@@ -83,10 +75,10 @@ ...@@ -83,10 +75,10 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="ohmpi-project"> <section id="ohmpi-project">
<h1>OhmPi project<a class="headerlink" href="#ohmpi-project" title="Permalink to this headline"></a></h1> <h1>OhmPi project<a class="headerlink" href="#ohmpi-project" title="Permalink to this headline"></a></h1>
<div class="section" id="partenaires"> <section id="partenaires">
<h2><strong>Partenaires</strong><a class="headerlink" href="#partenaires" title="Permalink to this headline"></a></h2> <h2><strong>Partenaires</strong><a class="headerlink" href="#partenaires" title="Permalink to this headline"></a></h2>
<a class="reference internal image-reference" href="_images/logo_ohmpi.JPG"><img alt="Logo OhmPi" class="align-center" src="_images/logo_ohmpi.JPG" style="width: 350px; height: 250px;" /></a> <a class="reference internal image-reference" href="_images/logo_ohmpi.JPG"><img alt="Logo OhmPi" class="align-center" src="_images/logo_ohmpi.JPG" style="width: 350px; height: 250px;" /></a>
<p>Authors:</p> <p>Authors:</p>
<div class="line-block"> <div class="line-block">
...@@ -97,21 +89,21 @@ ...@@ -97,21 +89,21 @@
<div class="line">Olivier Kaufmann, Université de Mons · Department of Geology and Applied Geology</div> <div class="line">Olivier Kaufmann, Université de Mons · Department of Geology and Applied Geology</div>
</div> </div>
<p>Parteners:</p> <p>Parteners:</p>
<table border="1" class="docutils align-center"> <table class="docutils align-center">
<colgroup> <colgroup>
<col width="23%" /> <col style="width: 23%" />
<col width="27%" /> <col style="width: 27%" />
<col width="23%" /> <col style="width: 23%" />
<col width="27%" /> <col style="width: 27%" />
</colgroup> </colgroup>
<tbody valign="top"> <tbody>
<tr class="row-odd"><td><img alt="_images/logo_inrae.jpg" class="first last" src="_images/logo_inrae.jpg" /> <tr class="row-odd"><td><img alt="_images/logo_inrae.jpg" src="_images/logo_inrae.jpg" />
</td> </td>
<td><img alt="_images/logo_univ_gustave.png" class="first last" src="_images/logo_univ_gustave.png" /> <td><img alt="_images/logo_univ_gustave.png" src="_images/logo_univ_gustave.png" />
</td> </td>
<td><img alt="_images/logo-iris.jpg" class="first last" src="_images/logo-iris.jpg" /> <td><img alt="_images/logo-iris.jpg" src="_images/logo-iris.jpg" />
</td> </td>
<td><img alt="_images/ige.png" class="first last" src="_images/ige.png" /> <td><img alt="_images/ige.png" src="_images/ige.png" />
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -119,23 +111,23 @@ ...@@ -119,23 +111,23 @@
<p>Creation date : Juillet 2020.</p> <p>Creation date : Juillet 2020.</p>
<p>Update : 04 août 2021.</p> <p>Update : 04 août 2021.</p>
<p>Status of document: In progress.</p> <p>Status of document: In progress.</p>
<div class="section" id="citing-ohmpi"> <section id="citing-ohmpi">
<h3><strong>Citing OhmPi</strong><a class="headerlink" href="#citing-ohmpi" title="Permalink to this headline"></a></h3> <h3><strong>Citing OhmPi</strong><a class="headerlink" href="#citing-ohmpi" title="Permalink to this headline"></a></h3>
<p><em>Rémi Clement, Yannick Fargier, Vivien Dubois, Julien Gance, Emile Gros, et al.. OhmPi: An open</em> <p><em>Rémi Clement, Yannick Fargier, Vivien Dubois, Julien Gance, Emile Gros, et al.. OhmPi: An open</em>
<em>source data logger for dedicated applications of electrical resistivity imaging at the small and laboratory</em> <em>source data logger for dedicated applications of electrical resistivity imaging at the small and laboratory</em>
<em>scale. HardwareX, Elsevier, 2020, 8, 24 p. ff10.1016/j.ohx.2020.e00122ff.</em></p> <em>scale. HardwareX, Elsevier, 2020, 8, 24 p. ff10.1016/j.ohx.2020.e00122ff.</em></p>
</div> </section>
<div class="section" id="introduction-to-ohmpi"> <section id="introduction-to-ohmpi">
<h3><strong>Introduction to OhmPi</strong><a class="headerlink" href="#introduction-to-ohmpi" title="Permalink to this headline"></a></h3> <h3><strong>Introduction to OhmPi</strong><a class="headerlink" href="#introduction-to-ohmpi" title="Permalink to this headline"></a></h3>
<p>This documentation presents the development of a low-cost, open hardware resistivity meter to provide the scientific community with a robust and flexible tool for small-scale experiments. Called OhmPi, this basic resistivity meterfeatures current injection and measurement functions associated with a multiplexer that allows performing automatic measurements with up to 32 electrodes.OhmPi’s philosophy is to provide a fully open source and open hardware tool / <p>This documentation presents the development of a low-cost, open hardware resistivity meter to provide the scientific community with a robust and flexible tool for small-scale experiments. Called OhmPi, this basic resistivity meterfeatures current injection and measurement functions associated with a multiplexer that allows performing automatic measurements with up to 32 electrodes.OhmPi’s philosophy is to provide a fully open source and open hardware tool /
to the near surface scientific community.</p> to the near surface scientific community.</p>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="admonition-title">Note</p>
<p class="last">Everyone willing to get involved is welcome in OhmPi Project!.</p> <p>Everyone willing to get involved is welcome in OhmPi Project!.</p>
</div>
</div>
</div>
</div> </div>
</section>
</section>
</section>
</div> </div>
......
sphinx/build/html/Ohmpi_V2_00/V2_00_step_01.html
+ 67
− 75
View file @ fabc65ea
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html4" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>STEP n°1 : Raspberry Pi configuration &mdash; Ohmpi: open hardware resistivity-meter documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <title>STEP n°1 : Raspberry Pi configuration &mdash; Ohmpi: open hardware resistivity-meter documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script> <script src="../_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script> <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'open hardware resistivity-meter',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script src="../_static/jquery.js"></script> <script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script> <script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script> <script src="../_static/doctools.js"></script>
...@@ -92,148 +84,148 @@ ...@@ -92,148 +84,148 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="step-n1-raspberry-pi-configuration"> <section id="step-n1-raspberry-pi-configuration">
<h1><strong>STEP n°1</strong> : Raspberry Pi configuration<a class="headerlink" href="#step-n1-raspberry-pi-configuration" title="Permalink to this headline"></a></h1> <h1><strong>STEP n°1</strong> : Raspberry Pi configuration<a class="headerlink" href="#step-n1-raspberry-pi-configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="part-a-os-installation"> <section id="part-a-os-installation">
<h2><strong>PART A</strong> OS installation<a class="headerlink" href="#part-a-os-installation" title="Permalink to this headline"></a></h2> <h2><strong>PART A</strong> OS installation<a class="headerlink" href="#part-a-os-installation" title="Permalink to this headline"></a></h2>
<table border="1" class="docutils"> <table class="docutils align-default">
<colgroup> <colgroup>
<col width="78%" /> <col style="width: 78%" />
<col width="22%" /> <col style="width: 22%" />
</colgroup> </colgroup>
<tbody valign="top"> <tbody>
<tr class="row-odd"><td><strong>Required components</strong></td> <tr class="row-odd"><td><p><strong>Required components</strong></p></td>
<td><strong>Quantity</strong></td> <td><p><strong>Quantity</strong></p></td>
</tr> </tr>
<tr class="row-even"><td>Raspberry Pi 4 Model B</td> <tr class="row-even"><td><p>Raspberry Pi 4 Model B</p></td>
<td>1</td> <td><p>1</p></td>
</tr> </tr>
<tr class="row-odd"><td>Micro SD 32 Go</td> <tr class="row-odd"><td><p>Micro SD 32 Go</p></td>
<td>1</td> <td><p>1</p></td>
</tr> </tr>
<tr class="row-even"><td>HDMI Cable</td> <tr class="row-even"><td><p>HDMI Cable</p></td>
<td>1</td> <td><p>1</p></td>
</tr> </tr>
<tr class="row-odd"><td>Computer mouse</td> <tr class="row-odd"><td><p>Computer mouse</p></td>
<td>1</td> <td><p>1</p></td>
</tr> </tr>
<tr class="row-even"><td>Computer Keyboard</td> <tr class="row-even"><td><p>Computer Keyboard</p></td>
<td>1</td> <td><p>1</p></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
<p>The first step is to start up the Raspberry Pi board, including installation of an OS (operating system). <p>The first step is to start up the Raspberry Pi board, including installation of an OS (operating system).
For this step, the installation instructions are well described on the Raspberry website</p> For this step, the installation instructions are well described on the Raspberry website</p>
<ol class="arabic simple"> <ol class="arabic simple">
<li>Watch the vidéo “how to set up your raspberry Pi” (<a class="reference external" href="https://www.youtube.com/watch?v=wjWZhV1v3Pk">https://www.youtube.com/watch?v=wjWZhV1v3Pk</a>)</li> <li><p>Watch the vidéo “how to set up your raspberry Pi” (<a class="reference external" href="https://www.youtube.com/watch?v=wjWZhV1v3Pk">https://www.youtube.com/watch?v=wjWZhV1v3Pk</a>)</p></li>
<li>The authors recommend installing the latest stable and complete version of Raspberry Pi OS (Previously called Raspbian) by using Raspberry Pi Imager.</li> <li><p>The authors recommend installing the latest stable and complete version of Raspberry Pi OS (Previously called Raspbian) by using Raspberry Pi Imager.</p></li>
<li>or you can visit this website : (<a class="reference external" href="https://projects.raspberrypi.org/en/projects/raspberry-pi-setting-up">https://projects.raspberrypi.org/en/projects/raspberry-pi-setting-up</a>)</li> <li><p>or you can visit this website : (<a class="reference external" href="https://projects.raspberrypi.org/en/projects/raspberry-pi-setting-up">https://projects.raspberrypi.org/en/projects/raspberry-pi-setting-up</a>)</p></li>
</ol> </ol>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>All the development tests were performed on Raspberry Pi 3 Model B, we used the following version of Raspbian:</p> <p>All the development tests were performed on Raspberry Pi 3 Model B, we used the following version of Raspbian:</p>
<div class="align-center last figure"> <figure class="align-center">
<a class="reference internal image-reference" href="../_images/raspbian_version.jpg"><img alt="alternate text" src="../_images/raspbian_version.jpg" style="width: 800px; height: 400px;" /></a> <a class="reference internal image-reference" href="../_images/raspbian_version.jpg"><img alt="alternate text" src="../_images/raspbian_version.jpg" style="width: 800px; height: 400px;" /></a>
</div> </figure>
</div> </div>
<div class="admonition warning"> <div class="admonition warning">
<p class="first admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p class="last">Once the OS has been installed, <strong>1-wire, spi and GPIO remote option</strong> must be deactivated and <strong>I2C option</strong> must be activated via the Raspbian GUI settings menu. Failure to carry out this task may cause damage to the relay shield cards during measurements.</p> <p>Once the OS has been installed, <strong>1-wire, spi and GPIO remote option</strong> must be deactivated and <strong>I2C option</strong> must be activated via the Raspbian GUI settings menu. Failure to carry out this task may cause damage to the relay shield cards during measurements.</p>
</div> </div>
<p>3. When the relays are connected to the GPIO, make sure that all the GPIOs are in the low position when the raspberry starts up. If not, the relays will activate unexpectedly. <p>3. When the relays are connected to the GPIO, make sure that all the GPIOs are in the low position when the raspberry starts up. If not, the relays will activate unexpectedly.
To ensure that the GPIOs are in Low position, you will need to modify the /boot/config.txt file.</p> To ensure that the GPIOs are in Low position, you will need to modify the /boot/config.txt file.</p>
<blockquote> <blockquote>
<div><p>Run the terminal, and write</p> <div><p>Run the terminal, and write</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">boot</span><span class="o">/</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">boot</span><span class="o">/</span>
</pre></div> </pre></div>
</div> </div>
</div></blockquote> </div></blockquote>
<ol class="arabic simple" start="4"> <ol class="arabic simple" start="4">
<li>Open config.txt with GNU nano editor</li> <li><p>Open config.txt with GNU nano editor</p></li>
</ol> </ol>
<blockquote> <blockquote>
<div><div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">nano</span> <span class="n">config</span><span class="o">.</span><span class="n">txt</span> <div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">nano</span> <span class="n">config</span><span class="o">.</span><span class="n">txt</span>
</pre></div> </pre></div>
</div> </div>
</div></blockquote> </div></blockquote>
<ol class="arabic simple" start="5"> <ol class="arabic simple" start="5">
<li>At the end of the file write :</li> <li><p>At the end of the file write :</p></li>
</ol> </ol>
<blockquote> <blockquote>
<div><div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">gpio</span><span class="o">=</span><span class="mi">8</span><span class="o">=</span><span class="n">op</span><span class="p">,</span><span class="n">dl</span> <div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">gpio</span><span class="o">=</span><span class="mi">8</span><span class="o">=</span><span class="n">op</span><span class="p">,</span><span class="n">dl</span>
<span class="n">gpio</span><span class="o">=</span><span class="mi">7</span><span class="o">=</span><span class="n">op</span><span class="p">,</span><span class="n">dl</span> <span class="n">gpio</span><span class="o">=</span><span class="mi">7</span><span class="o">=</span><span class="n">op</span><span class="p">,</span><span class="n">dl</span>
</pre></div> </pre></div>
</div> </div>
</div></blockquote> </div></blockquote>
<ol class="arabic simple" start="6"> <ol class="arabic simple" start="6">
<li>Press Ctrl +O to save the modifications and press enter</li> <li><p>Press Ctrl +O to save the modifications and press enter</p></li>
<li>Press Ctrl +x to escap and return to the terminal</li> <li><p>Press Ctrl +x to escap and return to the terminal</p></li>
<li>Close the terminal</li> <li><p>Close the terminal</p></li>
</ol> </ol>
</div> </section>
<div class="section" id="part-b-virtual-environnement-and-packages"> <section id="part-b-virtual-environnement-and-packages">
<h2><strong>PART B</strong> Virtual Environnement and packages<a class="headerlink" href="#part-b-virtual-environnement-and-packages" title="Permalink to this headline"></a></h2> <h2><strong>PART B</strong> Virtual Environnement and packages<a class="headerlink" href="#part-b-virtual-environnement-and-packages" title="Permalink to this headline"></a></h2>
<p>A virtual environment is a way to have multiple, parallel instances of the Python interpreter, each with different package sets and different configurations. <p>A virtual environment is a way to have multiple, parallel instances of the Python interpreter, each with different package sets and different configurations.
Each virtual environment contains a discrete copy of the Python interpreter, including copies of its support utilities. It also protects your system in case of problems with the packages.</p> Each virtual environment contains a discrete copy of the Python interpreter, including copies of its support utilities. It also protects your system in case of problems with the packages.</p>
<p>All dependencies are specified in requirements.txt</p> <p>All dependencies are specified in requirements.txt</p>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="admonition-title">Note</p>
<p class="last">All instructions below should be typed in the terminal</p> <p>All instructions below should be typed in the terminal</p>
</div> </div>
<p>It is first necessary to ensure that the libatlas-base-dev library is installed:</p> <p>It is first necessary to ensure that the libatlas-base-dev library is installed:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libatlas</span><span class="o">-</span><span class="n">base</span><span class="o">-</span><span class="n">dev</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libatlas</span><span class="o">-</span><span class="n">base</span><span class="o">-</span><span class="n">dev</span>
</pre></div> </pre></div>
</div> </div>
<p>We strongly recommend users to create a virtual environment to run the code and installed all required dependencies. It can be done either in a directory gathering all virtual environments used on the computer or within the ohmpy directory.</p> <p>We strongly recommend users to create a virtual environment to run the code and installed all required dependencies. It can be done either in a directory gathering all virtual environments used on the computer or within the ohmpy directory.</p>
<p>Create the virtual environment:</p> <p>Create the virtual environment:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">venv</span> <span class="n">ohmpy</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">venv</span> <span class="n">ohmpy</span>
</pre></div> </pre></div>
</div> </div>
<p>Activate it using the following command:</p> <p>Activate it using the following command:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="n">ohmpy</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="n">ohmpy</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
</pre></div> </pre></div>
</div> </div>
<p>Install packages within the virtual environment. Installing the following package should be sufficient to meet dependencies:</p> <p>Install packages within the virtual environment. Installing the following package should be sufficient to meet dependencies:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CFLAGS</span><span class="o">=-</span><span class="n">fcommon</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CFLAGS</span><span class="o">=-</span><span class="n">fcommon</span>
<span class="n">sudo</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">RPi</span><span class="o">.</span><span class="n">GPIO</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">blinka</span> <span class="n">numpy</span> <span class="n">pandas</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">circuitpython</span><span class="o">-</span><span class="n">ads1x15</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">circuitpython</span><span class="o">-</span><span class="n">tca9548a</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">circuitpython</span><span class="o">-</span><span class="n">mcp230xx</span> <span class="n">gpiozero</span> <span class="n">sudo</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">RPi</span><span class="o">.</span><span class="n">GPIO</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">blinka</span> <span class="n">numpy</span> <span class="n">pandas</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">circuitpython</span><span class="o">-</span><span class="n">ads1x15</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">circuitpython</span><span class="o">-</span><span class="n">tca9548a</span> <span class="n">adafruit</span><span class="o">-</span><span class="n">circuitpython</span><span class="o">-</span><span class="n">mcp230xx</span> <span class="n">gpiozero</span>
</pre></div> </pre></div>
</div> </div>
<p>Check that requirements are met using</p> <p>Check that requirements are met using</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="nb">list</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="nb">list</span>
</pre></div> </pre></div>
</div> </div>
<p>You should run you code within the virtual environment <p>You should run you code within the virtual environment
to leave the virtual environment simply type:</p> to leave the virtual environment simply type:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">deactivate</span> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">deactivate</span>
</pre></div> </pre></div>
</div> </div>
</div> </section>
<div class="section" id="part-c-activate-virtual-environnement-on-thonny-python-ide-on-rapberry-pi"> <section id="part-c-activate-virtual-environnement-on-thonny-python-ide-on-rapberry-pi">
<h2><strong>PART C</strong> Activate virtual environnement on Thonny (Python IDE) (on Rapberry Pi)<a class="headerlink" href="#part-c-activate-virtual-environnement-on-thonny-python-ide-on-rapberry-pi" title="Permalink to this headline"></a></h2> <h2><strong>PART C</strong> Activate virtual environnement on Thonny (Python IDE) (on Rapberry Pi)<a class="headerlink" href="#part-c-activate-virtual-environnement-on-thonny-python-ide-on-rapberry-pi" title="Permalink to this headline"></a></h2>
<p>If you decided to use a virtual environment, it is necessary to setup Thonny Python IDE the first time you use it.</p> <p>If you decided to use a virtual environment, it is necessary to setup Thonny Python IDE the first time you use it.</p>
<p>1- Run the Thonny Python IDE software, Click on raspebrry acces <strong>menu &gt; programming&gt; Thonny pythonIDE</strong></p> <p>1- Run the Thonny Python IDE software, Click on raspebrry acces <strong>menu &gt; programming&gt; Thonny pythonIDE</strong></p>
<p>2- Thonny’s interface opens, Python runs on the Root (Python 3.7.3 (/usr/bin/python3))</p> <p>2- Thonny’s interface opens, Python runs on the Root (Python 3.7.3 (/usr/bin/python3))</p>
<div class="align-center figure"> <figure class="align-center">
<a class="reference internal image-reference" href="../_images/thonny_first_interface.jpg"><img alt="alternate text" src="../_images/thonny_first_interface.jpg" style="width: 600px; height: 450px;" /></a> <a class="reference internal image-reference" href="../_images/thonny_first_interface.jpg"><img alt="alternate text" src="../_images/thonny_first_interface.jpg" style="width: 600px; height: 450px;" /></a>
</div> </figure>
<p>3-Click on <strong>Run&gt;select interpreter</strong>, a new window opens click on interpret</p> <p>3-Click on <strong>Run&gt;select interpreter</strong>, a new window opens click on interpret</p>
<div class="align-center figure"> <figure class="align-center">
<a class="reference internal image-reference" href="../_images/thonny_option.jpg"><img alt="alternate text" src="../_images/thonny_option.jpg" style="width: 600px; height: 450px;" /></a> <a class="reference internal image-reference" href="../_images/thonny_option.jpg"><img alt="alternate text" src="../_images/thonny_option.jpg" style="width: 600px; height: 450px;" /></a>
</div> </figure>
<p>4-On the new open windows select <strong>alternative Pyhton3 or virtual environnement</strong></p> <p>4-On the new open windows select <strong>alternative Pyhton3 or virtual environnement</strong></p>
<div class="align-center figure"> <figure class="align-center">
<a class="reference internal image-reference" href="../_images/thonny_interpreter.jpg"><img alt="alternate text" src="../_images/thonny_interpreter.jpg" style="width: 600px; height: 450px;" /></a> <a class="reference internal image-reference" href="../_images/thonny_interpreter.jpg"><img alt="alternate text" src="../_images/thonny_interpreter.jpg" style="width: 600px; height: 450px;" /></a>
</div> </figure>
<p>5- New buttons appeared, selected <strong>“locate another python executable “</strong></p> <p>5- New buttons appeared, selected <strong>“locate another python executable “</strong></p>
<p>6- A new window opens, find the folder where there is the python 3 file in the virtual environment folder previously created <strong>/home/pi/ohmpi/bin/python3</strong>.</p> <p>6- A new window opens, find the folder where there is the python 3 file in the virtual environment folder previously created <strong>/home/pi/ohmpi/bin/python3</strong>.</p>
<p>7- In the <strong>known interpreter</strong> tab the path of the virtual environnementshould appear</p> <p>7- In the <strong>known interpreter</strong> tab the path of the virtual environnementshould appear</p>
<div class="align-center figure"> <figure class="align-center">
<a class="reference internal image-reference" href="../_images/thonny_interpreter_folder.jpg"><img alt="alternate text" src="../_images/thonny_interpreter_folder.jpg" style="width: 600px; height: 450px;" /></a> <a class="reference internal image-reference" href="../_images/thonny_interpreter_folder.jpg"><img alt="alternate text" src="../_images/thonny_interpreter_folder.jpg" style="width: 600px; height: 450px;" /></a>
</div> </figure>
<p>8- Close the window by clicking on <strong>ok</strong>.</p> <p>8- Close the window by clicking on <strong>ok</strong>.</p>
<p>9- Close thonny to save modifications</p> <p>9- Close thonny to save modifications</p>
</div> </section>
</div> </section>
</div> </div>
......
sphinx/build/html/Ohmpi_V2_00/V2_00_step_02.html
+ 562
− 578
View file @ fabc65ea
This diff is collapsed.
sphinx/build/html/Ohmpi_V2_00/V2_00_step_03.html
+ 155
− 163
View file @ fabc65ea
This diff is collapsed.
sphinx/build/html/V1_01.html
+ 425
− 425
View file @ fabc65ea
This diff is collapsed.
sphinx/build/html/V1_02.html
+ 434
− 435
View file @ fabc65ea
This diff is collapsed.
sphinx/build/html/V2_00.html
+ 95
− 103
View file @ fabc65ea
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html4" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>OhmPi V 2.xx (64 or 128 electrodes and 12V) &mdash; Ohmpi: open hardware resistivity-meter documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <title>OhmPi V 2.xx (64 or 128 electrodes and 12V) &mdash; Ohmpi: open hardware resistivity-meter documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'open hardware resistivity-meter',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
...@@ -86,122 +78,122 @@ ...@@ -86,122 +78,122 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="ohmpi-v-2-xx-64-or-128-electrodes-and-12v"> <section id="ohmpi-v-2-xx-64-or-128-electrodes-and-12v">
<h1>OhmPi V 2.xx (64 or 128 electrodes and 12V)<a class="headerlink" href="#ohmpi-v-2-xx-64-or-128-electrodes-and-12v" title="Permalink to this headline"></a></h1> <h1>OhmPi V 2.xx (64 or 128 electrodes and 12V)<a class="headerlink" href="#ohmpi-v-2-xx-64-or-128-electrodes-and-12v" title="Permalink to this headline"></a></h1>
<div class="align-center figure"> <figure class="align-center">
<a class="reference internal image-reference" href="_images/Under-Construction.png"><img alt="Ohmpi 2" src="_images/Under-Construction.png" style="width: 500px; height: 250px;" /></a> <a class="reference internal image-reference" href="_images/Under-Construction.png"><img alt="Ohmpi 2" src="_images/Under-Construction.png" style="width: 500px; height: 250px;" /></a>
</div> </figure>
<div class="align-center figure"> <figure class="align-center">
<a class="reference internal image-reference" href="_images/image_ohmpi_2.jpg"><img alt="Ohmpi 2" src="_images/image_ohmpi_2.jpg" style="width: 800px; height: 600px;" /></a> <a class="reference internal image-reference" href="_images/image_ohmpi_2.jpg"><img alt="Ohmpi 2" src="_images/image_ohmpi_2.jpg" style="width: 800px; height: 600px;" /></a>
</div> </figure>
<div class="admonition note"> <div class="admonition note">
<p class="first admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>In this version, we have developed two new board types that allow the assembly of Ohmpi v2.00, a measurement board and a multiplexer board. <p>In this version, we have developed two new board types that allow the assembly of Ohmpi v2.00, a measurement board and a multiplexer board.
This new version is made up of:</p> This new version is made up of:</p>
<ol class="last arabic simple"> <ol class="arabic simple">
<li>A measurement board for four-point measurement</li> <li><p>A measurement board for four-point measurement</p></li>
<li>4 multiplexer cards</li> <li><p>4 multiplexer cards</p></li>
<li>A box</li> <li><p>A box</p></li>
</ol> </ol>
</div> </div>
<div class="section" id="the-philosophy-of-ohmpi"> <section id="the-philosophy-of-ohmpi">
<h2>The philosophy of Ohmpi<a class="headerlink" href="#the-philosophy-of-ohmpi" title="Permalink to this headline"></a></h2> <h2>The philosophy of Ohmpi<a class="headerlink" href="#the-philosophy-of-ohmpi" title="Permalink to this headline"></a></h2>
<p>The philosophy of Ohmpi V2.00 is to offer a new DIY multielectrode resistivity meter. It is a resistivity meter with 64 electrodes , which can be upgraded to 128 electrodes. <p>The philosophy of Ohmpi V2.00 is to offer a new DIY multielectrode resistivity meter. It is a resistivity meter with 64 electrodes , which can be upgraded to 128 electrodes.
It is limited to low-current injection,but suitable for small laboratory experiments and small field time-lapse monitoring. It is limited to low-current injection,but suitable for small laboratory experiments and small field time-lapse monitoring.
Ohmpi, is developed by a team that seeks to share all its experience and wishes to improve and offer a more and more robust tool to the community.Ohmpi V2.00 is a completely different version from the previous one. Ohmpi, is developed by a team that seeks to share all its experience and wishes to improve and offer a more and more robust tool to the community.Ohmpi V2.00 is a completely different version from the previous one.
We will stop the development on the previous version, to dedicate our efforts on this new version.</p> We will stop the development on the previous version, to dedicate our efforts on this new version.</p>
</div> </section>
<div class="section" id="technical-data"> <section id="technical-data">
<h2>Technical data<a class="headerlink" href="#technical-data" title="Permalink to this headline"></a></h2> <h2>Technical data<a class="headerlink" href="#technical-data" title="Permalink to this headline"></a></h2>
<table border="1" class="docutils"> <table class="docutils align-default">
<colgroup> <colgroup>
<col width="33%" /> <col style="width: 33%" />
<col width="22%" /> <col style="width: 22%" />
<col width="12%" /> <col style="width: 12%" />
<col width="22%" /> <col style="width: 22%" />
<col width="12%" /> <col style="width: 12%" />
</colgroup> </colgroup>
<tbody valign="top"> <tbody>
<tr class="row-odd"><td><strong>Parameter</strong></td> <tr class="row-odd"><td><p><strong>Parameter</strong></p></td>
<td><dl class="first last docutils"> <td><dl class="simple">
<dt><strong>Specifications</strong></dt> <dt><strong>Specifications</strong></dt><dd><p><strong>V1</strong></p>
<dd><strong>V1</strong></dd> </dd>
</dl> </dl>
</td> </td>
<td>Units</td> <td><p>Units</p></td>
<td><dl class="first last docutils"> <td><dl class="simple">
<dt><strong>Specifications</strong></dt> <dt><strong>Specifications</strong></dt><dd><p><strong>V2</strong></p>
<dd><strong>V2</strong></dd> </dd>
</dl> </dl>
</td> </td>
<td>Units</td> <td><p>Units</p></td>
</tr> </tr>
<tr class="row-even"><td>Electrodes</td> <tr class="row-even"><td><p>Electrodes</p></td>
<td>32</td> <td><p>32</p></td>
<td>&#160;</td> <td></td>
<td>64 to 128</td> <td><p>64 to 128</p></td>
<td>&#160;</td> <td></td>
</tr> </tr>
<tr class="row-odd"><td>Operating temperature</td> <tr class="row-odd"><td><p>Operating temperature</p></td>
<td>-0 to 50</td> <td><p>-0 to 50</p></td>
<td>°c</td> <td><p>°c</p></td>
<td>-25 to 50</td> <td><p>-25 to 50</p></td>
<td>°c</td> <td><p>°c</p></td>
</tr> </tr>
<tr class="row-even"><td>Power consumption of CPU and <tr class="row-even"><td><p>Power consumption of CPU and
control system</td> control system</p></td>
<td>18.5</td> <td><p>18.5</p></td>
<td>W</td> <td><p>W</p></td>
<td>18.5</td> <td><p>18.5</p></td>
<td>W</td> <td><p>W</p></td>
</tr> </tr>
<tr class="row-odd"><td>Voltage injection</td> <tr class="row-odd"><td><p>Voltage injection</p></td>
<td>12</td> <td><p>12</p></td>
<td>V</td> <td><p>V</p></td>
<td>12</td> <td><p>12</p></td>
<td>V</td> <td><p>V</p></td>
</tr> </tr>
<tr class="row-even"><td>Battery</td> <tr class="row-even"><td><p>Battery</p></td>
<td>9</td> <td><p>9</p></td>
<td>V</td> <td><p>V</p></td>
<td>12</td> <td><p>12</p></td>
<td>V</td> <td><p>V</p></td>
</tr> </tr>
<tr class="row-odd"><td>Current</td> <tr class="row-odd"><td><p>Current</p></td>
<td>0 to 40</td> <td><p>0 to 40</p></td>
<td>mA</td> <td><p>mA</p></td>
<td>0 to 40</td> <td><p>0 to 40</p></td>
<td>mA</td> <td><p>mA</p></td>
</tr> </tr>
<tr class="row-even"><td>Min pulse duration</td> <tr class="row-even"><td><p>Min pulse duration</p></td>
<td>150</td> <td><p>150</p></td>
<td>mS</td> <td><p>mS</p></td>
<td>150</td> <td><p>150</p></td>
<td>mS</td> <td><p>mS</p></td>
</tr> </tr>
<tr class="row-odd"><td>Input impedance</td> <tr class="row-odd"><td><p>Input impedance</p></td>
<td>80</td> <td><p>80</p></td>
<td>Mohm</td> <td><p>Mohm</p></td>
<td>80</td> <td><p>80</p></td>
<td>Mohm</td> <td><p>Mohm</p></td>
</tr> </tr>
<tr class="row-even"><td>Data storage</td> <tr class="row-even"><td><p>Data storage</p></td>
<td>micro SD card</td> <td><p>micro SD card</p></td>
<td>&#160;</td> <td></td>
<td>micro SD card</td> <td><p>micro SD card</p></td>
<td>&#160;</td> <td></td>
</tr> </tr>
<tr class="row-odd"><td>Resolution</td> <tr class="row-odd"><td><p>Resolution</p></td>
<td>O.O1</td> <td><p>O.O1</p></td>
<td>ohm</td> <td><p>ohm</p></td>
<td>O.O1</td> <td><p>O.O1</p></td>
<td>ohm</td> <td><p>ohm</p></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</div> </section>
<div class="section" id="ohmpi-2-step-by-step"> <section id="ohmpi-2-step-by-step">
<h2>Ohmpi 2 step by step<a class="headerlink" href="#ohmpi-2-step-by-step" title="Permalink to this headline"></a></h2> <h2>Ohmpi 2 step by step<a class="headerlink" href="#ohmpi-2-step-by-step" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="Ohmpi_V2_00/V2_00_step_01.html"><strong>STEP n°1</strong> : Raspberry Pi configuration</a><ul> <li class="toctree-l1"><a class="reference internal" href="Ohmpi_V2_00/V2_00_step_01.html"><strong>STEP n°1</strong> : Raspberry Pi configuration</a><ul>
...@@ -229,8 +221,8 @@ control system</td> ...@@ -229,8 +221,8 @@ control system</td>
</li> </li>
</ul> </ul>
</div> </div>
</div> </section>
</div> </section>
</div> </div>
......
sphinx/build/html/_images/00_mes_board_components1.jpg 0 → 100644
+ 0
− 0
View file @ fabc65ea
sphinx/build/html/_images/00_mes_board_components1.jpg

343 KB

sphinx/build/html/_sources/Ohmpi_V2_00/V2_00_step_03.rst.txt 0 → 100644
+ 24
− 0
View file @ fabc65ea
**STEP n°3**: MUX board
****************************************************
**PART A** Assembly of MUX board
======================================================
Required components
----------------------------------------------------
.. figure:: step_n_3/a/00_mes_board_components.jpg
:width: 600px
:align: center
:height: 450px
:alt: alternate text
:figclass: align-center
.. csv-table:: List of components
:file: step_n_3/a/MUX_board_list_2_xx.csv
:widths: 30, 70, 70, 70, 70, 35, 35
:header-rows: 1
\ No newline at end of file
sphinx/build/html/_static/basic.css
+ 304
− 48
View file @ fabc65ea
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment