Skip to content

GitLab

OhmPi
OhmPi
Commit c8bbaccc authored by remi.clement's avatar remi.clement
Browse files
Options

update documentation of ohmpi V1.00

parent 75c80b98
Hide whitespace changes
Inline Side-by-side
Showing with 100 additions and 67 deletions
sphinx/build/html/_sources/index.rst.txt
View file @ c8bbaccc
......@@ -7,6 +7,8 @@ OHMPI: Open source and open hardware resitivity-meter
=====================================================
.. image:: logo_ohmpi.JPG
:width: 200px
:height: 200px
:align: center
Contents:
......
sphinx/build/html/_sources/page0.rst.txt
View file @ c8bbaccc
......@@ -12,8 +12,13 @@ Premiere page
**Introduction to OhmPi**
*************************
This article 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 meter features current injection and measurement functions associated with a multiplexer /
that allows performing automatic measurements with up to 32 electrodes
This article 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 meter\
features 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.
.. note::
Everyone willing to get involved is welcome in ohmPi Project!.
\ No newline at end of file
sphinx/build/html/_sources/page1.rst.txt
View file @ c8bbaccc
************
Seconde page
************
**************
OhmPi V 1.01
**************
Formule
*******
OS installation on a Raspberry Pi
******************************************
.. math::
\sum_{a}^{b} x_n = c_1 + c_2^3 + \cos(\pi)
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
https://www.raspberrypi.org/help/noobs-setup/2/). The authors recommend installing the latest
stable and complete version of Raspbian by using NOOBS (a simple-to-use operating system installer).
Once the OS has been installed, the 1-wire option and GPIO remote option must be deactivated via the
Raspbian GUI settings menu. Failure to carry out this task may cause damage to the relay shield cards during measurements.
Image
*****
......@@ -19,5 +23,3 @@ Texte
Voici un second texte pour notre Démo.
.. note::
J'espère que cela vous parle un peu plus que la présentation présente.
\ No newline at end of file
sphinx/build/html/genindex.html
View file @ c8bbaccc
......@@ -30,7 +30,6 @@
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
......@@ -83,7 +82,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">Seconde page</a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">OhmPi V 1.01</a></li>
</ul>
......
sphinx/build/html/index.html
View file @ c8bbaccc
......@@ -30,7 +30,6 @@
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
......@@ -84,7 +83,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">Seconde page</a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">OhmPi V 1.01</a></li>
</ul>
......@@ -152,13 +151,13 @@
<div class="section" id="ohmpi-open-source-and-open-hardware-resitivity-meter">
<h1>OHMPI: Open source and open hardware resitivity-meter<a class="headerlink" href="#ohmpi-open-source-and-open-hardware-resitivity-meter" title="Permalink to this headline"></a></h1>
<img alt="_images/logo_ohmpi.JPG" class="align-center" src="_images/logo_ohmpi.JPG" />
<a class="reference internal image-reference" href="_images/logo_ohmpi.JPG"><img alt="_images/logo_ohmpi.JPG" class="align-center" src="_images/logo_ohmpi.JPG" style="width: 200px; height: 200px;" /></a>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">Seconde page</a><ul>
<li class="toctree-l2"><a class="reference internal" href="page1.html#formule">Formule</a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">OhmPi V 1.01</a><ul>
<li class="toctree-l2"><a class="reference internal" href="page1.html#os-installation-on-a-raspberry-pi">OS installation on a Raspberry Pi</a></li>
<li class="toctree-l2"><a class="reference internal" href="page1.html#image">Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="page1.html#texte">Texte</a></li>
</ul>
......
sphinx/build/html/page0.html
View file @ c8bbaccc
......@@ -30,15 +30,14 @@
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" 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="Seconde page" href="page1.html" />
<link rel="prev" title="OHMPI" href="index.html" />
<link rel="next" title="OhmPi V 1.01" href="page1.html" />
<link rel="prev" title="OHMPI: Open source and open hardware resitivity-meter" href="index.html" />
</head>
<body class="wy-body-for-nav">
......@@ -85,7 +84,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">Seconde page</a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">OhmPi V 1.01</a></li>
</ul>
......@@ -154,10 +153,12 @@
<img alt="_images/logo_ohmpi.JPG" class="align-center" src="_images/logo_ohmpi.JPG" />
<div class="section" id="introduction-to-ohmpi">
<h1><strong>Introduction to OhmPi</strong><a class="headerlink" href="#introduction-to-ohmpi" title="Permalink to this headline"></a></h1>
<p>This article 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 meter features current injection and measurement functions associated with a multiplexer /
that allows performing automatic measurements with up to 32 electrodes</p>
<p>This article 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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Everyone willing to get involved is welcome in ohmPi Project!.</p>
</div>
</div>
......@@ -168,10 +169,10 @@ that allows performing automatic measurements with up to 32 electrodes</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="page1.html" class="btn btn-neutral float-right" title="Seconde page" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="page1.html" class="btn btn-neutral float-right" title="OhmPi V 1.01" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="OHMPI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="index.html" class="btn btn-neutral float-left" title="OHMPI: Open source and open hardware resitivity-meter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
......
sphinx/build/html/page1.html
View file @ c8bbaccc
......@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Seconde page &mdash; Ohmpi: open hardware resistivity-meter documentation</title>
<title>OhmPi V 1.01 &mdash; Ohmpi: open hardware resistivity-meter documentation</title>
......@@ -30,14 +30,13 @@
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Image" href="page0.html" />
<link rel="prev" title="Introduction to OhmPi" href="page0.html" />
</head>
<body class="wy-body-for-nav">
......@@ -83,10 +82,9 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="page0.html">Image</a></li>
<li class="toctree-l1"><a class="reference internal" href="page0.html#introduction-to-ohmpi">Introduction to OhmPi</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Seconde page</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#formule">Formule</a></li>
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">OhmPi V 1.01</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#os-installation-on-a-raspberry-pi">OS installation on a Raspberry Pi</a></li>
<li class="toctree-l2"><a class="reference internal" href="#image">Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="#texte">Texte</a></li>
</ul>
......@@ -137,7 +135,7 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Seconde page</li>
<li>OhmPi V 1.01</li>
<li class="wy-breadcrumbs-aside">
......@@ -156,12 +154,16 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="seconde-page">
<h1>Seconde page<a class="headerlink" href="#seconde-page" title="Permalink to this headline"></a></h1>
<div class="section" id="formule">
<h2>Formule<a class="headerlink" href="#formule" title="Permalink to this headline"></a></h2>
<div class="math notranslate nohighlight">
\[\sum_{a}^{b} x_n = c_1 + c_2^3 + \cos(\pi)\]</div>
<div class="section" id="ohmpi-v-1-01">
<h1>OhmPi V 1.01<a class="headerlink" href="#ohmpi-v-1-01" title="Permalink to this headline"></a></h1>
<div class="section" id="os-installation-on-a-raspberry-pi">
<h2>OS installation on a Raspberry Pi<a class="headerlink" href="#os-installation-on-a-raspberry-pi" title="Permalink to this headline"></a></h2>
<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
<a class="reference external" href="https://www.raspberrypi.org/help/noobs-setup/2/">https://www.raspberrypi.org/help/noobs-setup/2/</a>). The authors recommend installing the latest
stable and complete version of Raspbian by using NOOBS (a simple-to-use operating system installer).
Once the OS has been installed, the 1-wire option and GPIO remote option must be deactivated 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 class="section" id="image">
<h2>Image<a class="headerlink" href="#image" title="Permalink to this headline"></a></h2>
......@@ -170,10 +172,6 @@
<div class="section" id="texte">
<h2>Texte<a class="headerlink" href="#texte" title="Permalink to this headline"></a></h2>
<p>Voici un second texte pour notre Démo.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>J’espère que cela vous parle un peu plus que la présentation présente.</p>
</div>
</div>
</div>
......@@ -186,7 +184,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="page0.html" class="btn btn-neutral float-left" title="Image" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="page0.html" class="btn btn-neutral float-left" title="Introduction to OhmPi" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
......
sphinx/build/html/search.html
View file @ c8bbaccc
......@@ -31,7 +31,6 @@
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
......@@ -85,7 +84,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">Seconde page</a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">OhmPi V 1.01</a></li>
</ul>
......
sphinx/build/html/searchindex.js
View file @ c8bbaccc
Search.setIndex({docnames:["index","page0","page1"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","page0.rst","page1.rst"],objects:{},objnames:{},objtypes:{},terms:{"cr\u00e9er":[],"d\u00e9mo":2,"esp\u00e8r":2,"function":1,"pr\u00e9sent":2,"pr\u00e9sentat":2,"premi\u00e8r":[],allow:1,articl:1,associ:1,automat:1,basic:1,c_1:2,c_2:2,call:1,ceci:[],cela:2,commun:1,consult:[],content:0,cos:2,cost:1,current:1,demo:[],develop:1,doc:[],document:[],electrod:1,est:[],experi:1,featur:1,flexibl:1,fonctionn:[],formul:0,hardwar:1,imag:0,index:0,inform:[],inject:1,introduct:0,introduir:[],invit:[],lien:[],low:1,maxdepth:[],measur:1,meter:1,modul:0,multiplex:1,notr:2,officiel:[],ohmpi:[],open:1,page0:[],page1:[],page:0,parl:2,perform:1,peu:2,plu:2,pour:2,present:1,provid:1,que:2,resist:1,robust:1,scale:1,scientif:1,search:[],second:0,site:[],small:1,sphinx:[],sum_:2,sur:[],text:0,thi:1,toctre:[],tool:1,vise:[],voici:2,vou:2,x_n:2},titles:["OHMPI: Open source and open hardware resitivity-meter","<strong>Introduction to OhmPi</strong>","Seconde page"],titleterms:{bienvenu:[],cett:[],document:[],formul:2,hardwar:0,imag:2,indic:0,introduct:1,lien:[],meter:0,ohmpi:[0,1],open:0,page:2,resit:0,second:2,sourc:0,sur:[],tabl:0,text:2,welcom:[]}})
\ No newline at end of file
Search.setIndex({docnames:["index","page0","page1"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","page0.rst","page1.rst"],objects:{},objnames:{},objtypes:{},terms:{"cr\u00e9er":[],"d\u00e9mo":2,"esp\u00e8r":[],"function":1,"pr\u00e9sent":[],"pr\u00e9sentat":[],"premi\u00e8r":[],For:2,The:2,allow:1,articl:1,associ:1,author:2,automat:1,basic:1,been:2,board:2,c_1:[],c_2:[],call:1,card:2,carri:2,caus:2,ceci:[],cela:[],commun:1,complet:2,consult:[],content:0,cos:[],cost:1,current:1,damag:2,deactiv:2,demo:[],describ:2,develop:1,doc:[],document:[],dure:2,electrod:1,est:[],everyon:1,experi:1,failur:2,featur:[],first:2,flexibl:1,fonctionn:[],formul:[],fulli:1,get:1,gpio:2,gui:2,hardwar:1,hardwareresist:[],has:2,help:2,http:2,imag:0,implement:[],includ:2,index:0,inform:[],inject:1,instal:0,instruct:2,introduct:0,introduir:[],invit:[],involv:1,latest:2,lien:[],low:1,mai:2,maxdepth:[],measur:[1,2],menu:2,meter:1,meterfeatur:1,modul:0,multiplex:1,must:2,noob:2,notr:2,officiel:[],ohmpi:[],onc:2,open:1,oper:2,option:2,org:2,out:2,page0:[],page1:[],page:[],parl:[],perform:1,peu:[],philosophi:1,plu:[],pour:2,present:1,project:1,provid:1,que:[],raspberri:0,raspberrypi:2,raspbian:2,recommend:2,relai:2,remot:2,resist:1,robust:1,scale:1,scientif:1,search:[],second:2,set:2,setup:2,shield:2,simpl:2,site:[],small:1,sourc:1,sphinx:[],stabl:2,start:2,step:2,sum_:[],sur:[],surfac:1,system:2,task:2,text:0,thi:[1,2],toctre:[],tool:1,use:2,using:2,version:2,via:2,vise:[],voici:2,vou:[],websit:2,welcom:1,well:2,willing:1,wire:2,www:2,x_n:[]},titles:["OHMPI: Open source and open hardware resitivity-meter","<strong>Introduction to OhmPi</strong>","OhmPi V 1.01"],titleterms:{bienvenu:[],cett:[],document:[],formul:[],hardwar:0,imag:2,implement:[],indic:0,instal:2,introduct:1,lien:[],meter:0,ohmpi:[0,1,2],open:0,page:[],raspberri:2,resit:0,second:[],sourc:0,sur:[],tabl:0,text:2,welcom:[]}})
\ No newline at end of file
sphinx/source/conf.py
View file @ c8bbaccc
......@@ -14,7 +14,7 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme
from shutil import copyfile
# -- Project information -----------------------------------------------------
project = 'Ohmpi:'
......@@ -53,4 +53,5 @@ html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
\ No newline at end of file
html_static_path = ['_static']
sphinx/source/index.rst
View file @ c8bbaccc
......@@ -7,6 +7,8 @@ OHMPI: Open source and open hardware resitivity-meter
=====================================================
.. image:: logo_ohmpi.JPG
:width: 200px
:height: 200px
:align: center
Contents:
......
sphinx/source/page0.rst
View file @ c8bbaccc
......@@ -12,8 +12,13 @@ Premiere page
**Introduction to OhmPi**
*************************
This article 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 meter features current injection and measurement functions associated with a multiplexer /
that allows performing automatic measurements with up to 32 electrodes
This article 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 meter\
features 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.
.. note::
Everyone willing to get involved is welcome in ohmPi Project!.
\ No newline at end of file
sphinx/source/page1.rst
View file @ c8bbaccc
************
Seconde page
************
**************
OhmPi V 1.01
**************
Formule
*******
OS installation on a Raspberry Pi
******************************************
.. math::
\sum_{a}^{b} x_n = c_1 + c_2^3 + \cos(\pi)
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
https://www.raspberrypi.org/help/noobs-setup/2/). The authors recommend installing the latest
stable and complete version of Raspbian by using NOOBS (a simple-to-use operating system installer).
Once the OS has been installed, the 1-wire option and GPIO remote option must be deactivated via the
Raspbian GUI settings menu. Failure to carry out this task may cause damage to the relay shield cards during measurements.
Image
*****
......@@ -19,5 +23,3 @@ Texte
Voici un second texte pour notre Démo.
.. note::
J'espère que cela vous parle un peu plus que la présentation présente.
\ No newline at end of file
sphinx/source/ref.txt 0 → 100644
View file @ c8bbaccc
************
OhmPi V 1.01 Implementation
************
Image
*****
.. image:: logo_ohmpi.JPG
:align: center
Texte
*****
Voici un second texte pour notre Démo.
.. note::
J'espère que cela vous parle un peu plus que la présentation présente.
\ No newline at end of file
Markdown is supported
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