Rename the pipeline to RAPIDS
parent
8fb2cd0ca0
commit
1cbcfcca52
22
docs/conf.py
22
docs/conf.py
|
@ -1,6 +1,6 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# moshi-aware documentation build configuration file, created by
|
# RAPIDS documentation build configuration file, created by
|
||||||
# sphinx-quickstart.
|
# sphinx-quickstart.
|
||||||
#
|
#
|
||||||
# This file is execfile()d with the current directory set to its containing dir.
|
# This file is execfile()d with the current directory set to its containing dir.
|
||||||
|
@ -41,7 +41,7 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Pipeline'
|
project = u'RAPIDS'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
@ -164,7 +164,7 @@ html_static_path = ['_static']
|
||||||
# html_file_suffix = None
|
# html_file_suffix = None
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'moshi-awaredoc'
|
htmlhelp_basename = 'rapidsdoc'
|
||||||
|
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
@ -184,9 +184,9 @@ latex_elements = {
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index',
|
('index',
|
||||||
'moshi-aware.tex',
|
'rapids.tex',
|
||||||
u'moshi-aware Documentation',
|
u'RAPIDS Documentation',
|
||||||
u"Moshi", 'manual'),
|
u"RAPIDS", 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# 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
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
('index', 'moshi-aware', u'moshi-aware Documentation',
|
('index', 'RAPIDS', u'RAPIDS Documentation',
|
||||||
[u"Moshi"], 1)
|
[u"RAPIDS"], 1)
|
||||||
]
|
]
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
# If true, show URL addresses after external links.
|
||||||
|
@ -229,9 +229,9 @@ man_pages = [
|
||||||
# (source start file, target name, title, author,
|
# (source start file, target name, title, author,
|
||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
('index', 'moshi-aware', u'moshi-aware Documentation',
|
('index', 'RAPIDS', u'RAPIDS Documentation',
|
||||||
u"Moshi", 'moshi-aware',
|
u"RAPIDS", 'RAPIDS',
|
||||||
'Data cleaning, feature engineering and analysis for Aware sensors', 'Miscellaneous'),
|
'Reproducible Analysis Pipeline for Data Streams', 'Miscellaneous'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
# Documents to append as an appendix to all manuals.
|
||||||
|
|
|
@ -6,7 +6,7 @@ Accelerometer
|
||||||
|
|
||||||
Available epochs: daily, morning, afternoon, evening, and night
|
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
|
- Min magnitude: minimum magnitude of acceleration
|
||||||
- Avg magnitude: average magnitude of acceleration
|
- Avg magnitude: average magnitude of acceleration
|
||||||
- Median magnitude: median magnitude of acceleration
|
- Median magnitude: median magnitude of acceleration
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
RAPIDS
|
RAPIDS
|
||||||
======
|
======
|
||||||
|
|
||||||
**R**eproducible **A**nalysis **Pi**pline for Data Streams
|
**R**\ eproducible **A**\ nalysis **Pi**\ pline for **D**\ ata **S**\ treams
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
|
|
|
@ -18,13 +18,14 @@ Mac OS (tested on Catalina)
|
||||||
- ``R -e 'install.packages(c( "rmarkdown"), repos = "http://cran.us.r-project.org")'``
|
- ``R -e 'install.packages(c( "rmarkdown"), repos = "http://cran.us.r-project.org")'``
|
||||||
|
|
||||||
#. Install miniconda:
|
#. Install miniconda:
|
||||||
|
|
||||||
- ``brew cask install miniconda``
|
- ``brew cask install miniconda``
|
||||||
- ``conda init zsh`` or ``conda init bash``
|
- ``conda init zsh`` or ``conda init bash``
|
||||||
- Restart terminal if necessary
|
- Restart terminal if necessary
|
||||||
|
|
||||||
#. Clone our repo:
|
#. Clone our repo:
|
||||||
|
|
||||||
- ``git clone https://github.com/carissalow/moshi-aware-pipeline``
|
- ``git clone https://github.com/carissalow/rapids``
|
||||||
|
|
||||||
#. Create a python virtual environment:
|
#. 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 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)
|
- Add a line with the mobile platform (android, or ios)
|
||||||
- For example:
|
- For example:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
3a7b0d0a-a9ce-4059-ab98-93a7b189da8a,44f20139-50cc-4b13-bdde-0d5a3889e8f9
|
3a7b0d0a-a9ce-4059-ab98-93a7b189da8a,44f20139-50cc-4b13-bdde-0d5a3889e8f9
|
||||||
|
@ -51,7 +53,8 @@ Mac OS (tested on Catalina)
|
||||||
#. Configure the db connection:
|
#. Configure the db connection:
|
||||||
|
|
||||||
- Create an empty .env file in the root folder
|
- Create an empty .env file in the root folder
|
||||||
- Add and complete the following lines
|
- Add and complete the following lines:
|
||||||
|
|
||||||
| ``[MY_GROUP_NAME]``
|
| ``[MY_GROUP_NAME]``
|
||||||
| ``user=MyUSER``
|
| ``user=MyUSER``
|
||||||
| ``password=MyPassword``
|
| ``password=MyPassword``
|
||||||
|
@ -62,6 +65,7 @@ Linux (tested on Ubuntu 16.04)
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
#. Install dependenies:
|
#. Install dependenies:
|
||||||
|
|
||||||
- ``sudo apt-get install libmariadb-client-lgpl-dev libxml2-dev libssl-dev``
|
- ``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``
|
- Install brew_ for linux and add the following line to ~/.bashrc: ``export PATH=$HOME/.linuxbrew/bin:$PATH``
|
||||||
- ``source ~/.bashrc``
|
- ``source ~/.bashrc``
|
||||||
|
@ -82,7 +86,7 @@ Linux (tested on Ubuntu 16.04)
|
||||||
|
|
||||||
#. Clone our repo:
|
#. Clone our repo:
|
||||||
|
|
||||||
- ``git clone https://github.com/carissalow/moshi-aware-pipeline``
|
- ``git clone https://github.com/carissalow/rapids``
|
||||||
|
|
||||||
#. Create a python virtual environment:
|
#. 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 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)
|
- Add a line with the mobile platform (android, or ios)
|
||||||
- For example:
|
- For example:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
3a7b0d0a-a9ce-4059-ab98-93a7b189da8a,44f20139-50cc-4b13-bdde-0d5a3889e8f9
|
3a7b0d0a-a9ce-4059-ab98-93a7b189da8a,44f20139-50cc-4b13-bdde-0d5a3889e8f9
|
||||||
|
@ -109,7 +114,8 @@ Linux (tested on Ubuntu 16.04)
|
||||||
#. Configure the db connection:
|
#. Configure the db connection:
|
||||||
|
|
||||||
- Create an empty .env file in the root folder
|
- Create an empty .env file in the root folder
|
||||||
- Add and complete the following lines
|
- Add and complete the following lines:
|
||||||
|
|
||||||
| ``[MY_GROUP_NAME]``
|
| ``[MY_GROUP_NAME]``
|
||||||
| ``user=MyUSER``
|
| ``user=MyUSER``
|
||||||
| ``password=MyPassword``
|
| ``password=MyPassword``
|
||||||
|
|
Loading…
Reference in New Issue