Rename the pipeline to RAPIDS

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# moshi-aware documentation build configuration file, created by
+# RAPIDS documentation build configuration file, created by
 # sphinx-quickstart.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -41,7 +41,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Pipeline'
+project = u'RAPIDS'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -164,7 +164,7 @@ html_static_path = ['_static']
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'moshi-awaredoc'
+htmlhelp_basename = 'rapidsdoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -184,9 +184,9 @@ latex_elements = {
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
     ('index',
-     'moshi-aware.tex',
-     u'moshi-aware Documentation',
-     u"Moshi", 'manual'),
+     'rapids.tex',
+     u'RAPIDS Documentation',
+     u"RAPIDS", 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -215,8 +215,8 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'moshi-aware', u'moshi-aware Documentation',
-     [u"Moshi"], 1)
+    ('index', 'RAPIDS', u'RAPIDS Documentation',
+     [u"RAPIDS"], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -229,9 +229,9 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'moshi-aware', u'moshi-aware Documentation',
-     u"Moshi", 'moshi-aware',
-     'Data cleaning, feature engineering and analysis for Aware sensors', 'Miscellaneous'),
+    ('index', 'RAPIDS', u'RAPIDS Documentation',
+     u"RAPIDS", 'RAPIDS',
+     'Reproducible Analysis Pipeline for Data Streams', 'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

docs/features/extracted.rst

@@ -6,7 +6,7 @@ Accelerometer
 
 Available epochs: daily, morning, afternoon, evening, and night
 
-- Max magnitude: maximum magnitude of acceleration (note: |acceleration| = sqrt(x^2 + y^2 + z^2))
+- Max magnitude: maximum magnitude of acceleration (:math:`\|acceleration\| = \sqrt{x^2 + y^2 + z^2}`)
 - Min magnitude: minimum magnitude of acceleration
 - Avg magnitude: average magnitude of acceleration
 - Median magnitude: median magnitude of acceleration

docs/index.rst

@@ -6,7 +6,7 @@
 RAPIDS
 ======
 
-**R**eproducible **A**nalysis **Pi**pline for Data Streams
+**R**\ eproducible **A**\ nalysis **Pi**\ pline for **D**\ ata **S**\ treams
 
 Contents:
 

docs/usage/installation.rst

@@ -18,13 +18,14 @@ Mac OS (tested on Catalina)
     - ``R -e 'install.packages(c( "rmarkdown"), repos = "http://cran.us.r-project.org")'``
 
 #. Install miniconda:
+
     - ``brew cask install miniconda``
     - ``conda init zsh`` or ``conda init bash``
     - Restart terminal if necessary
 
 #. Clone our repo:
 
-    - ``git clone https://github.com/carissalow/moshi-aware-pipeline``
+    - ``git clone https://github.com/carissalow/rapids``
 
 #. Create a python virtual environment:
 
@@ -43,6 +44,7 @@ Mac OS (tested on Catalina)
     - Add a line with the device_id(s) of that participant as it appears on the database. If multiple device ids, all data for this participant will be relabeled with the last one
     - Add a line with the mobile platform (android, or ios)
     - For example:
+
         .. code-block:: bash
 
             3a7b0d0a-a9ce-4059-ab98-93a7b189da8a,44f20139-50cc-4b13-bdde-0d5a3889e8f9
@@ -51,7 +53,8 @@ Mac OS (tested on Catalina)
 #. Configure the db connection:
 
     - Create an empty .env file in the root folder
-    - Add and complete the following lines
+    - Add and complete the following lines:
+
         | ``[MY_GROUP_NAME]``
         | ``user=MyUSER``
         | ``password=MyPassword``
@@ -62,6 +65,7 @@ Linux (tested on Ubuntu 16.04)
 ------------------------------
 
 #. Install dependenies:
+
     - ``sudo apt-get install libmariadb-client-lgpl-dev libxml2-dev libssl-dev``
     - Install brew_ for linux and add the following line to ~/.bashrc: ``export PATH=$HOME/.linuxbrew/bin:$PATH``
     - ``source ~/.bashrc``
@@ -82,7 +86,7 @@ Linux (tested on Ubuntu 16.04)
 
 #. Clone our repo:
 
-    - ``git clone https://github.com/carissalow/moshi-aware-pipeline``
+    - ``git clone https://github.com/carissalow/rapids``
 
 #. Create a python virtual environment:
 
@@ -101,6 +105,7 @@ Linux (tested on Ubuntu 16.04)
     - Add a line with the device_id(s) of that participant as it appears on the database. If multiple device ids, all data for this participant will be relabeled with the last one
     - Add a line with the mobile platform (android, or ios)
     - For example:
+
         .. code-block:: bash
 
             3a7b0d0a-a9ce-4059-ab98-93a7b189da8a,44f20139-50cc-4b13-bdde-0d5a3889e8f9
@@ -109,7 +114,8 @@ Linux (tested on Ubuntu 16.04)
 #. Configure the db connection:
 
     - Create an empty .env file in the root folder
-    - Add and complete the following lines
+    - Add and complete the following lines:
+
         | ``[MY_GROUP_NAME]``
         | ``user=MyUSER``
         | ``password=MyPassword``