From 516b536460fea5b89491b38f0f8b6b5a76ef7e99 Mon Sep 17 00:00:00 2001 From: nasirali1 Date: Sun, 30 Aug 2020 17:47:46 -0500 Subject: [PATCH] updated docs --- docs/Makefile | 19 ++ docs/conf.py | 186 ++++++++++++ docs/gen_docs.sh | 4 + docs/index.rst | 267 ++++++++++++++++-- .../cerebralcortex.algorithms.bluetooth.rst | 21 ++ docs/rst/cerebralcortex.algorithms.ecg.rst | 37 +++ docs/rst/cerebralcortex.algorithms.ema.rst | 29 ++ .../rst/cerebralcortex.algorithms.glucose.rst | 21 ++ docs/rst/cerebralcortex.algorithms.gps.rst | 21 ++ ...ebralcortex.algorithms.raw_byte_decode.rst | 21 ++ ...cerebralcortex.algorithms.rr_intervals.rst | 21 ++ docs/rst/cerebralcortex.algorithms.rst | 29 ++ ...ralcortex.algorithms.signal_processing.rst | 21 ++ docs/rst/cerebralcortex.algorithms.stats.rst | 21 ++ ...ralcortex.algorithms.stress_prediction.rst | 45 +++ docs/rst/cerebralcortex.algorithms.utils.rst | 37 +++ ...erebralcortex.algorithms.visualization.rst | 21 ++ .../cerebralcortex.core.config_manager.rst | 29 ++ .../cerebralcortex.core.data_manager.raw.rst | 69 +++++ docs/rst/cerebralcortex.core.data_manager.rst | 20 ++ .../cerebralcortex.core.data_manager.sql.rst | 45 +++ ...alcortex.core.data_manager.time_series.rst | 29 ++ docs/rst/cerebralcortex.core.datatypes.rst | 21 ++ docs/rst/cerebralcortex.core.log_manager.rst | 29 ++ .../cerebralcortex.core.metadata_manager.rst | 19 ++ ...ralcortex.core.metadata_manager.stream.rst | 37 +++ ...ebralcortex.core.metadata_manager.user.rst | 21 ++ docs/rst/cerebralcortex.core.rst | 23 ++ docs/rst/cerebralcortex.core.util.rst | 37 +++ docs/rst/cerebralcortex.examples.rst | 45 +++ docs/rst/cerebralcortex.markers.brushing.rst | 37 +++ .../rst/cerebralcortex.markers.ecg_stress.rst | 21 ++ docs/rst/cerebralcortex.markers.mcontain.rst | 37 +++ docs/rst/cerebralcortex.markers.rst | 20 ++ docs/rst/cerebralcortex.plotting.basic.rst | 21 ++ docs/rst/cerebralcortex.plotting.gps.rst | 21 ++ docs/rst/cerebralcortex.plotting.rst | 31 ++ docs/rst/cerebralcortex.plotting.stress.rst | 21 ++ docs/rst/cerebralcortex.rst | 35 +++ ...alcortex.test_suite.algorithms.glucose.rst | 10 + .../cerebralcortex.test_suite.algorithms.rst | 18 ++ docs/rst/cerebralcortex.test_suite.rst | 94 ++++++ docs/rst/cerebralcortex.test_suite.util.rst | 21 ++ docs/rst/cerebralcortex.util.rst | 21 ++ 44 files changed, 1625 insertions(+), 28 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/gen_docs.sh create mode 100644 docs/rst/cerebralcortex.algorithms.bluetooth.rst create mode 100644 docs/rst/cerebralcortex.algorithms.ecg.rst create mode 100644 docs/rst/cerebralcortex.algorithms.ema.rst create mode 100644 docs/rst/cerebralcortex.algorithms.glucose.rst create mode 100644 docs/rst/cerebralcortex.algorithms.gps.rst create mode 100644 docs/rst/cerebralcortex.algorithms.raw_byte_decode.rst create mode 100644 docs/rst/cerebralcortex.algorithms.rr_intervals.rst create mode 100644 docs/rst/cerebralcortex.algorithms.rst create mode 100644 docs/rst/cerebralcortex.algorithms.signal_processing.rst create mode 100644 docs/rst/cerebralcortex.algorithms.stats.rst create mode 100644 docs/rst/cerebralcortex.algorithms.stress_prediction.rst create mode 100644 docs/rst/cerebralcortex.algorithms.utils.rst create mode 100644 docs/rst/cerebralcortex.algorithms.visualization.rst create mode 100644 docs/rst/cerebralcortex.core.config_manager.rst create mode 100644 docs/rst/cerebralcortex.core.data_manager.raw.rst create mode 100644 docs/rst/cerebralcortex.core.data_manager.rst create mode 100644 docs/rst/cerebralcortex.core.data_manager.sql.rst create mode 100644 docs/rst/cerebralcortex.core.data_manager.time_series.rst create mode 100644 docs/rst/cerebralcortex.core.datatypes.rst create mode 100644 docs/rst/cerebralcortex.core.log_manager.rst create mode 100644 docs/rst/cerebralcortex.core.metadata_manager.rst create mode 100644 docs/rst/cerebralcortex.core.metadata_manager.stream.rst create mode 100644 docs/rst/cerebralcortex.core.metadata_manager.user.rst create mode 100644 docs/rst/cerebralcortex.core.rst create mode 100644 docs/rst/cerebralcortex.core.util.rst create mode 100644 docs/rst/cerebralcortex.examples.rst create mode 100644 docs/rst/cerebralcortex.markers.brushing.rst create mode 100644 docs/rst/cerebralcortex.markers.ecg_stress.rst create mode 100644 docs/rst/cerebralcortex.markers.mcontain.rst create mode 100644 docs/rst/cerebralcortex.markers.rst create mode 100644 docs/rst/cerebralcortex.plotting.basic.rst create mode 100644 docs/rst/cerebralcortex.plotting.gps.rst create mode 100644 docs/rst/cerebralcortex.plotting.rst create mode 100644 docs/rst/cerebralcortex.plotting.stress.rst create mode 100644 docs/rst/cerebralcortex.rst create mode 100644 docs/rst/cerebralcortex.test_suite.algorithms.glucose.rst create mode 100644 docs/rst/cerebralcortex.test_suite.algorithms.rst create mode 100644 docs/rst/cerebralcortex.test_suite.rst create mode 100644 docs/rst/cerebralcortex.test_suite.util.rst create mode 100644 docs/rst/cerebralcortex.util.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..298ea9e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..24d754f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,186 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../')) + + +# -- Project information ----------------------------------------------------- + +project = 'CerebralCortex Kernel' +copyright = '2019, MD2K' +author = 'Nasir Ali' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '3.3.0' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' +# sphinx_catalystcloud_theme +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + +add_module_names = False + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'CerebralCortexdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'CerebralCortex.tex', 'CerebralCortex Documentation', + 'Nasir Ali', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'cerebralcortex', 'CerebralCortex Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'CerebralCortex', 'CerebralCortex Documentation', + author, 'CerebralCortex', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs/gen_docs.sh b/docs/gen_docs.sh new file mode 100644 index 0000000..5b8dd94 --- /dev/null +++ b/docs/gen_docs.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +sphinx-apidoc -o rst/ ../ +make clean +make html diff --git a/docs/index.rst b/docs/index.rst index 7c076b7..568eb6e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,9 +6,11 @@ support population-scale data analysis, visualization, model development, and intervention design for mobile sensor data. You can find more information about MD2K software on our `software -website`_ or the MD2K organization on our `MD2K website`_. +website `__ or the MD2K organization on our +`MD2K website `__. -CerebralCortex Kernel is part of our `CerebralCortex cloud platform`_. +CerebralCortex Kernel is part of our `CerebralCortex cloud +platform `__. CerebralCortex-Kernel is capable of parallelizing tasks and scale a job to n-number of cores/machines. CerebralCortex Kernel offers some builtin features as follows: @@ -27,8 +29,9 @@ check java version - ``java -version`` - set ``JAVA_HOME`` to ``java 8`` Install using pip ~~~~~~~~~~~~~~~~~ -CerebralCortex-Kernel requires minimum `Python3.6`_. To install -CerebralCortex-Kernel as an API: +CerebralCortex-Kernel requires minimum +`Python3.6 `__. To +install CerebralCortex-Kernel as an API: ``pip3 install cerebralcortex-kernel`` @@ -48,18 +51,19 @@ Usage :: - from cerebralcortex.kernel import Kernel - CC = Kernel(cc_configs="default") + from cerebralcortex.kernel import Kernel + CC = Kernel(cc_configs="default") - # to view default configs - print(CC.config) + # to view default configs + print(CC.config) - # default data storage path is - # /user/home/folder/cc_data + # default data storage path is + # /user/home/folder/cc_data By default Kernel will load default configs. Please have a look at all -available `configurations`_ for CerebralCortex-Kernel. You may also load -config files as: +available +`configurations `__ +for CerebralCortex-Kernel. You may also load config files as: ``CC = Kernel(configs_dir_path="dir/path/to/configs/", new_study=True)`` @@ -70,8 +74,10 @@ Using builtin algorithms are as easy as loading data, passing it to algorithm and get the results. Below is an example on how to compute CGM Glucose Variability Metrics. -- `Download Glucose Data`_. The device used to collect glucose was the - `Dexcom G6 Continuous Glucose Monitor`_ +- `Download Glucose + Data `__. + The device used to collect glucose was the `Dexcom G6 Continuous + Glucose Monitor `__ - Install Cerebral Cortex Kernel ``pip install cerebralcortex-kernel`` - Open terminal and start python3 shell @@ -80,20 +86,225 @@ Python Code :: - # import packages - from cerebralcortex.kernel import Kernel - from cerebralcortex.algorithms.glucose.glucose_variability_metrics import glucose_var + # import packages + from cerebralcortex.kernel import Kernel + from cerebralcortex.algorithms.glucose.glucose_variability_metrics import glucose_var - # Create Kernel object - CC = Kernel(cc_configs="default", new_study=True) + # Create Kernel object + CC = Kernel(cc_configs="default", new_study=True) - # Read sample CSV data - ds = CC.read_csv("/path/of/the/downloaded/file/sample.csv", stream_name="cgm_glucose_variability_metrics", header= + # Read sample CSV data + ds = CC.read_csv("/path/of/the/downloaded/file/sample.csv", stream_name="cgm_glucose_variability_metrics", header=True) -.. _software website: https://md2k.org/software -.. _MD2K website: https://md2k.org/ -.. _CerebralCortex cloud platform: https://github.com/MD2Korg/CerebralCortex -.. _Python3.6: https://www.python.org/downloads/release/python-360/ -.. _configurations: https://github.com/MD2Korg/CerebralCortex-Kernel/tree/master/conf -.. _Download Glucose Data: https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/test_suite/sample_data/cgm_glucose_variability_metrics/sample.csv -.. _Dexcom G6 Continuous Glucose Monitor: https://www.dexcom.com/g6-cgm-system \ No newline at end of file + # view sample data + ds.show(2) + + # Apply glucose_variability_metrics algorithm on the data + results = glucose_var(ds) + + # view results + results.show(2) + + # save computed data + CC.save_stream(results) + + +Please have a look at `jupyter +notebook `__ +for basic operation that could be perform on DataStream object. + +Algorithms to Analyze Sensor Data +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +External CerebralCortex-Kernel offers following builtin algorithms to +analyze sensor data. + +- ECG sensor data quality +- ECG RR Interval Computation +- Heart Rate Variability Feature Computation +- CGM Glucose Variability Metrics +- `GPS Data + Clustering `__ +- Sensor Data Interpolation +- Statistical Features Computation +- `List of all available + algorithms `__ + +Markers with ML Models +~~~~~~~~~~~~~~~~~~~~~~ + +- `Stress Detection using ECG + data `__ +- `mContain Social + Crowding `__ +- Brushing Detection using Accelerometer and Gyro Data (TODO) + +Visualization +~~~~~~~~~~~~~ + +- `Basic Plots for Timeseries + Data `__ +- `Plot GPS Clusters on + Map `__ +- `Stress + Visualization `__ + +Import and Document Data +~~~~~~~~~~~~~~~~~~~~~~~~ + +- `Import CSV Data in CerebralCortex-Kernel + Format `__ +- `Document imported Data using MetaData + Module `__ + +External CerebralCortex-Kernel Supported Platforms +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- mProv +- mFlow + +Examples +-------- + +- `Jupyter + Notebooks `__ + +Documentation +------------- + +- `Source code + documentation `__ + +Deploy on Cloud +--------------- + +CerebralCortex-Kernel is a part of CerebralCortex cloud platform. To +test the complete cloud platform, please visit +`CerebralCortex `__. + +FAQ +--- + +**1 - Do I need whole CerebralCortex cloud platform to use +CerebralCortex-Kernal?** + +No! If you want to use CerebralCortex-Kernel independently. + +**2 - How can I change NoSQL backend storage layer?** + +CerebralCortex-Kernel follows component based structure. This makes it +easier to add/remove features. \* Add a new class in `Data +manager-Raw `__. +\* New class must have read/write methods. Here is a sample `skeleton +class `__ +with mandatory methods required in the new class. \* Create an object of +new class in +`Data-Raw `__ +with appropriate parameters. \* Add appropriate configurations in +`cerebralcortex.yml `__ +in (NoSQL +Storage)[https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/conf/cerebralcortex.yml#L8] +section. + +**3 - How can I replace MySQL with another SQL storage system?** + +- Add a new class in `Data + manager-SQL `__. +- New class must implement all of the methods available in + `stream\_handler.py `__ + class. +- Create an object of new class in + `Data-SQL `__ + with appropriate parameters. +- Add appropriate configurations in + `cerebralcortex.yml `__ + in `Relational + Storage `__ + section. + +**4 - Where are all the backend storage related classes/methods?** + +In `Data +manager-Raw `__. +You can add/change any backend storage. + +Contributing +------------ + +Please read our `Contributing +Guidelines `__ +for details on the process for submitting pull requests to us. + +We use the `Python PEP 8 Style +Guide `__. + +Our `Code of +Conduct `__ is the +`Contributor Covenant `__. + +Bug reports can be submitted through +`JIRA `__. + +Our discussion forum can be found `here `__. + +Versioning +---------- + +We use `Semantic Versioning `__ for versioning the +software which is based on the following guidelines. + +MAJOR.MINOR.PATCH (example: 3.0.12) + +1. MAJOR version when incompatible API changes are made, +2. MINOR version when functionality is added in a backwards-compatible + manner, and +3. PATCH version when backwards-compatible bug fixes are introduced. + +For the versions available, see `this repository's +tags `__. + +Contributors +------------ + +Link to the `list of +contributors `__ +who participated in this project. + +License +------- + +This project is licensed under the BSD 2-Clause - see the +`license `__ +file for details. + +Acknowledgments +--------------- + +- `National Institutes of Health `__ - `Big Data + to Knowledge Initiative `__ +- Grants: R01MD010362, 1UG1DA04030901, 1U54EB020404, 1R01CA190329, + 1R01DE02524, R00MD010468, 3UH2DA041713, 10555SC +- `National Science Foundation `__ +- Grants: 1640813, 1722646 +- `Intelligence Advanced Research Projects + Activity `__ +- Contract: 2017-17042800006 + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + rst/cerebralcortex.rst + rst/cerebralcortex.core + rst/cerebralcortex.algorithms + rst/cerebralcortex.markers + rst/cerebralcortex.plotting + rst/cerebralcortex.examples + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` \ No newline at end of file diff --git a/docs/rst/cerebralcortex.algorithms.bluetooth.rst b/docs/rst/cerebralcortex.algorithms.bluetooth.rst new file mode 100644 index 0000000..240d91f --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.bluetooth.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.bluetooth package +=========================================== + +Submodules +---------- + +cerebralcortex.algorithms.bluetooth.encounter module +---------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.bluetooth.encounter + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.bluetooth + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.ecg.rst b/docs/rst/cerebralcortex.algorithms.ecg.rst new file mode 100644 index 0000000..2f1fe6f --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.ecg.rst @@ -0,0 +1,37 @@ +cerebralcortex.algorithms.ecg package +===================================== + +Submodules +---------- + +cerebralcortex.algorithms.ecg.autosense\_data\_quality module +------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.ecg.autosense_data_quality + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.ecg.autosense\_rr\_interval module +------------------------------------------------------------ + +.. automodule:: cerebralcortex.algorithms.ecg.autosense_rr_interval + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.ecg.hrv\_features module +-------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.ecg.hrv_features + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.ecg + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.ema.rst b/docs/rst/cerebralcortex.algorithms.ema.rst new file mode 100644 index 0000000..fbc3193 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.ema.rst @@ -0,0 +1,29 @@ +cerebralcortex.algorithms.ema package +===================================== + +Submodules +---------- + +cerebralcortex.algorithms.ema.ema\_random\_features module +---------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.ema.ema_random_features + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.ema.features module +--------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.ema.features + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.ema + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.glucose.rst b/docs/rst/cerebralcortex.algorithms.glucose.rst new file mode 100644 index 0000000..fa1e2ab --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.glucose.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.glucose package +========================================= + +Submodules +---------- + +cerebralcortex.algorithms.glucose.glucose\_variability\_metrics module +---------------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.glucose.glucose_variability_metrics + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.glucose + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.gps.rst b/docs/rst/cerebralcortex.algorithms.gps.rst new file mode 100644 index 0000000..eda2f7b --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.gps.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.gps package +===================================== + +Submodules +---------- + +cerebralcortex.algorithms.gps.clustering module +----------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.gps.clustering + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.gps + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.raw_byte_decode.rst b/docs/rst/cerebralcortex.algorithms.raw_byte_decode.rst new file mode 100644 index 0000000..92b9d83 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.raw_byte_decode.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.raw\_byte\_decode package +=================================================== + +Submodules +---------- + +cerebralcortex.algorithms.raw\_byte\_decode.motionsenseHRV module +----------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.raw_byte_decode.motionsenseHRV + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.raw_byte_decode + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.rr_intervals.rst b/docs/rst/cerebralcortex.algorithms.rr_intervals.rst new file mode 100644 index 0000000..77cb809 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.rr_intervals.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.rr\_intervals package +=============================================== + +Submodules +---------- + +cerebralcortex.algorithms.rr\_intervals.rr\_interval\_feature\_extraction module +-------------------------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.rr_intervals.rr_interval_feature_extraction + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.rr_intervals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.rst b/docs/rst/cerebralcortex.algorithms.rst new file mode 100644 index 0000000..950a37a --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.rst @@ -0,0 +1,29 @@ +cerebralcortex.algorithms package +================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.algorithms.bluetooth + cerebralcortex.algorithms.ecg + cerebralcortex.algorithms.ema + cerebralcortex.algorithms.glucose + cerebralcortex.algorithms.gps + cerebralcortex.algorithms.raw_byte_decode + cerebralcortex.algorithms.rr_intervals + cerebralcortex.algorithms.signal_processing + cerebralcortex.algorithms.stats + cerebralcortex.algorithms.stress_prediction + cerebralcortex.algorithms.utils + cerebralcortex.algorithms.visualization + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.signal_processing.rst b/docs/rst/cerebralcortex.algorithms.signal_processing.rst new file mode 100644 index 0000000..6ea1194 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.signal_processing.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.signal\_processing package +==================================================== + +Submodules +---------- + +cerebralcortex.algorithms.signal\_processing.features module +------------------------------------------------------------ + +.. automodule:: cerebralcortex.algorithms.signal_processing.features + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.signal_processing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.stats.rst b/docs/rst/cerebralcortex.algorithms.stats.rst new file mode 100644 index 0000000..b356be7 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.stats.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.stats package +======================================= + +Submodules +---------- + +cerebralcortex.algorithms.stats.features module +----------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.stats.features + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.stats + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.stress_prediction.rst b/docs/rst/cerebralcortex.algorithms.stress_prediction.rst new file mode 100644 index 0000000..9dd6c02 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.stress_prediction.rst @@ -0,0 +1,45 @@ +cerebralcortex.algorithms.stress\_prediction package +==================================================== + +Submodules +---------- + +cerebralcortex.algorithms.stress\_prediction.ecg\_stress module +--------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.stress_prediction.ecg_stress + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.stress\_prediction.stress\_episodes module +-------------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.stress_prediction.stress_episodes + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.stress\_prediction.stress\_imputation module +---------------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.stress_prediction.stress_imputation + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.stress\_prediction.stress\_prediction module +---------------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.stress_prediction.stress_prediction + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.stress_prediction + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.utils.rst b/docs/rst/cerebralcortex.algorithms.utils.rst new file mode 100644 index 0000000..96af80f --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.utils.rst @@ -0,0 +1,37 @@ +cerebralcortex.algorithms.utils package +======================================= + +Submodules +---------- + +cerebralcortex.algorithms.utils.feature\_normalization module +------------------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.utils.feature_normalization + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.utils.mprov\_helper module +---------------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.utils.mprov_helper + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.algorithms.utils.util module +------------------------------------------- + +.. automodule:: cerebralcortex.algorithms.utils.util + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.algorithms.visualization.rst b/docs/rst/cerebralcortex.algorithms.visualization.rst new file mode 100644 index 0000000..e7b18f3 --- /dev/null +++ b/docs/rst/cerebralcortex.algorithms.visualization.rst @@ -0,0 +1,21 @@ +cerebralcortex.algorithms.visualization package +=============================================== + +Submodules +---------- + +cerebralcortex.algorithms.visualization.visualization module +------------------------------------------------------------ + +.. automodule:: cerebralcortex.algorithms.visualization.visualization + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.algorithms.visualization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.config_manager.rst b/docs/rst/cerebralcortex.core.config_manager.rst new file mode 100644 index 0000000..a3dfe79 --- /dev/null +++ b/docs/rst/cerebralcortex.core.config_manager.rst @@ -0,0 +1,29 @@ +cerebralcortex.core.config\_manager package +=========================================== + +Submodules +---------- + +cerebralcortex.core.config\_manager.config module +------------------------------------------------- + +.. automodule:: cerebralcortex.core.config_manager.config + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.config\_manager.config\_handler module +---------------------------------------------------------- + +.. automodule:: cerebralcortex.core.config_manager.config_handler + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.config_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.data_manager.raw.rst b/docs/rst/cerebralcortex.core.data_manager.raw.rst new file mode 100644 index 0000000..dfcb382 --- /dev/null +++ b/docs/rst/cerebralcortex.core.data_manager.raw.rst @@ -0,0 +1,69 @@ +cerebralcortex.core.data\_manager.raw package +============================================= + +Submodules +---------- + +cerebralcortex.core.data\_manager.raw.data module +------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.raw.data + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.raw.filebased\_storage module +--------------------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.raw.filebased_storage + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.raw.sample\_code\_for\_soujanya module +------------------------------------------------------------------------ + +.. automodule:: cerebralcortex.core.data_manager.raw.sample_code_for_soujanya + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.raw.storage\_blueprint module +--------------------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.raw.storage_blueprint + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.raw.stream\_handler module +------------------------------------------------------------ + +.. automodule:: cerebralcortex.core.data_manager.raw.stream_handler + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.raw.tedt module +------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.raw.tedt + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.raw.util module +------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.raw.util + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.data_manager.raw + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.data_manager.rst b/docs/rst/cerebralcortex.core.data_manager.rst new file mode 100644 index 0000000..ed651a2 --- /dev/null +++ b/docs/rst/cerebralcortex.core.data_manager.rst @@ -0,0 +1,20 @@ +cerebralcortex.core.data\_manager package +========================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.core.data_manager.raw + cerebralcortex.core.data_manager.sql + cerebralcortex.core.data_manager.time_series + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.data_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.data_manager.sql.rst b/docs/rst/cerebralcortex.core.data_manager.sql.rst new file mode 100644 index 0000000..0ba970f --- /dev/null +++ b/docs/rst/cerebralcortex.core.data_manager.sql.rst @@ -0,0 +1,45 @@ +cerebralcortex.core.data\_manager.sql package +============================================= + +Submodules +---------- + +cerebralcortex.core.data\_manager.sql.data module +------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.sql.data + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.sql.orm\_models module +-------------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.sql.orm_models + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.sql.stream\_handler module +------------------------------------------------------------ + +.. automodule:: cerebralcortex.core.data_manager.sql.stream_handler + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.sql.users\_handler module +----------------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.sql.users_handler + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.data_manager.sql + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.data_manager.time_series.rst b/docs/rst/cerebralcortex.core.data_manager.time_series.rst new file mode 100644 index 0000000..2d02ea6 --- /dev/null +++ b/docs/rst/cerebralcortex.core.data_manager.time_series.rst @@ -0,0 +1,29 @@ +cerebralcortex.core.data\_manager.time\_series package +====================================================== + +Submodules +---------- + +cerebralcortex.core.data\_manager.time\_series.data module +---------------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.time_series.data + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.data\_manager.time\_series.influxdb\_handler module +----------------------------------------------------------------------- + +.. automodule:: cerebralcortex.core.data_manager.time_series.influxdb_handler + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.data_manager.time_series + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.datatypes.rst b/docs/rst/cerebralcortex.core.datatypes.rst new file mode 100644 index 0000000..5438816 --- /dev/null +++ b/docs/rst/cerebralcortex.core.datatypes.rst @@ -0,0 +1,21 @@ +cerebralcortex.core.datatypes package +===================================== + +Submodules +---------- + +cerebralcortex.core.datatypes.datastream module +----------------------------------------------- + +.. automodule:: cerebralcortex.core.datatypes.datastream + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.datatypes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.log_manager.rst b/docs/rst/cerebralcortex.core.log_manager.rst new file mode 100644 index 0000000..15dfdb9 --- /dev/null +++ b/docs/rst/cerebralcortex.core.log_manager.rst @@ -0,0 +1,29 @@ +cerebralcortex.core.log\_manager package +======================================== + +Submodules +---------- + +cerebralcortex.core.log\_manager.log\_handler module +---------------------------------------------------- + +.. automodule:: cerebralcortex.core.log_manager.log_handler + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.log\_manager.logging module +----------------------------------------------- + +.. automodule:: cerebralcortex.core.log_manager.logging + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.log_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.metadata_manager.rst b/docs/rst/cerebralcortex.core.metadata_manager.rst new file mode 100644 index 0000000..2270158 --- /dev/null +++ b/docs/rst/cerebralcortex.core.metadata_manager.rst @@ -0,0 +1,19 @@ +cerebralcortex.core.metadata\_manager package +============================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.core.metadata_manager.stream + cerebralcortex.core.metadata_manager.user + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.metadata_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.metadata_manager.stream.rst b/docs/rst/cerebralcortex.core.metadata_manager.stream.rst new file mode 100644 index 0000000..db59c49 --- /dev/null +++ b/docs/rst/cerebralcortex.core.metadata_manager.stream.rst @@ -0,0 +1,37 @@ +cerebralcortex.core.metadata\_manager.stream package +==================================================== + +Submodules +---------- + +cerebralcortex.core.metadata\_manager.stream.data\_descriptor module +-------------------------------------------------------------------- + +.. automodule:: cerebralcortex.core.metadata_manager.stream.data_descriptor + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.metadata\_manager.stream.metadata module +------------------------------------------------------------ + +.. automodule:: cerebralcortex.core.metadata_manager.stream.metadata + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.metadata\_manager.stream.module\_info module +---------------------------------------------------------------- + +.. automodule:: cerebralcortex.core.metadata_manager.stream.module_info + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.metadata_manager.stream + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.metadata_manager.user.rst b/docs/rst/cerebralcortex.core.metadata_manager.user.rst new file mode 100644 index 0000000..cf4abf5 --- /dev/null +++ b/docs/rst/cerebralcortex.core.metadata_manager.user.rst @@ -0,0 +1,21 @@ +cerebralcortex.core.metadata\_manager.user package +================================================== + +Submodules +---------- + +cerebralcortex.core.metadata\_manager.user.user module +------------------------------------------------------ + +.. automodule:: cerebralcortex.core.metadata_manager.user.user + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.metadata_manager.user + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.rst b/docs/rst/cerebralcortex.core.rst new file mode 100644 index 0000000..5953320 --- /dev/null +++ b/docs/rst/cerebralcortex.core.rst @@ -0,0 +1,23 @@ +cerebralcortex.core package +=========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.core.config_manager + cerebralcortex.core.data_manager + cerebralcortex.core.datatypes + cerebralcortex.core.log_manager + cerebralcortex.core.metadata_manager + cerebralcortex.core.util + +Module contents +--------------- + +.. automodule:: cerebralcortex.core + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.core.util.rst b/docs/rst/cerebralcortex.core.util.rst new file mode 100644 index 0000000..f450b99 --- /dev/null +++ b/docs/rst/cerebralcortex.core.util.rst @@ -0,0 +1,37 @@ +cerebralcortex.core.util package +================================ + +Submodules +---------- + +cerebralcortex.core.util.data\_formats module +--------------------------------------------- + +.. automodule:: cerebralcortex.core.util.data_formats + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.util.datetime\_helper\_methods module +--------------------------------------------------------- + +.. automodule:: cerebralcortex.core.util.datetime_helper_methods + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.core.util.spark\_helper module +--------------------------------------------- + +.. automodule:: cerebralcortex.core.util.spark_helper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.core.util + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.examples.rst b/docs/rst/cerebralcortex.examples.rst new file mode 100644 index 0000000..80c75f0 --- /dev/null +++ b/docs/rst/cerebralcortex.examples.rst @@ -0,0 +1,45 @@ +cerebralcortex.examples package +=============================== + +Submodules +---------- + +cerebralcortex.examples.brushing\_detection module +-------------------------------------------------- + +.. automodule:: cerebralcortex.examples.brushing_detection + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.examples.mprov\_get module +----------------------------------------- + +.. automodule:: cerebralcortex.examples.mprov_get + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.examples.mprov\_gps\_example module +-------------------------------------------------- + +.. automodule:: cerebralcortex.examples.mprov_gps_example + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.examples.stress\_from\_ecg module +------------------------------------------------ + +.. automodule:: cerebralcortex.examples.stress_from_ecg + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.examples + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.markers.brushing.rst b/docs/rst/cerebralcortex.markers.brushing.rst new file mode 100644 index 0000000..b9dfdbc --- /dev/null +++ b/docs/rst/cerebralcortex.markers.brushing.rst @@ -0,0 +1,37 @@ +cerebralcortex.markers.brushing package +======================================= + +Submodules +---------- + +cerebralcortex.markers.brushing.features module +----------------------------------------------- + +.. automodule:: cerebralcortex.markers.brushing.features + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.markers.brushing.main module +------------------------------------------- + +.. automodule:: cerebralcortex.markers.brushing.main + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.markers.brushing.util module +------------------------------------------- + +.. automodule:: cerebralcortex.markers.brushing.util + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.markers.brushing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.markers.ecg_stress.rst b/docs/rst/cerebralcortex.markers.ecg_stress.rst new file mode 100644 index 0000000..24e070b --- /dev/null +++ b/docs/rst/cerebralcortex.markers.ecg_stress.rst @@ -0,0 +1,21 @@ +cerebralcortex.markers.ecg\_stress package +========================================== + +Submodules +---------- + +cerebralcortex.markers.ecg\_stress.stress\_from\_ecg module +----------------------------------------------------------- + +.. automodule:: cerebralcortex.markers.ecg_stress.stress_from_ecg + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.markers.ecg_stress + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.markers.mcontain.rst b/docs/rst/cerebralcortex.markers.mcontain.rst new file mode 100644 index 0000000..ba83af0 --- /dev/null +++ b/docs/rst/cerebralcortex.markers.mcontain.rst @@ -0,0 +1,37 @@ +cerebralcortex.markers.mcontain package +======================================= + +Submodules +---------- + +cerebralcortex.markers.mcontain.assign\_covid\_user module +---------------------------------------------------------- + +.. automodule:: cerebralcortex.markers.mcontain.assign_covid_user + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.markers.mcontain.daily\_encounter\_stats module +-------------------------------------------------------------- + +.. automodule:: cerebralcortex.markers.mcontain.daily_encounter_stats + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.markers.mcontain.hourly\_encounters module +--------------------------------------------------------- + +.. automodule:: cerebralcortex.markers.mcontain.hourly_encounters + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.markers.mcontain + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.markers.rst b/docs/rst/cerebralcortex.markers.rst new file mode 100644 index 0000000..cc1d87e --- /dev/null +++ b/docs/rst/cerebralcortex.markers.rst @@ -0,0 +1,20 @@ +cerebralcortex.markers package +============================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.markers.brushing + cerebralcortex.markers.ecg_stress + cerebralcortex.markers.mcontain + +Module contents +--------------- + +.. automodule:: cerebralcortex.markers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.plotting.basic.rst b/docs/rst/cerebralcortex.plotting.basic.rst new file mode 100644 index 0000000..fbf8f43 --- /dev/null +++ b/docs/rst/cerebralcortex.plotting.basic.rst @@ -0,0 +1,21 @@ +cerebralcortex.plotting.basic package +===================================== + +Submodules +---------- + +cerebralcortex.plotting.basic.plots module +------------------------------------------ + +.. automodule:: cerebralcortex.plotting.basic.plots + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.plotting.basic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.plotting.gps.rst b/docs/rst/cerebralcortex.plotting.gps.rst new file mode 100644 index 0000000..a02b0b2 --- /dev/null +++ b/docs/rst/cerebralcortex.plotting.gps.rst @@ -0,0 +1,21 @@ +cerebralcortex.plotting.gps package +=================================== + +Submodules +---------- + +cerebralcortex.plotting.gps.plots module +---------------------------------------- + +.. automodule:: cerebralcortex.plotting.gps.plots + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.plotting.gps + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.plotting.rst b/docs/rst/cerebralcortex.plotting.rst new file mode 100644 index 0000000..6c31456 --- /dev/null +++ b/docs/rst/cerebralcortex.plotting.rst @@ -0,0 +1,31 @@ +cerebralcortex.plotting package +=============================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.plotting.basic + cerebralcortex.plotting.gps + cerebralcortex.plotting.stress + +Submodules +---------- + +cerebralcortex.plotting.util module +----------------------------------- + +.. automodule:: cerebralcortex.plotting.util + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.plotting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.plotting.stress.rst b/docs/rst/cerebralcortex.plotting.stress.rst new file mode 100644 index 0000000..4dc52f6 --- /dev/null +++ b/docs/rst/cerebralcortex.plotting.stress.rst @@ -0,0 +1,21 @@ +cerebralcortex.plotting.stress package +====================================== + +Submodules +---------- + +cerebralcortex.plotting.stress.plots module +------------------------------------------- + +.. automodule:: cerebralcortex.plotting.stress.plots + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.plotting.stress + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.rst b/docs/rst/cerebralcortex.rst new file mode 100644 index 0000000..2bf985c --- /dev/null +++ b/docs/rst/cerebralcortex.rst @@ -0,0 +1,35 @@ +cerebralcortex package +====================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.algorithms + cerebralcortex.core + cerebralcortex.examples + cerebralcortex.markers + cerebralcortex.plotting + cerebralcortex.test_suite + cerebralcortex.util + +Submodules +---------- + +cerebralcortex.kernel module +---------------------------- + +.. automodule:: cerebralcortex.kernel + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.test_suite.algorithms.glucose.rst b/docs/rst/cerebralcortex.test_suite.algorithms.glucose.rst new file mode 100644 index 0000000..1e9df25 --- /dev/null +++ b/docs/rst/cerebralcortex.test_suite.algorithms.glucose.rst @@ -0,0 +1,10 @@ +cerebralcortex.test\_suite.algorithms.glucose package +===================================================== + +Module contents +--------------- + +.. automodule:: cerebralcortex.test_suite.algorithms.glucose + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.test_suite.algorithms.rst b/docs/rst/cerebralcortex.test_suite.algorithms.rst new file mode 100644 index 0000000..66de8c7 --- /dev/null +++ b/docs/rst/cerebralcortex.test_suite.algorithms.rst @@ -0,0 +1,18 @@ +cerebralcortex.test\_suite.algorithms package +============================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.test_suite.algorithms.glucose + +Module contents +--------------- + +.. automodule:: cerebralcortex.test_suite.algorithms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.test_suite.rst b/docs/rst/cerebralcortex.test_suite.rst new file mode 100644 index 0000000..c596293 --- /dev/null +++ b/docs/rst/cerebralcortex.test_suite.rst @@ -0,0 +1,94 @@ +cerebralcortex.test\_suite package +================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cerebralcortex.test_suite.algorithms + cerebralcortex.test_suite.util + +Submodules +---------- + +cerebralcortex.test\_suite.join\_spark module +--------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.join_spark + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_glucose\_metrics module +-------------------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.test_glucose_metrics + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_gps\_cluster\_udf module +--------------------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.test_gps_cluster_udf + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_import\_data module +---------------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.test_import_data + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_main module +-------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.test_main + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_nosql\_storage module +------------------------------------------------------ + +.. automodule:: cerebralcortex.test_suite.test_nosql_storage + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_rest\_api\_server module +--------------------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.test_rest_api_server + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.test\_sql\_storage module +---------------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.test_sql_storage + :members: + :undoc-members: + :show-inheritance: + +cerebralcortex.test\_suite.tt module +------------------------------------ + +.. automodule:: cerebralcortex.test_suite.tt + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.test_suite + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.test_suite.util.rst b/docs/rst/cerebralcortex.test_suite.util.rst new file mode 100644 index 0000000..0067bee --- /dev/null +++ b/docs/rst/cerebralcortex.test_suite.util.rst @@ -0,0 +1,21 @@ +cerebralcortex.test\_suite.util package +======================================= + +Submodules +---------- + +cerebralcortex.test\_suite.util.data\_helper module +--------------------------------------------------- + +.. automodule:: cerebralcortex.test_suite.util.data_helper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.test_suite.util + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rst/cerebralcortex.util.rst b/docs/rst/cerebralcortex.util.rst new file mode 100644 index 0000000..2a6b275 --- /dev/null +++ b/docs/rst/cerebralcortex.util.rst @@ -0,0 +1,21 @@ +cerebralcortex.util package +=========================== + +Submodules +---------- + +cerebralcortex.util.helper\_methods module +------------------------------------------ + +.. automodule:: cerebralcortex.util.helper_methods + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cerebralcortex.util + :members: + :undoc-members: + :show-inheritance: