change docs

README.md

@@ -22,7 +22,7 @@ Few steps are required to extract the morphological ECG biomarkers, thos steps a
 
 ![alt text](https://github.com/SheinaG/pebm_new/blob/master/ecg_wth_bio.png?raw=true)
 
-4. Summary Statistics - For a specified time window the five summary statistics (median, min, max, Ql and Q3) are computed for all ECG biomarkers.
+4. Summary Statistics - For a specified time window the six summary statistics (mean, median, min, max, IQR and std) are computed for all ECG biomarkers.
 
 
 ## Installation
@@ -38,13 +38,11 @@ pip project: pip install -i https://test.pypi.org/simple/ pebm
 
 Python >= 3.6
 
-numpy == 1.20.2
+numpy 
 
-mne == 0.23.0
+mne 
 
-scipy == 1.7.0
-
-wfdb == 3.4.0
+wfdb 
 
 All the python requirements exept wfdb are installed when the toolbox is installed. To install wfbd run: pip install wfdb
 ### System Requirements:
@@ -53,6 +51,14 @@ To run the wavdet fiucial-points detector matlab runtime (MCR) 2021a is requierd
 
 To run the epltd peak detector additional wfdb toolbox is requierd. https://archive.physionet.org/physiotools/wfdb-linux-quick-start.shtml
 
+## Instractions for installation:
+
+1. Install the "pecg" package using pip by running the command line: "pip install pecg".
+
+2. Install the "wfdb" package using pip by running the command line: "pip install wfdb".
+
+3. Follow the guidelines provided in the link: https://www.mathworks.com/products/compiler/matlab-runtime.html, and choose the version of 2021a(9.10).
+
 ## Documentation
 
 https://pecg.readthedocs.io/en/latest/pecg.html

docs/README.rst

@@ -26,7 +26,7 @@ Few steps are required to extract the morphological ECG biomarkers, thos steps a
   :width: 600
 
 
-4. Summary Statistics - For a specified time window the five summary statistics (median, min, max, Ql and Q3) are computed for all ECG biomarkers.
+4. Summary Statistics - For a specified time window the six summary statistics (mean, median, min, max, IQR and std) are computed for all ECG biomarkers.
 
 Installation
 -----------------------
@@ -40,13 +40,11 @@ Requirements
 
 Python >= 3.6
 
-numpy == 1.20.2
+numpy 
 
-mne == 0.23.0
+mne 
 
-scipy == 1.7.0
-
-wfdb == 3.4.0
+wfdb 
 
 All the python requirements exept wfdb are installed when the toolbox is installed. To install wfbd run: pip install wfdb
 
@@ -67,7 +65,18 @@ If you wish to use the epltd peak detector `additional wfdb toolbox`_ is requier
 
 If you don't want or can't install this - It's Ok! you can use another peak detectors from the package.
 
+Instractions for installation:
+------------------------------
+
+1. Install the "pecg" package using pip by running the command line: "pip install pecg".
+
+2. Install the "wfdb" package using pip by running the command line: "pip install wfdb".
+
+3. Follow the guidelines provided in the link: https://www.mathworks.com/products/compiler/matlab-runtime.html, and choose the version of 2021a(9.10).
+
 Documentation
 ------------------------
 
 https://pecg.readthedocs.io/en/latest/
+
+

docs/build/README.html

@@ -179,7 +179,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 </ol>
 <a class="reference internal image-reference" href="_images/ecg_wth_bio.png"><img alt="_images/ecg_wth_bio.png" src="_images/ecg_wth_bio.png" style="width: 600px;" /></a>
 <ol class="arabic simple" start="4">
-<li><p>Summary Statistics - For a specified time window the five summary statistics (median, min, max, Ql and Q3) are computed for all ECG biomarkers.</p></li>
+<li><p>Summary Statistics - For a specified time window the six summary statistics (mean, median, min, max, IQR and std) are computed for all ECG biomarkers.</p></li>
 </ol>
 </div>
 <div class="section" id="installation">
@@ -190,10 +190,9 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <div class="section" id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
 <p>Python &gt;= 3.6</p>
-<p>numpy == 1.20.2</p>
-<p>mne == 0.23.0</p>
-<p>scipy == 1.7.0</p>
-<p>wfdb == 3.4.0</p>
+<p>numpy</p>
+<p>mne</p>
+<p>wfdb</p>
 <p>All the python requirements exept wfdb are installed when the toolbox is installed. To install wfbd run: pip install wfdb</p>
 </div>
 <div class="section" id="system-requirements">
@@ -203,6 +202,14 @@ <h2>System Requirements<a class="headerlink" href="#system-requirements" title="
 <p>If you wish to use the epltd peak detector <a class="reference external" href="https://archive.physionet.org/physiotools/wfdb-linux-quick-start.shtml.">additional wfdb toolbox</a> is requierd.</p>
 <p>If you don’t want or can’t install this - It’s Ok! you can use another peak detectors from the package.</p>
 </div>
+<div class="section" id="instractions-for-installation">
+<h2>Instractions for installation:<a class="headerlink" href="#instractions-for-installation" title="Permalink to this heading">¶</a></h2>
+<ol class="arabic simple">
+<li><p>Install the “pecg” package using pip by running the command line: “pip install pecg”.</p></li>
+<li><p>Install the “wfdb” package using pip by running the command line: “pip install wfdb”.</p></li>
+<li><p>Follow the guidelines provided in the link: <a class="reference external" href="https://www.mathworks.com/products/compiler/matlab-runtime.html">https://www.mathworks.com/products/compiler/matlab-runtime.html</a>, and choose the version of 2021a(9.10).</p></li>
+</ol>
+</div>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h2>
 <p><a class="reference external" href="https://pecg.readthedocs.io/en/latest/">https://pecg.readthedocs.io/en/latest/</a></p>

docs/build/_sources/README.rst.txt

@@ -26,7 +26,7 @@ Few steps are required to extract the morphological ECG biomarkers, thos steps a
   :width: 600
 
 
-4. Summary Statistics - For a specified time window the five summary statistics (median, min, max, Ql and Q3) are computed for all ECG biomarkers.
+4. Summary Statistics - For a specified time window the six summary statistics (mean, median, min, max, IQR and std) are computed for all ECG biomarkers.
 
 Installation
 -----------------------
@@ -40,13 +40,11 @@ Requirements
 
 Python >= 3.6
 
-numpy == 1.20.2
+numpy 
 
-mne == 0.23.0
+mne 
 
-scipy == 1.7.0
-
-wfdb == 3.4.0
+wfdb 
 
 All the python requirements exept wfdb are installed when the toolbox is installed. To install wfbd run: pip install wfdb
 
@@ -67,7 +65,18 @@ If you wish to use the epltd peak detector `additional wfdb toolbox`_ is requier
 
 If you don't want or can't install this - It's Ok! you can use another peak detectors from the package.
 
+Instractions for installation:
+------------------------------
+
+1. Install the "pecg" package using pip by running the command line: "pip install pecg".
+
+2. Install the "wfdb" package using pip by running the command line: "pip install wfdb".
+
+3. Follow the guidelines provided in the link: https://www.mathworks.com/products/compiler/matlab-runtime.html, and choose the version of 2021a(9.10).
+
 Documentation
 ------------------------
 
 https://pecg.readthedocs.io/en/latest/
+
+

docs/build/index.html

@@ -180,7 +180,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 </ol>
 <a class="reference internal image-reference" href="_images/ecg_wth_bio.png"><img alt="_images/ecg_wth_bio.png" src="_images/ecg_wth_bio.png" style="width: 600px;" /></a>
 <ol class="arabic simple" start="4">
-<li><p>Summary Statistics - For a specified time window the five summary statistics (median, min, max, Ql and Q3) are computed for all ECG biomarkers.</p></li>
+<li><p>Summary Statistics - For a specified time window the six summary statistics (mean, median, min, max, IQR and std) are computed for all ECG biomarkers.</p></li>
 </ol>
 </div>
 <div class="section" id="installation">
@@ -191,10 +191,9 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <div class="section" id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
 <p>Python &gt;= 3.6</p>
-<p>numpy == 1.20.2</p>
-<p>mne == 0.23.0</p>
-<p>scipy == 1.7.0</p>
-<p>wfdb == 3.4.0</p>
+<p>numpy</p>
+<p>mne</p>
+<p>wfdb</p>
 <p>All the python requirements exept wfdb are installed when the toolbox is installed. To install wfbd run: pip install wfdb</p>
 </div>
 <div class="section" id="system-requirements">
@@ -204,6 +203,14 @@ <h2>System Requirements<a class="headerlink" href="#system-requirements" title="
 <p>If you wish to use the epltd peak detector <a class="reference external" href="https://archive.physionet.org/physiotools/wfdb-linux-quick-start.shtml.">additional wfdb toolbox</a> is requierd.</p>
 <p>If you don’t want or can’t install this - It’s Ok! you can use another peak detectors from the package.</p>
 </div>
+<div class="section" id="instractions-for-installation">
+<h2>Instractions for installation:<a class="headerlink" href="#instractions-for-installation" title="Permalink to this heading">¶</a></h2>
+<ol class="arabic simple">
+<li><p>Install the “pecg” package using pip by running the command line: “pip install pecg”.</p></li>
+<li><p>Install the “wfdb” package using pip by running the command line: “pip install wfdb”.</p></li>
+<li><p>Follow the guidelines provided in the link: <a class="reference external" href="https://www.mathworks.com/products/compiler/matlab-runtime.html">https://www.mathworks.com/products/compiler/matlab-runtime.html</a>, and choose the version of 2021a(9.10).</p></li>
+</ol>
+</div>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h2>
 <p><a class="reference external" href="https://pecg.readthedocs.io/en/latest/">https://pecg.readthedocs.io/en/latest/</a></p>