Skip to content

Commit

Permalink
new first page of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dokato committed Aug 13, 2015
1 parent f173707 commit 8cfe7b3
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 12 deletions.
9 changes: 6 additions & 3 deletions doc/html/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ You can find it and download from `GitHub
<https://github.com/dokato/connectivipy>`_.

*Connectivity estimation is one of the most important problem in EEG/MEG
studies. Many estimators work correctly in different applications and
this is python tool which allows to have them in one place. ConnectiviPy
is light and extendable module open for many data formats.*
studies. Many estimators work correctly in different applications, so it's
convenient to have them all in one tool. ConnectiviPy
is light and extendable python module open for many data formats. In
opposite to other packages it allows you to work with all types of data,
not only biomedical. Calculations base on numpy and scipy what provides
good efficiency.*


Contents:
Expand Down
Binary file removed doc/html/_static/connpy2.jpg
Binary file not shown.
Binary file removed doc/html/_static/connpy_org.png
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/html/conn.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
<em>calculate</em> method and <em>values_range</em> attribute.</p>
<dl class="method">
<dt id="conn.Coherency.calculate">
<code class="descname">calculate</code><span class="sig-paren">(</span><em>data</em>, <em>cnfft=None</em>, <em>cno=None</em>, <em>window=&lt;function hanning at 0x0000000003A335F8&gt;</em>, <em>im=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/conn.html#Coherency.calculate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#conn.Coherency.calculate" title="Permalink to this definition"></a></dt>
<code class="descname">calculate</code><span class="sig-paren">(</span><em>data</em>, <em>cnfft=None</em>, <em>cno=None</em>, <em>window=&lt;function hanning at 0x00000000039C05F8&gt;</em>, <em>im=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/conn.html#Coherency.calculate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#conn.Coherency.calculate" title="Permalink to this definition"></a></dt>
<dd><p>Coherency calculation using FFT mehtod.
Args:</p>
<blockquote>
Expand Down Expand Up @@ -217,7 +217,7 @@
<em>calculate</em> method.</p>
<dl class="method">
<dt id="conn.PSI.calculate">
<code class="descname">calculate</code><span class="sig-paren">(</span><em>data</em>, <em>band_width=4</em>, <em>psinfft=None</em>, <em>psino=0</em>, <em>window=&lt;function hanning at 0x0000000003A335F8&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/conn.html#PSI.calculate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#conn.PSI.calculate" title="Permalink to this definition"></a></dt>
<code class="descname">calculate</code><span class="sig-paren">(</span><em>data</em>, <em>band_width=4</em>, <em>psinfft=None</em>, <em>psino=0</em>, <em>window=&lt;function hanning at 0x00000000039C05F8&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/conn.html#PSI.calculate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#conn.PSI.calculate" title="Permalink to this definition"></a></dt>
<dd><p>Phase Slope Index calculation using FFT mehtod.
Args:</p>
<blockquote>
Expand Down
9 changes: 6 additions & 3 deletions doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,12 @@ <h1>ConnectiviPy documentation<a class="headerlink" href="#connectivipy-document
<p>Python connectivity module. It is a part of GSOC 2015 project.</p>
<p>You can find it and download from <a class="reference external" href="https://github.com/dokato/connectivipy">GitHub</a>.</p>
<p><em>Connectivity estimation is one of the most important problem in EEG/MEG
studies. Many estimators work correctly in different applications and
this is python tool which allows to have them in one place. ConnectiviPy
is light and extendable module open for many data formats.</em></p>
studies. Many estimators work correctly in different applications, so it&#8217;s
convenient to have them all in one tool. ConnectiviPy
is light and extendable python module open for many data formats. In
opposite to other packages it allows you to work with all types of data,
not only biomedical. Calculations base on numpy and scipy what provides
good efficiency.</em></p>
<div class="section" id="contents">
<h2>Contents:<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
Expand Down
Binary file modified doc/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ You can find it and download from `GitHub
<https://github.com/dokato/connectivipy>`_.

*Connectivity estimation is one of the most important problem in EEG/MEG
studies. Many estimators work correctly in different applications and
this is python tool which allows to have them in one place. ConnectiviPy
is light and extendable module open for many data formats.*
studies. Many estimators work correctly in different applications, so it's
convenient to have them all in one tool. ConnectiviPy
is light and extendable python module open for many data formats. In
opposite to other packages it allows you to work with all types of data,
not only biomedical. Calculations base on numpy and scipy what provides
good efficiency.*


Contents:
Expand Down

0 comments on commit 8cfe7b3

Please sign in to comment.