Science Score: 36.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    2 of 8 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.5%) to scientific vocabulary

Keywords

flask restful-api signals
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: sintel-dev
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 23 MB
Statistics
  • Stars: 18
  • Watchers: 2
  • Forks: 2
  • Open Issues: 14
  • Releases: 1
Topics
flask restful-api signals
Created over 5 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog License Authors

README.md

“DAI-Lab” An open source project from Data to AI Lab at MIT.

Development Status PyPI Shield Github Workflow Status Coverage Status Downloads

Sintel

Sintel (Signal Intelligence) provides Restful APIs to process massive signal data for anomaly analysis in an efficient and user-friendly way.

  • License: MIT
  • Development Status: Pre-Alpha
  • Homepage: https://github.com/sintel-dev/sintel

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

  • Python (>= 3.8) - Sintel has been developed and runs on Python 3.8. Although it is not strictly required, the usage of a virtualenv is highly recommended in order to avoid interfering with other software installed in the system where MTV is run. To this end, Anaconda python is suggested to maintain the virtual environments.
  • Git - Download & Install Git. OSX and Linux machines typically have this already installed.
  • MongoDB (>= 4.4) - Download & Install MongoDB, and make sure it's running on the default port (27017).

Get Started

Quick Install

Once you've downloaded the Sintel repository and installed all the prerequisites, you're just a few steps away from running your application. To install the project, create a virtualenv and execute

bash $ make install

This command will install all the dependencies needed for the application to run. For development, use the following command instead, which will install some additional dependencies for code linting and testing

bash $ make install-develop

Download demo data and load it to the mongodb. The database name by default is sintel. bash $ make load-db

Running Your Application

Please activate your virtualenv, and then launch the API server:

bash $ sintel run -v

Go to the API playground (http://localhost:3000/apidocs) to have a try.

Development

Run the following command for the purpose of development

bash $ sintel run -E development -v

API Documentations

Once the server runs up, you should be able to open the following API interfaces:

  • http://localhost:3000/apidocs (Swagger UI style)
  • http://localhost:3000/redoc (Redoc UI style)

Use Your Own Data

Follow the tutorial .tutorials/Anomaly Detection.ipynb for detail.

Use Docker to deploy

  • Install Docker and Compose

  • Load data into the mongo container

    bash $ make docker-db-up

    bash $ make docker-up

Go to the API playground (http://localhost:3000/apidocs) to have a try. For further commands, please refer to Makefile, the session of Docker Installation.

Owner

  • Name: The Signal Intelligence Project
  • Login: sintel-dev
  • Kind: organization
  • Email: dai-lab@mit.edu

Systems and tools to design, develop and deploy AI applications on top of signals.

GitHub Events

Total
  • Issues event: 2
  • Watch event: 3
  • Issue comment event: 1
  • Fork event: 1
Last Year
  • Issues event: 2
  • Watch event: 3
  • Issue comment event: 1
  • Fork event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 675
  • Total Committers: 8
  • Avg Commits per committer: 84.375
  • Development Distribution Score (DDS): 0.459
Past Year
  • Commits: 5
  • Committers: 2
  • Avg Commits per committer: 2.5
  • Development Distribution Score (DDS): 0.4
Top Committers
Name Email Commits
sergiu-ojoc s****c@b****o 365
dyuliu u****u@g****m 163
dyuliu w****y@g****m 140
Sarah Alnegheimish s****h@g****m 2
DAILab-bot 1****t 2
sergiu-ojoc 4****c 1
dongyu d****u@d****u 1
Kalyan Veeramachaneni k****u@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 7
  • Total pull requests: 17
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 11 days
  • Total issue authors: 5
  • Total pull request authors: 3
  • Average comments per issue: 0.43
  • Average comments per pull request: 0.29
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dyuliu (3)
  • sitaram70 (1)
  • shimon-sato (1)
  • siddharthrathi1 (1)
  • ouccoffee (1)
  • AungDev (1)
Pull Request Authors
  • dyuliu (8)
  • DAILab-bot (8)
  • sarahmish (1)
Top Labels
Issue Labels
enhancement (2) bug (1)
Pull Request Labels

Dependencies

.github/workflows/latest-dependencies.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • peter-evans/create-pull-request v3 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/minimum.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • supercharge/mongodb-github-action 1.3.0 composite
.github/workflows/restapi.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • supercharge/mongodb-github-action 1.3.0 composite
.github/workflows/unit.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
Dockerfile docker
  • ubuntu 18.04 build
docker-compose-db.yml docker
  • mongo 4.0
docker-compose.yml docker
  • mongo 4.0
setup.py pypi
  • Auth *
  • Database *
  • Flask ==1.0.2
  • Flask *
  • Flask-Cors ==3.0.7
  • Flask-RESTful ==0.3.9
  • General *
  • Jinja2 >=2.10,<3.1
  • MarkupSafe ==2.0.1
  • Math *
  • PyYAML ==5.1
  • Sintel *
  • Werkzeug ==0.15.5
  • flasgger ==0.9.5
  • gevent >=21.12.0
  • itsdangerous ==2.0.1
  • mongoengine >=0.20.0,<0.25
  • oauthlib ==3.1.0
  • orion-ml >=0.4.0
  • orion-ml *
  • passlib ==1.7.2
  • pyOpenSSL ==23.0.0
  • pymongo >=3.7.2,<4
  • pyts ==0.10.0
  • requests ==2.24.0
  • termcolor ==1.1.0
  • tqdm ==4.48.0
tests/requirement_files/latest_requirements.txt pypi
  • Jinja2 ==3.0.3 test
  • gevent ==21.12.0 test
  • mongoengine ==0.24.2 test
  • orion-ml ==0.3.2 test
  • pymongo ==3.12.3 test