# FlowKit - CDR Analytics Toolkit

[![CircleCI](https://img.shields.io/circleci/build/gh/Flowminder/FlowKit.svg?logo=CircleCI&style=flat-square)](https://circleci.com/gh/Flowminder/FlowKit)  [![codecov](https://img.shields.io/codecov/c/github/Flowminder/FlowKit.svg?logo=Codecov&style=flat-square)](https://codecov.io/gh/Flowminder/FlowKit) [![License: MPL 2.0](https://img.shields.io/github/license/Flowminder/FlowKit.svg?style=flat-square)](https://opensource.org/licenses/MPL-2.0) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/python/black)  [![DOI](https://zenodo.org/badge/155638125.svg)](https://zenodo.org/badge/latestdoi/155638125)

## What is FlowKit ?

FlowKit is a platform for analysis of Call Detail Records (CDR) and other data. CDR data is created by mobile network operators (MNOs) primarily for generating subscriber bills and settling accounts with other carriers.

FlowKit is designed to extend CDR data analysis to meet many other applications beyond billing. Some examples include disaster response, precision epidimiology and transport and mobility, more examples can be found here.

CDRs constitute a highly sensitive data set, so FlowKit is designed with privacy protection in mind. It includes the FlowAuth framework to enable fine-grained authorization with extensive access logging, making it an important tool for deployment of a GDPR compliant CDR analysis system.

### Documentation

The FlowKit documentation is available [here](https://flowminder.github.io/FlowKit/).

### Development status and installation

FlowKit is under ongoing development. The list of releases can be found [here](https://github.com/Flowminder/FlowKit/releases). Until FlowKit reaches full stable release status, we recommend installing the latest version based on the Github master branch. For details see the installation instructions [here](https://flowminder.github.io/FlowKit/install/).

### Benchmarks

There is a suite of benchmarks for FlowKit at https://github.com/Flowminder/FlowKit-benchmarks.<br>
The benchmark results can be seen at https://flowminder.github.io/FlowKit-benchmarks.
