Skip to content

Commit 73f97d6

Browse files
committed
Deploying to gh-pages from @ d119578 🚀
1 parent c643241 commit 73f97d6

File tree

5 files changed

+12
-19
lines changed

5 files changed

+12
-19
lines changed

.doctrees/environment.pickle

-36 Bytes
Binary file not shown.

.doctrees/user_guide.doctree

-574 Bytes
Binary file not shown.

_sources/user_guide.md.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22

33
## Installation
44

5-
### Using the Python Package Index
5+
### Using GitHub
66

7-
* The most recent version can be installed uing:
8-
9-
`pip install cardioception`
10-
11-
* The current development branch can be installed using:
7+
The current development branch can be installed using:
128

139
`pip install git+https://github.com/embodied-computation-group/Cardioception.git`
1410

11+
This will install the official version maintained by the Embodied Computation Group.
12+
1513
### Set up a conda environment
1614

1715
The task can be installed in a new environment using the `environment.yml` file that you can find at the root of the directory. Using the Anaconda prompt, you can create a new environment with:
@@ -54,7 +52,7 @@ In addition, some function for HTML reports will require:
5452
The version provided here are the ones used when testing and runing cardioception locally, and are often the last ones. For several packages however, older version might also be compatibles.
5553
```
5654

57-
Cardioception will automatically copy the images and sound files necessary to run the task correctly (~ 160 Mo). These files will be removed if you uninstall the package using `pip uninstall cardioception`.
55+
Cardioception will automatically copy the images and sound files necessary to run the task correctly (~ 160 Mo). These files will be removed if you uninstall the package.
5856

5957
## Physiological recording
6058

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

user_guide.html

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -482,16 +482,11 @@
482482
<h1>User guide<a class="headerlink" href="#user-guide" title="Permalink to this heading">#</a></h1>
483483
<section id="installation">
484484
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h2>
485-
<section id="using-the-python-package-index">
486-
<h3>Using the Python Package Index<a class="headerlink" href="#using-the-python-package-index" title="Permalink to this heading">#</a></h3>
487-
<ul>
488-
<li><p>The most recent version can be installed uing:</p>
489-
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">cardioception</span></code></p>
490-
</li>
491-
<li><p>The current development branch can be installed using:</p>
485+
<section id="using-github">
486+
<h3>Using GitHub<a class="headerlink" href="#using-github" title="Permalink to this heading">#</a></h3>
487+
<p>The current development branch can be installed using:</p>
492488
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">git+https://github.com/embodied-computation-group/Cardioception.git</span></code></p>
493-
</li>
494-
</ul>
489+
<p>This will install the official version maintained by the Embodied Computation Group.</p>
495490
</section>
496491
<section id="set-up-a-conda-environment">
497492
<h3>Set up a conda environment<a class="headerlink" href="#set-up-a-conda-environment" title="Permalink to this heading">#</a></h3>
@@ -533,7 +528,7 @@ <h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to t
533528
<p class="admonition-title">Note</p>
534529
<p>The version provided here are the ones used when testing and runing cardioception locally, and are often the last ones. For several packages however, older version might also be compatibles.</p>
535530
</div>
536-
<p>Cardioception will automatically copy the images and sound files necessary to run the task correctly (~ 160 Mo). These files will be removed if you uninstall the package using <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">uninstall</span> <span class="pre">cardioception</span></code>.</p>
531+
<p>Cardioception will automatically copy the images and sound files necessary to run the task correctly (~ 160 Mo). These files will be removed if you uninstall the package.</p>
537532
</section>
538533
<section id="physiological-recording">
539534
<h2>Physiological recording<a class="headerlink" href="#physiological-recording" title="Permalink to this heading">#</a></h2>
@@ -640,7 +635,7 @@ <h2>Creating HTML reports<a class="headerlink" href="#creating-html-reports" tit
640635
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
641636
<ul class="visible nav section-nav flex-column">
642637
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a><ul class="nav section-nav flex-column">
643-
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-the-python-package-index">Using the Python Package Index</a></li>
638+
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#using-github">Using GitHub</a></li>
644639
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#set-up-a-conda-environment">Set up a conda environment</a></li>
645640
</ul>
646641
</li>

0 commit comments

Comments
 (0)