<h1 align="center">RADAR Pipeline</h1>
<p align="center">
<a href="https://github.com/RADAR-base/radarpipeline"><img alt="GitHub branch checks state" src="https://img.shields.io/github/checks-status/RADAR-base/radarpipeline/main"></a>
<a href="https://github.com/RADAR-base/radarpipeline/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/RADAR-base/radarpipeline"></a>
<a href="https://github.com/thepushkarp/radarpipeline/pulls"><img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/radar-base/radarpipeline"></a>
<a href="https://github.com/RADAR-base/radarpipeline/network"><img alt="GitHub forks" src="https://img.shields.io/github/forks/RADAR-base/radarpipeline"></a>
<a href="https://github.com/RADAR-base/radarpipeline/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/RADAR-base/radarpipeline"></a>
<a href="https://github.com/RADAR-base/radarpipeline/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/RADAR-base/radarpipeline"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
<p align="center">An open-source python feature generation and visualization package use with RADAR project data.</p>
---
## Wiki
Please visit the [RADAR Pipeline Wiki](https://github.com/RADAR-base/radarpipeline/wiki) to learn more about RADAR Pipeline. Also see the [RADAR-base Analytics Catalogue](https://github.com/RADAR-base-Analytics) for available pipelines for processing RADAR-base data.
Wiki resources:
- [Home](https://github.com/RADAR-base/radarpipeline/wiki)
- [Installation](https://github.com/RADAR-base/radarpipeline/wiki/Installation#installation-instructions)
- [Contributor Guide](https://github.com/RADAR-base/radarpipeline/wiki/Contributor-Guide)
- [Mock Pipeline](https://github.com/RADAR-base/radarpipeline/wiki/Mock-Pipeline)
- [Configuration](https://github.com/RADAR-base/radarpipeline/wiki/Configuration)
- [Data Ingestion](https://github.com/RADAR-base/radarpipeline/wiki/Data-Ingestion)
- [Setup](https://github.com/RADAR-base/radarpipeline/wiki/Setup)
- [Pipeline Core Topics](https://github.com/RADAR-base/radarpipeline/wiki/Pipeline-Core-Topics)
- [Creating Citable Analytics Pipelines](https://github.com/RADAR-base/radarpipeline/wiki/Creating-Citable-Analytics-Pipelines)
## How to run
> **Note**
>
> If you are using Windows, please install Spark and set environment variables as mentioned [here](https://sparkbyexamples.com/spark/apache-spark-installation-on-windows/) before going through the installation below. You'll need to set the environment variables given [here](https://spark.apache.org/docs/1.6.0/configuration.html#environment-variables).
- Clone the repository (with all the submodules):
```bash
$ git clone --recurse-submodules https://github.com/RADAR-base/radarpipeline.git
```
- Change the directory to `radarpipeline`:
```bash
$ cd radarpipeline
```
- Checkout the development branch:
```bash
$ git checkout dev
```
- Create a [virtual environment](https://virtualenv.pypa.io/en/latest/installation.html) and activate it. The instructions here use `virtualenv` but feel free to use any python virtual environment manager of your choice.
- Install the virtualenv package:
```bash
$ python -m pip install --user virtualenv
```
- Create a python virtual environment:
```bash
$ python -m virtualenv env
```
- Activate the virtual environment:
On Windows, run:
```bash
$ .\env\Scripts\activate
```
On Linux or MacOS, run:
```bash
$ source ./env/bin/activate
```
- Install the dependencies:
```bash
$ python -m pip install -r requirements.txt
```
- Install the module as a python package by running the command
```bash
$ python -m pip install -e .
```
- To verify the installations, run the following command in the project root directory to run the pipeline:
```bash
$ python .
```
- The pipeline would do a mock run and ingest the data in the `mock-data` directory. You can see some outputs in the CLI and if the project is installed correctly, the mock pipeline would run without errors and save the data to the `output` directory.
## License
This project is licensed under the [ Apache License, Version 2.0](https://github.com/RADAR-base/radarpipeline/blob/main/LICENSE).
## Citation & Acknowledgment
Please use citation [](https://doi.org/10.5281/zenodo.7249526) or or see [CITATION.cff](/CITATION.cff)
[Pushkar patel](https://github.com/thepushkarp) has done a great amount of work under Google Summer of Code 2022. His work report can be found [here](https://thepushkarp.github.io/RADAR-Base-GSoC-2022-Report/). We would like to thank Pushkar for all his contribution and GSoC for giving us this opportunity.
Raw data
{
"_id": null,
"home_page": "https://github.com/RADAR-base/radarpipeline",
"name": "radarpipeline",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mhealth,pipeline,big-data",
"author": "Heet Sankesara, Amos Folarin",
"author_email": "heet.sankesara@kcl.ac.uk, amos.folarin@kcl.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/36/02/eeb3259124b293a740d72856581eca31fba8344f25f3f86642f26681d7dc/radarpipeline-2.0.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">RADAR Pipeline</h1>\n\n<p align=\"center\">\n<a href=\"https://github.com/RADAR-base/radarpipeline\"><img alt=\"GitHub branch checks state\" src=\"https://img.shields.io/github/checks-status/RADAR-base/radarpipeline/main\"></a>\n<a href=\"https://github.com/RADAR-base/radarpipeline/issues\"><img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/RADAR-base/radarpipeline\"></a>\n<a href=\"https://github.com/thepushkarp/radarpipeline/pulls\"><img alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/radar-base/radarpipeline\"></a>\n<a href=\"https://github.com/RADAR-base/radarpipeline/network\"><img alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/RADAR-base/radarpipeline\"></a>\n<a href=\"https://github.com/RADAR-base/radarpipeline/stargazers\"><img alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/RADAR-base/radarpipeline\"></a>\n<a href=\"https://github.com/RADAR-base/radarpipeline/blob/main/LICENSE\"><img alt=\"GitHub license\" src=\"https://img.shields.io/github/license/RADAR-base/radarpipeline\"></a>\n<a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n</p>\n\n<p align=\"center\">An open-source python feature generation and visualization package use with RADAR project data.</p>\n\n---\n\n## Wiki\n\nPlease visit the [RADAR Pipeline Wiki](https://github.com/RADAR-base/radarpipeline/wiki) to learn more about RADAR Pipeline. Also see the [RADAR-base Analytics Catalogue](https://github.com/RADAR-base-Analytics) for available pipelines for processing RADAR-base data.\n\nWiki resources:\n\n- [Home](https://github.com/RADAR-base/radarpipeline/wiki)\n- [Installation](https://github.com/RADAR-base/radarpipeline/wiki/Installation#installation-instructions)\n- [Contributor Guide](https://github.com/RADAR-base/radarpipeline/wiki/Contributor-Guide)\n- [Mock Pipeline](https://github.com/RADAR-base/radarpipeline/wiki/Mock-Pipeline)\n- [Configuration](https://github.com/RADAR-base/radarpipeline/wiki/Configuration)\n- [Data Ingestion](https://github.com/RADAR-base/radarpipeline/wiki/Data-Ingestion)\n- [Setup](https://github.com/RADAR-base/radarpipeline/wiki/Setup)\n- [Pipeline Core Topics](https://github.com/RADAR-base/radarpipeline/wiki/Pipeline-Core-Topics)\n- [Creating Citable Analytics Pipelines](https://github.com/RADAR-base/radarpipeline/wiki/Creating-Citable-Analytics-Pipelines)\n\n## How to run\n\n> **Note**\n>\n> If you are using Windows, please install Spark and set environment variables as mentioned [here](https://sparkbyexamples.com/spark/apache-spark-installation-on-windows/) before going through the installation below. You'll need to set the environment variables given [here](https://spark.apache.org/docs/1.6.0/configuration.html#environment-variables).\n\n- Clone the repository (with all the submodules):\n\n ```bash\n $ git clone --recurse-submodules https://github.com/RADAR-base/radarpipeline.git\n ```\n\n- Change the directory to `radarpipeline`:\n\n ```bash\n $ cd radarpipeline\n ```\n\n- Checkout the development branch:\n\n ```bash\n $ git checkout dev\n ```\n\n- Create a [virtual environment](https://virtualenv.pypa.io/en/latest/installation.html) and activate it. The instructions here use `virtualenv` but feel free to use any python virtual environment manager of your choice.\n\n - Install the virtualenv package:\n\n ```bash\n $ python -m pip install --user virtualenv\n ```\n\n - Create a python virtual environment:\n\n ```bash\n $ python -m virtualenv env\n ```\n\n - Activate the virtual environment:\n\n On Windows, run:\n\n ```bash\n $ .\\env\\Scripts\\activate\n ```\n\n On Linux or MacOS, run:\n\n ```bash\n $ source ./env/bin/activate\n ```\n\n- Install the dependencies:\n\n ```bash\n $ python -m pip install -r requirements.txt\n ```\n\n- Install the module as a python package by running the command\n\n ```bash\n $ python -m pip install -e .\n ```\n\n- To verify the installations, run the following command in the project root directory to run the pipeline:\n\n ```bash\n $ python .\n ```\n\n- The pipeline would do a mock run and ingest the data in the `mock-data` directory. You can see some outputs in the CLI and if the project is installed correctly, the mock pipeline would run without errors and save the data to the `output` directory.\n\n## License\n\nThis project is licensed under the [ Apache License, Version 2.0](https://github.com/RADAR-base/radarpipeline/blob/main/LICENSE).\n\n## Citation & Acknowledgment \nPlease use citation [](https://doi.org/10.5281/zenodo.7249526) or or see [CITATION.cff](/CITATION.cff)\n\n[Pushkar patel](https://github.com/thepushkarp) has done a great amount of work under Google Summer of Code 2022. His work report can be found [here](https://thepushkarp.github.io/RADAR-Base-GSoC-2022-Report/). We would like to thank Pushkar for all his contribution and GSoC for giving us this opportunity. \n",
"bugtrack_url": null,
"license": "Apache",
"summary": "A python feature generation and visualization package use with RADAR project data.",
"version": "2.0.1",
"project_urls": {
"Download": "https://github.com/RADAR-base/radarpipeline/archive/refs/tags/v2.0.1.tar.gz",
"Homepage": "https://github.com/RADAR-base/radarpipeline"
},
"split_keywords": [
"mhealth",
"pipeline",
"big-data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f2b8ce69c4acd21c96dffa2931bc79fae42387d88a728a491b8e8396bd953d7",
"md5": "6dc52bd6a7951163954e2ee5011ad517",
"sha256": "97a937b469d540e13aa4701157e9b91a066e29cf1639e7ece6050c7871d6f233"
},
"downloads": -1,
"filename": "radarpipeline-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6dc52bd6a7951163954e2ee5011ad517",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 34592,
"upload_time": "2023-08-04T09:50:56",
"upload_time_iso_8601": "2023-08-04T09:50:56.514515Z",
"url": "https://files.pythonhosted.org/packages/0f/2b/8ce69c4acd21c96dffa2931bc79fae42387d88a728a491b8e8396bd953d7/radarpipeline-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3602eeb3259124b293a740d72856581eca31fba8344f25f3f86642f26681d7dc",
"md5": "062b97a26bceac77b142f25232bac669",
"sha256": "e841e834e954f1326eb60d5ebca44aa73b50f194df26376befd0337adeb51c81"
},
"downloads": -1,
"filename": "radarpipeline-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "062b97a26bceac77b142f25232bac669",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27973,
"upload_time": "2023-08-04T09:50:58",
"upload_time_iso_8601": "2023-08-04T09:50:58.447204Z",
"url": "https://files.pythonhosted.org/packages/36/02/eeb3259124b293a740d72856581eca31fba8344f25f3f86642f26681d7dc/radarpipeline-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-04 09:50:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RADAR-base",
"github_project": "radarpipeline",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "radarpipeline"
}
JSON
