radarpipeline

A python feature generation and visualzation package use with RADAR project data.

https://github.com/radar-base/radarpipeline

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary

Keywords

python
Last synced: 6 months ago · JSON representation ·

Repository

A python feature generation and visualzation package use with RADAR project data.

Basic Info
  • Host: GitHub
  • Owner: RADAR-base
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 937 KB
Statistics
  • Stars: 6
  • Watchers: 7
  • Forks: 4
  • Open Issues: 19
  • Releases: 3
Topics
python
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

RADAR Pipeline

GitHub branch checks state GitHub issues GitHub pull requests GitHub forks GitHub stars GitHub license Code style: black

An open-source python feature generation and visualization package use with RADAR project data.


Wiki

Please visit the RADAR Pipeline Wiki to learn more about RADAR Pipeline. Also see the RADAR-base Analytics Catalogue for available pipelines for processing RADAR-base data.

Wiki resources:

How to run

Note

If you are using Windows, please install Spark and set environment variables as mentioned here before going through the installation below. You'll need to set the environment variables given here.

  • 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 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.

Citation & Acknowledgment

Please use citation DOI or or see CITATION.cff

Pushkar patel has done a great amount of work under Google Summer of Code 2022. His work report can be found here. We would like to thank Pushkar for all his contribution and GSoC for giving us this opportunity.

Owner

  • Name: RADAR-base
  • Login: RADAR-base
  • Kind: organization
  • Email: radar-base@kcl.ac.uk; radar-base@thehyve.nl
  • Location: Europe

IMI2 Horizon 2020 mHealth Data Collection Platform 2015 (smartphone + wearable sensors)

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Patel"
  given-names: "Pushkar"
  orcid: "https://orcid.org/0000-0003-3410-8856"
- family-names: "Sankesara"
  given-names: "Heet"
  orcid: "https://orcid.org/0000-0002-9126-5615"
- family-names: "Folarin"
  given-names: "Amos"
  orcid: "https://orcid.org/0000-0002-0333-1927"
title: "RADAR Pipeline"
version: 1.0.0
doi: 10.5281/zenodo.7249526
date-released: 2022-10-25
url: "https://github.com/RADAR-base/radarpipeline"

GitHub Events

Total
  • Issues event: 1
  • Push event: 11
  • Gollum event: 4
  • Pull request event: 3
  • Fork event: 1
  • Create event: 3
Last Year
  • Issues event: 1
  • Push event: 11
  • Gollum event: 4
  • Pull request event: 3
  • Fork event: 1
  • Create event: 3

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 71 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: radarpipeline

A python feature generation and visualization package use with RADAR-base project data.

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 71 Last month
Rankings
Dependent packages count: 7.6%
Average: 38.5%
Dependent repos count: 69.4%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • twine *
.github/workflows/lint-and-test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
Dockerfile docker
  • openjdk slim build
pyproject.toml pypi
setup.py pypi
  • numpy ==1.22.3
  • pandas ==1.4.1
  • pyYaml ==6.0
  • pyspark *
  • scipy ==1.10.0