Metadata-Version: 2.1
Name: arus
Version: 1.0.6
Summary: Activity Recognition with Ubiquitous Sensing
Home-page: https://github.com/qutang/arus
Keywords: ubiquitous computing,activity recognition,sensing,data processing,machine learning
Author: qutang
Author-email: tqshelly@gmail.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: demo
Provides-Extra: dev
Provides-Extra: metawear
Requires-Dist: alive-progress (>=1.5.1,<2.0.0)
Requires-Dist: dephell_versioning (>=0.1.2,<0.2.0); extra == "dev"
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: joblib (==0.11)
Requires-Dist: loguru (>=0.5.0,<0.6.0)
Requires-Dist: loky (>=2.6.0,<3.0.0)
Requires-Dist: matplotlib (>=3.1,<4.0)
Requires-Dist: numpy (>=1.17,<2.0)
Requires-Dist: pandas (>=1.0.0,<2.0.0)
Requires-Dist: pathos (>=0.2.5,<0.3.0)
Requires-Dist: playsound (>=1.2.2,<2.0.0); extra == "demo"
Requires-Dist: pymetawear (>=0.12.0,<0.13.0); extra == "metawear" or extra == "demo"
Requires-Dist: pysimplegui (>=4.14.1,<5.0.0); extra == "demo"
Requires-Dist: scikit-learn (>=0.22,<0.23)
Requires-Dist: scipy (>=1.3,<2.0)
Requires-Dist: seaborn (>=0.9.0,<0.10.0)
Requires-Dist: semver (>=2.10.1,<3.0.0); extra == "dev"
Requires-Dist: tzlocal (>=2.0.0,<3.0.0)
Requires-Dist: wget (>=3.2,<4.0)
Project-URL: Documentation, https://qutang.github.io/arus/
Project-URL: Repository, https://github.com/qutang/arus
Description-Content-Type: text/markdown

# Overview

__ARUS__ python package provides a computational and experimental framework to manage and process sensory data or wireless devices, to develop and run activity recognition algorithms on the data, and to create interactive programs using the algorithms and wireless devices.

This package is licensed under [GPL version 3](https://qutang.github.io/arus/LICENSE/).

[![PyPI version](https://badge.fury.io/py/arus.svg)](https://badge.fury.io/py/arus)  
[![Downloads](https://pepy.tech/badge/arus)](https://pepy.tech/project/arus)  
[![deployment build](https://github.com/qutang/arus/workflows/deploy/badge.svg)](https://github.com/qutang/arus/actions?query=workflow%3Adeploy)  
[![unittest and build test](https://github.com/qutang/arus/workflows/unittest%20and%20build%20test/badge.svg)](https://github.com/qutang/arus/actions?query=workflow%3A%22unittest+and+build+test%22)  
[![codecov](https://codecov.io/gh/qutang/arus/branch/master/graph/badge.svg)](https://codecov.io/gh/qutang/arus)  

## Prerequists

```bash
python >= 3.6.1
```

```bash
# Need these SDKs to install arus[metawear] on Windows.
Visual Studio C++ SDK (v14.1)
Windows SDK (10.0.16299.0)
Windows SDK (10.0.17763.0)

# Need these packages to install arus[metawear] on Ubuntu or equivalent packages on other linux distributions.
libbluetooth-dev
libboost-all-dev
bluez
```

## Installation

```bash
> pip install arus
# Optionally, you may install plugins via pip extra syntax.
> pip install arus[metawear]
> pip install arus[demo]
> pip install arus[dev]
```

## Optional components

`arus[metawear]`: This optional component installs dependency supports for streaming data from Bluetooth metawear sensors.

`arus[demo]`: This optional component installs dependency supports for running the demo app that demonstrates a real-time interactive activity recognition training and testing program.

`arus[dev]`: These optional component installs dependency supports for running some package and version management functions in the `arus.dev` module.

## Get started for development

```bash
> git clone https://github.com/qutang/arus.git
> cd arus
> # Install poetry python package management tool https://python-poetry.org/docs/
> # On Linux
> curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
> # On windows powershell
> (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
> # Install package dependencies
> poetry install
> # Install optional component dependencies
> poetry install --extras "metawear demo dev"
> # Run unit tests
> poetry run pytest
```

