<commit_before>![x](https://raw.githubusercontent.com/marionleborgne/cloudbrain/master/cloudbrain/ui/images/cb-logo-low-res.png)

#Overview

Cloudbrain is a platform for real-time sensor data analysis and visualization. 
<br>
One type of sensor data that works well with cloudbrain is EEG data. [EEG](http://en.wikipedia.org/wiki/Electroencephalography) is the recording of electrical activity along the scalp. In other words, brainwaves.
<br>
<br>
Cloudbrain enables you to:
- **Stream sensor data** into a central database.
- **Analyze sensor data** to find spatial and temporal patterns.
- **Visualize sensor data** and patterns in real-time.

# Getting started with cloudbrain

## Option 1: Quick-start!
This makes use of the demo version of cloudbrain running at `http://cloudbrain.rocks`.
* Publishers send data to cloudbrain.
* Subscribers receive data from cloudbrain.

### Install
* `python setup.py install`

### Publishers: send data to cloudbrain
* Run `python cloudbrain/publishers/sensor_publisher.py`
* Use the `--help` flag for the docs.

### Subscribers: get data from cloudbrain
* Write data to a file: `python cloudbrain/subscribers/file_writer_subscriber.py`
* Use the `--help` flag for the docs.

## Option 2: Install cloudbrain from scratch 

### Setup 
* `python setup.py install`

#### RabbitMQ

* Install RabbitMQ and start it.
* Create cloudbrain user: `rabbitmqctl add_user cloudbrain cloudbrain`
* Grant permissions: `rabbitmqctl set_permissions cloudbrain ".*" ".*" ".*"`

### Send data to cloudbrain
* Run `python cloudbrain/publishers/sensor_publisher.py`
* Use the `--help` flag for the docs.
<commit_msg>add clone step in README<commit_after>![x](https://raw.githubusercontent.com/marionleborgne/cloudbrain/master/cloudbrain/ui/images/cb-logo-low-res.png)

#Overview

Cloudbrain is a platform for real-time sensor data analysis and visualization. 
<br>
One type of sensor data that works well with cloudbrain is EEG data. [EEG](http://en.wikipedia.org/wiki/Electroencephalography) is the recording of electrical activity along the scalp. In other words, brainwaves.
<br>
<br>
Cloudbrain enables you to:
- **Stream sensor data** into a central database.
- **Analyze sensor data** to find spatial and temporal patterns.
- **Visualize sensor data** and patterns in real-time.

# Getting started with cloudbrain

## Option 1: Quick-start!
This makes use of the demo version of cloudbrain running at `http://cloudbrain.rocks`.
* Publishers send data to cloudbrain.
* Subscribers receive data from cloudbrain.

### Clone
* `git clone https://github.com/marionleborgne/cloudbrain.git`

### Install
* `python setup.py install`

### Publishers: send data to cloudbrain
* Run `python cloudbrain/publishers/sensor_publisher.py`
* Use the `--help` flag for the docs.

### Subscribers: get data from cloudbrain
* Write data to a file: `python cloudbrain/subscribers/file_writer_subscriber.py`
* Use the `--help` flag for the docs.

## Option 2: Install cloudbrain from scratch 

### Setup 
* `python setup.py install`

#### RabbitMQ

* Install RabbitMQ and start it.
* Create cloudbrain user: `rabbitmqctl add_user cloudbrain cloudbrain`
* Grant permissions: `rabbitmqctl set_permissions cloudbrain ".*" ".*" ".*"`

### Send data to cloudbrain
* Run `python cloudbrain/publishers/sensor_publisher.py`
* Use the `--help` flag for the docs.

{'fraction_non_alphanumeric': 0.10866329264662102, 'fraction_numerical': 0.0011908306043465317, 'mean_word_length': 4.694915254237288, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4239723', 'n_tokens_mistral': 1066, 'n_tokens_neox': 976, 'n_words': 366}