Welcome to CerebralCortex RestClient’s documentation!

Cerebral Cortex is the big data cloud companion of mCerebrum designed to 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.

CerebralCortex-RESTClient is part of our CerebralCortex cloud platform. CerebralCortex Kernel is mainly responsible interact with CerebralCortex-APIServer to submit data without mCerebrum.

Installation

CerebralCortex-RESTClient requires minimum Python3.6. To install CerebralCortex-RESTClient as an API:

pip3 install cerebralcortex-restclient

  • Note: please use appropriate pip (e.g., pip, pip3, pip3.6 etc.) installed on your machine

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

Contents:

Indices and tables