Giter VIP home page Giter VIP logo

associationengine's Introduction

Build Status Coverage Status

Association Engine

The main objective of the project is to establish a means of automatically detecting and reporting associations between streams of data from a wide assortment of sensors. Our system will monitor the sensor data constantly in the background, maintaining an assessment of the relationships between each pair of sensors.

Written for Python 3.6 or later

Running Example Server in Docker

This example comes with a compressed version of NOAA weather data for Birmingham (AL), Columbus (MS), Biloxi (MS), and Las Vegas (NV). The Docker image will immediately launch a server on 5000 which runs the Association Engine on a sped-up simulation of the data.

docker run -p 5000:5000 -it jacobamason/association-engine

Installing

To get Association Engine as a Python package:

pip install association-engine

You can then import AssociationEngine and use AssociationEngine.Manager and AssociationEngine.Sensor for whatever you need.

Example

import AssociationEngine

class MyCustomSensor(AssociationEngine.Sensor):

    def some_function(self):
        self.publish(some_data, some_time)


class MySubscriber:

    def on_data(self, value):
        print("The association value is: " + str(value)):


AE = AssociationEngine.Manager()
sensor_one = MyCustomSensor()
sensor_two = MyCustomSensor()

AE.add_sensor(sensor_one)
AE.add_sensor(sensor_two)

relationship = AE.get_relationship_from_sensors(sensor_one, sensor_two)
relationship.subscribe(MySubscriber())

Developer Setup

git clone https://github.com/EliCDavis/AssociationEngine
pip install -e .

After everything has been installed, try running tests to make sure everything is working correctly

pytest

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.