{ "info": { "author": "MD2K.org", "author_email": "dev@md2k.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Healthcare Industry", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering :: Information Analysis", "Topic :: System :: Distributed Computing" ], "description": "# CerebralCortex Kernel\nCerebral 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.\n\nYou can find more information about MD2K software on our [software website](https://md2k.org/software) or the MD2K organization on our [MD2K website](https://md2k.org/).\n\nCerebralCortex Kernel is part of our [CerebralCortex cloud platform](https://github.com/MD2Korg/CerebralCortex). CerebralCortex Kernel is mainly responsible to store/retrieve mobile sensor data along with it's metadata. \n\n**Note**:\n\nWe have renamed following repositories.\n\n* CerebralCortex-Platform -> CerebralCortex\n* CerebralCortex - > CerebralCortex-Kernel\n\n## Installation\nCerebralCortex-Kernel is a part of CerebralCortex cloud platform. To test the complete cloud platform, please visit [CerebralCortex](https://github.com/MD2Korg/CerebralCortex).\n\nCerebralCortex-Kernel requires minimum [Python3.6](https://www.python.org/downloads/release/python-360/). To install CerebralCortex-Kernel as an API:\n\n```git clone https://github.com/MD2Korg/CerebralCortex-kernel.git```\n\n`cd cerebralcortex-kernel`\n\n`git checkout 3.0`\n\n\n```sudo python3 setup.py install```\n\n## Code Example\nExample folder (`cerebralcortex-kernel/cerebralcortex/example`) contains basic examples on how to use CerebralCortex-Kernel api.\n\n## FAQ\n**1 - Do I need whole CerebralCortex cloud platform to use CerebralCortex-Kernal?**\n\nNo! If you want to use CerebralCortex-Kernel independently then you would need: \n* Backend storage (FileSystem/HDFS and MySQL) with some data. Here is [some sample data](TODO) to play with.\n* Setup the [configurations](https://github.com/MD2Korg/CerebralCortex-Kernel/tree/master/conf)\n* Use the [examples](TODO) to start exploring data\n\n**2 - I do not want to use FileSystem/HDFS as NoSQL storage. How can I change NoSQL storage backend?**\n\nCerebralCortex-Kernel follows component based structure. This makes it easier to add/remove features. \n* Add a new class in [Data manager-Raw](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/core/data_manager/raw/). \n* New class must have read/write methods. Here is a sample [skeleton class](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/core/data_manager/raw/storage_blueprint.py) with mandatory methods required in the new class.\n* Create an object of new class in [Data-Raw](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/core/data_manager/raw/data.py) with appropriate parameters.\n* Add appropriate configurations in [cerebralcortex.yml](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/conf/cerebralcortex.yml) in (NoSQL Storage)[https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/conf/cerebralcortex.yml#L8] section.\n\n**3 - How can I replace MySQL with another SQL storage system?** \n\n* Add a new class in [Data manager-SQL](https://github.com/MD2Korg/CerebralCortex-Kernel/tree/master/cerebralcortex/core/data_manager/sql). \n* New class must implement all of the methods available in (stream_handler.py)[https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/core/data_manager/sql/stream_handler.py] class.\n* Create an object of new class in [Data-SQL](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/core/data_manager/sql/data.py) with appropriate parameters.\n* Add appropriate configurations in [cerebralcortex.yml](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/conf/cerebralcortex.yml) in (Relational Storage)[https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/conf/cerebralcortex.yml#L31] section.\n\n**4 - Where are all the backend storage related classes/methods?** \n\nIn [Data manager-Raw](https://github.com/MD2Korg/CerebralCortex-Kernel/blob/master/cerebralcortex/core/data_manager/). You can add/change any backend storage.\n\n\n## Contributing\nPlease read our [Contributing Guidelines](https://md2k.org/contributing/contributing-guidelines.html) for details on the process for submitting pull requests to us.\n\nWe use the [Python PEP 8 Style Guide](https://www.python.org/dev/peps/pep-0008/).\n\nOur [Code of Conduct](https://md2k.org/contributing/code-of-conduct.html) is the [Contributor Covenant](https://www.contributor-covenant.org/).\n\nBug reports can be submitted through [JIRA](https://md2korg.atlassian.net/secure/Dashboard.jspa).\n\nOur discussion forum can be found [here](https://discuss.md2k.org/).\n\n## Versioning\n\nWe use [Semantic Versioning](https://semver.org/) for versioning the software which is based on the following guidelines.\n\nMAJOR.MINOR.PATCH (example: 3.0.12)\n\n 1. MAJOR version when incompatible API changes are made,\n 2. MINOR version when functionality is added in a backwards-compatible manner, and\n 3. PATCH version when backwards-compatible bug fixes are introduced.\n\nFor the versions available, see [this repository's tags](https://github.com/MD2Korg/CerebralCortex/tags).\n\n## Contributors\n\nLink to the [list of contributors](https://github.com/MD2Korg/CerebralCortex-Kernel/graphs/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the BSD 2-Clause - see the [license](https://md2k.org/software-under-the-hood/software-uth-license) file for details.\n\n## Acknowledgments\n\n* [National Institutes of Health](https://www.nih.gov/) - [Big Data to Knowledge Initiative](https://datascience.nih.gov/bd2k)\n * Grants: R01MD010362, 1UG1DA04030901, 1U54EB020404, 1R01CA190329, 1R01DE02524, R00MD010468, 3UH2DA041713, 10555SC\n* [National Science Foundation](https://www.nsf.gov/)\n * Grants: 1640813, 1722646\n* [Intelligence Advanced Research Projects Activity](https://www.iarpa.gov/)\n * Contract: 2017-17042800006\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/MD2Korg/CerebralCortex-Kernel/archive/3.0.0.zip", "keywords": "mHealth machine-learning data-analysis", "license": "BSD2", "maintainer": "", "maintainer_email": "", "name": "MD2K-Cerebral-Cortex", "package_url": "https://pypi.org/project/MD2K-Cerebral-Cortex/", "platform": "", "project_url": "https://pypi.org/project/MD2K-Cerebral-Cortex/", "project_urls": { "Homepage": "https://github.com/MD2Korg/CerebralCortex-Kernel/archive/3.0.0.zip" }, "release_url": "https://pypi.org/project/MD2K-Cerebral-Cortex/3.0.0/", "requires_dist": [ "PyJWT (==1.7.1)", "PyYAML (==4.2b1)", "hdfs3 (==0.3.0)", "influxdb (==5.2.1)", "kafka (==1.3.5)", "minio (==2.2.4)", "mysql-connector-python-rf (==2.2.2)", "numpy (==1.14.5)", "pennprov (==2.2.0.dev3)", "pyarrow (==0.11.1)", "pympler (==0.5)", "pyspark (==2.4.0)", "pytz (==2017.2)", "wheel (==0.29.0)" ], "requires_python": "", "summary": "Backend data analytics platform for MD2K software", "version": "3.0.0" }, "last_serial": 4770949, "releases": { "3.0.0": [ { "comment_text": "", "digests": { "md5": "a0caf4708ec4e3434e9bd667f2aff3a6", "sha256": "9a708fb852c0098a8f0bb60e144921b1522a6d63eea009c0bffd47cef4d01c3b" }, "downloads": -1, "filename": "MD2K_Cerebral_Cortex-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "a0caf4708ec4e3434e9bd667f2aff3a6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 87291, "upload_time": "2019-02-01T23:30:18", "url": "https://files.pythonhosted.org/packages/29/14/8a4fe35203cd0eb5f200b9bb544a049219e4fe2d034ca2124bc056a98e76/MD2K_Cerebral_Cortex-3.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "49c1e6ecdf4a70572b10985df0edd1d7", "sha256": "f9cac93debd54b3804488b341e76db3de1262b5462d4e18f0c54a790712c3015" }, "downloads": -1, "filename": "MD2K: Cerebral Cortex-3.0.0.tar.gz", "has_sig": false, "md5_digest": "49c1e6ecdf4a70572b10985df0edd1d7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39776, "upload_time": "2019-02-01T23:30:20", "url": "https://files.pythonhosted.org/packages/c5/21/45eb8c6b85bfdece4bf9ceeedca94230d3cd859a023c364217f677eaced4/MD2K:%20Cerebral%20Cortex-3.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a0caf4708ec4e3434e9bd667f2aff3a6", "sha256": "9a708fb852c0098a8f0bb60e144921b1522a6d63eea009c0bffd47cef4d01c3b" }, "downloads": -1, "filename": "MD2K_Cerebral_Cortex-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "a0caf4708ec4e3434e9bd667f2aff3a6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 87291, "upload_time": "2019-02-01T23:30:18", "url": "https://files.pythonhosted.org/packages/29/14/8a4fe35203cd0eb5f200b9bb544a049219e4fe2d034ca2124bc056a98e76/MD2K_Cerebral_Cortex-3.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "49c1e6ecdf4a70572b10985df0edd1d7", "sha256": "f9cac93debd54b3804488b341e76db3de1262b5462d4e18f0c54a790712c3015" }, "downloads": -1, "filename": "MD2K: Cerebral Cortex-3.0.0.tar.gz", "has_sig": false, "md5_digest": "49c1e6ecdf4a70572b10985df0edd1d7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39776, "upload_time": "2019-02-01T23:30:20", "url": "https://files.pythonhosted.org/packages/c5/21/45eb8c6b85bfdece4bf9ceeedca94230d3cd859a023c364217f677eaced4/MD2K:%20Cerebral%20Cortex-3.0.0.tar.gz" } ] }