{
"info": {
"author": "Tom Diethe; Meelis Kull; Niall Twomey; Kacper Sokol; Hao Song; Miquel Perello-Nieto; Emma Tonkin; Peter Flach",
"author_email": "hyperstreamhq@googlegroups.com",
"bugtrack_url": null,
"classifiers": [],
"description": ".. figure:: https://cdn.rawgit.com/IRC-SPHERE/HyperStream/dfbac332/hyperstream.svg\n :alt: HyperStream logo\n\n HyperStream logo\n\nHyperStream\n===========\n\n|DOI| |Join the chat at https://gitter.im/IRC-SPHERE-HyperStream/Lobby|\n|Build Status| |Dependency Status| |Test Coverage| |Issue Count|\n|Documentation Status|\n\nHyperstream is a large-scale, flexible and robust software package for\nprocessing streaming data.\n\n- HyperStream `homepage `__\n- Tutorial\n `notebooks `__\n- Gitter `chat room `__\n- Developer\n `documentation `__\n\nHyperstream overcomes the limitations of other computational engines and\nprovides high-level interfaces to execute complex nesting, fusion, and\nprediction both in online and offline forms in streaming environments.\nAlthough developed specifically for SPHERE, Hyperstream is a general\npurpose tool that is well-suited for the design, development, and\ndeployment of algorithms and predictive models in a wide space of\nsequential predictive problems.\n\nThis software has been designed from the outset to be\ndomain-independent, in order to provide maximum value to the wider\ncommunity. Key aspects of the software include the capability to create\ncomplex interlinked workflows, and a computational engine that is\ndesigned to be \"compute-on-request\", meaning that no unnecessary\nresources are used.\n\nInstallation\n============\n\nDocker images\n-------------\n\nIf you do not want to install all the packages separately you can use\nour Docker bundle available\n`here `__.\n\nLocal machine\n-------------\n\nInstall via pip\n\n::\n\n pip install hyperstream\n python -c 'from hyperstream import HyperStream'\n\nTo get the latest version\n\n::\n\n pip install -U git+git://github.com/IRC-SPHERE/HyperStream.git#egg=hyperstream\n pip install -r requirements.txt\n\nOr clone the repository\n\n.. code:: bash\n\n git clone git@github.com:IRC-SPHERE/HyperStream.git\n cd HyperStream\n virtualenv venv\n . venv/bin/activate\n pip install -r requirements.txt\n python -c 'from hyperstream import HyperStream'\n\nAdditionally, one of the requirements to run Hyperstream is a MongoDB\nserver. By default, Hyperstream tries to connect to the port 27017 on\nthe localhost.\n\nTo access via a cloud provider, you might try mLab, MongoDB Atlas, or\nsearch for a different one. If you are using mLab, here are a few notes:\n\n- Set up an account via the mLab web site instructions. When asked to\n pick a server type (e.g. Amazon, Google, etc) you can just choose\n free option of 500MB. This is more than enough to get started.\n- mLab will ask you to create a database; any name is fine, but make\n sure you write down what it is.\n- After creating a database, note that you\u2019ll need to create at least\n one database user in order to access the database.\n- You can test your database connection using MongoDB\u2019s built-in\n command line tools\n\nTo install MongoDB locally go to the `official\ndocumentation `__. E.g.\nin a Debian OS it is possible to install with the following command\n\n.. code:: bash\n\n sudo apt-get install mongodb\n\nOnce the MongoDB server is installed, it can be started with the\nfollowing command\n\n.. code:: bash\n\n service mongod start\n\nIf installing MongoDB on OSX\n\n.. code:: bash\n\n brew install mongodb\n\nthen\n\n.. code:: bash\n\n ln -sfv /usr/local/opt/mongodb/*.plist ~/Library/LaunchAgents\n\nrun MongoDB service with\n\n.. code:: bash\n\n launchctl load ~/Library/LaunchAgents/homebrew.mxcl.mongodb.plist\n\nRunning tests\n=============\n\nRun the following command\n\n::\n\n nosetests\n\nNote that for the MQTT logging test to succeed, you will need to have an\nMQTT broker running (e.g. Mosquitto). For example:\n\n::\n\n docker run -ti -p 1883:1883 -p 9001:9001 toke/mosquitto\n\nor on OSX you will need pidof and mosquitto:\n\n::\n\n brew install pidof\n brew install mosquitto\n brew services start mosquitto\n\nTutorials\n=========\n\nThe following tutorials show how to use HyperStream in a step-by-step\nguide.\n\n- `Tutorial 1:\n Introduction `__\n- `Tutorial 2: Creating\n tools `__\n- `Tutorial 3: Stream\n composition `__\n- `Tutorial 4: Real-time\n streams `__\n- `Tutorial 5:\n Workflows `__\n\nRunning the tutorials in a docker container\n-------------------------------------------\n\nIt is possible to run all the tutorials in your own machine ussing\nDocker containers defined in\n`IRC-SPHERE/Hyperstream-Dockerfiles `__.\nYou can do that by running the following commands:\n\n.. code:: bash\n\n git clone https://github.com/IRC-SPHERE/Hyperstream-Dockerfiles.git\n cd Hyperstream-Dockerfiles\n docker-compose -f docker-compose-tutorials.yml -p hyperstream-tutorials up\n\nAnd then open the url http://0.0.0.0:8888/tree in a web-browser\n\nRunning the tutorials in the cloned folder\n------------------------------------------\n\nTo run the tutorials in the cloned repository you will need to install\nadditional dependencies. First you should activate the virtual\nenvironment and installed the general requirements to run HyperStream\nfollowing the instructions above. After that, install the dependencies\nfor the tutorial with\n\n.. code:: bash\n\n pip install -r requirements_tutorial.txt\n\nand go to the experiments folder\n\n.. code:: bash\n\n cd experiments\n\nAnd run a Jupyter notebook\n\n.. code:: bash\n\n jupyter notebook\n\nNow you can follow the instructions from the first tutorial.\n\nSimple use-case\n---------------\n\n.. code:: python\n\n from hyperstream import HyperStream, StreamId, TimeInterval\n from hyperstream.utils import utcnow, UTC\n from datetime import timedelta\n\n hs = HyperStream(loglevel=20)\n M = hs.channel_manager.memory\n T = hs.channel_manager.tools\n clock = StreamId(name=\"clock\")\n clock_tool = T[clock].window().last().value()\n ticker = M.get_or_create_stream(stream_id=StreamId(name=\"ticker\"))\n now = utcnow()\n before = (now - timedelta(seconds=30)).replace(tzinfo=UTC)\n ti = TimeInterval(before, now)\n clock_tool.execute(sources=[], sink=ticker, interval=ti, alignment_stream=None)\n list(ticker.window().tail(5))\n\nThe last list contains\n\n.. code:: python\n\n [StreamInstance(timestamp=datetime.datetime(2017, 7, 27, 10, 33, 45, tzinfo=), value=datetime.datetime(2017, 7, 27, 10, 33, 45, tzinfo=)),\n StreamInstance(timestamp=datetime.datetime(2017, 7, 27, 10, 33, 46, tzinfo=), value=datetime.datetime(2017, 7, 27, 10, 33, 46, tzinfo=)),\n StreamInstance(timestamp=datetime.datetime(2017, 7, 27, 10, 33, 47, tzinfo=), value=datetime.datetime(2017, 7, 27, 10, 33, 47, tzinfo=)),\n StreamInstance(timestamp=datetime.datetime(2017, 7, 27, 10, 33, 48, tzinfo=), value=datetime.datetime(2017, 7, 27, 10, 33, 48, tzinfo=)),\n StreamInstance(timestamp=datetime.datetime(2017, 7, 27, 10, 33, 49, tzinfo=), value=datetime.datetime(2017, 7, 27, 10, 33, 49, tzinfo=))]\n\nHyperStream Viewer\n==================\n\nThe `HyperStream\nViewer `__ is a\npython/Flask web-app for interacting with HyperStream. In order to keep\nHyperStream to a minimum, this web-app is released as a separate\nrepository that takes the core as a dependency.\n\nLicense\n=======\n\nThis code is released under the `MIT\nlicense `__.\n\nAcknowledgements\n================\n\nThis work has been funded by the UK Engineering and Physical Sciences\nResearch Council (EPSRC) under Grant\n`EP/K031910/1 `__\n- \"SPHERE Interdisciplinary Research Collaboration\".\n\n.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.242227.svg\n :target: https://doi.org/10.5281/zenodo.242227\n.. |Join the chat at https://gitter.im/IRC-SPHERE-HyperStream/Lobby| image:: https://badges.gitter.im/IRC-SPHERE-HyperStream/Lobby.svg\n :target: https://gitter.im/IRC-SPHERE-HyperStream/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n.. |Build Status| image:: https://travis-ci.org/IRC-SPHERE/HyperStream.svg?branch=master\n :target: https://travis-ci.org/IRC-SPHERE/HyperStream\n.. |Dependency Status| image:: https://www.versioneye.com/user/projects/58e423cb26a5bb005220301e/badge.svg?style=flat-square\n :target: https://www.versioneye.com/user/projects/58e423cb26a5bb005220301e\n.. |Test Coverage| image:: https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage\n :target: https://codeclimate.com/github/codeclimate/codeclimate/test_coverage\n.. |Issue Count| image:: https://codeclimate.com/github/IRC-SPHERE/HyperStream/badges/issue_count.svg\n :target: https://codeclimate.com/github/IRC-SPHERE/HyperStream\n.. |Documentation Status| image:: https://readthedocs.org/projects/hyperstream/badge/?version=latest\n :target: http://hyperstream.readthedocs.io/en/latest/?badge=latest",
"description_content_type": null,
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://irc-sphere.github.io/HyperStream/",
"keywords": "",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "hyperstream",
"package_url": "https://pypi.org/project/hyperstream/",
"platform": "",
"project_url": "https://pypi.org/project/hyperstream/",
"project_urls": {
"Homepage": "https://irc-sphere.github.io/HyperStream/"
},
"release_url": "https://pypi.org/project/hyperstream/0.3.8/",
"requires_dist": null,
"requires_python": "",
"summary": "Hyperstream is a large-scale, flexible and robust software package for processing streaming data",
"version": "0.3.8"
},
"last_serial": 3471801,
"releases": {
"0.2.6": [
{
"comment_text": "",
"digests": {
"md5": "43618d1b0cf0343b12ddf0103c435e06",
"sha256": "4891382f1dd1161d9e31780e8f6d18c6a0ba1f7300fc9404e78a5a396ffc13b5"
},
"downloads": -1,
"filename": "hyperstream-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "43618d1b0cf0343b12ddf0103c435e06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 78342,
"upload_time": "2017-07-12T21:22:43",
"url": "https://files.pythonhosted.org/packages/13/ce/547684912e9d008b5f935aa0263d4838253f23e7da6ade58ff9ee75c1425/hyperstream-0.2.6.tar.gz"
}
],
"0.3.1": [
{
"comment_text": "",
"digests": {
"md5": "c8b37d7b7eea549e24c3b794bbc6a4b2",
"sha256": "1e4630e248348e7b952edea8c897a778ed268173e1d4fb1ec19fc299737610e0"
},
"downloads": -1,
"filename": "hyperstream-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "c8b37d7b7eea549e24c3b794bbc6a4b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 106389,
"upload_time": "2017-07-24T20:44:13",
"url": "https://files.pythonhosted.org/packages/04/ff/71c0d9e26f299983347e3f37e03fabf46c9cb4f87c0c49d0c31672c0b9d2/hyperstream-0.3.1.tar.gz"
}
],
"0.3.2": [
{
"comment_text": "",
"digests": {
"md5": "d95b9aa2d505e5433f5b317955178300",
"sha256": "b441925889e59ce8e2e93f19ec7f4992e4425c2ec66c7df7e121fdbee049a301"
},
"downloads": -1,
"filename": "hyperstream-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "d95b9aa2d505e5433f5b317955178300",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 106606,
"upload_time": "2017-07-24T20:50:51",
"url": "https://files.pythonhosted.org/packages/a6/82/e5a40d1e92a6419223af0475b747043d79a6140b0fd1181c7e4c984e302f/hyperstream-0.3.2.tar.gz"
}
],
"0.3.3": [
{
"comment_text": "",
"digests": {
"md5": "d145aebc2e57095df777e062a084783e",
"sha256": "9c79c74ddce2216ab803f5f1520e5bc90dd87e9610da60e68bada9130bb68872"
},
"downloads": -1,
"filename": "hyperstream-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "d145aebc2e57095df777e062a084783e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 106161,
"upload_time": "2017-07-24T21:56:23",
"url": "https://files.pythonhosted.org/packages/33/62/ac4f15d682cfaa14f51238221e9becde38b8bcaa2761ea54fb7508d61dee/hyperstream-0.3.3.tar.gz"
}
],
"0.3.4": [
{
"comment_text": "",
"digests": {
"md5": "7370557f9d246755f32f8b995a767dba",
"sha256": "d77a235d291a255be3455711c6f51baef9dab8453d1c67396cf56d0e13846210"
},
"downloads": -1,
"filename": "hyperstream-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "7370557f9d246755f32f8b995a767dba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 106167,
"upload_time": "2017-07-24T22:41:59",
"url": "https://files.pythonhosted.org/packages/15/4e/1c1852fc4ce3dc29fc9072db56f7c122ba13630dcad042866ca8f389abd1/hyperstream-0.3.4.tar.gz"
}
],
"0.3.5": [
{
"comment_text": "",
"digests": {
"md5": "3924975800fcfd46546b2f0846aeb538",
"sha256": "6db65d12eda5933029f119c1f042cfc310d03ac11aa6b3c0e494691c0986d9c6"
},
"downloads": -1,
"filename": "hyperstream-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "3924975800fcfd46546b2f0846aeb538",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 107084,
"upload_time": "2017-07-25T09:28:39",
"url": "https://files.pythonhosted.org/packages/f5/e8/c4985c359358aa9c862da94241317e51f81829023a704205bd0ba5b43709/hyperstream-0.3.5.tar.gz"
}
],
"0.3.6": [
{
"comment_text": "",
"digests": {
"md5": "9bc1e9bef4c87052bfb02c603949afc5",
"sha256": "3f5350ccdaab69ddd41e98a1f4f8255af45c89f866be6f22f23b4d44423929bf"
},
"downloads": -1,
"filename": "hyperstream-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "9bc1e9bef4c87052bfb02c603949afc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 109861,
"upload_time": "2017-07-27T01:41:59",
"url": "https://files.pythonhosted.org/packages/f5/24/a1ad145d8d6b5f46268b169c42c7cd8d90f2fbe294ca0bc84aa3a8004c0c/hyperstream-0.3.6.tar.gz"
}
],
"0.3.7": [
{
"comment_text": "",
"digests": {
"md5": "306f21aeca21c34f9f9eb283d86c220c",
"sha256": "d272f2ceea3bc143adf66238d22e0cf7f30b22d0a0c03ad3b0cd39f1d83d4e75"
},
"downloads": -1,
"filename": "hyperstream-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "306f21aeca21c34f9f9eb283d86c220c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 110852,
"upload_time": "2017-08-13T19:08:13",
"url": "https://files.pythonhosted.org/packages/c3/8c/a54e51f5173552a0f9b9b7f45db2c927775af71ea2ebe60d92bdb3d1b246/hyperstream-0.3.7.tar.gz"
}
],
"0.3.8": [
{
"comment_text": "",
"digests": {
"md5": "ad7dcae1e5eee9183b5a9aa50207f850",
"sha256": "7cf3a54ce791e6c3eb330b7c2b6b8fd6d9a15ac1902afc79761304f795dbcc66"
},
"downloads": -1,
"filename": "hyperstream-0.3.8.tar.gz",
"has_sig": false,
"md5_digest": "ad7dcae1e5eee9183b5a9aa50207f850",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 112232,
"upload_time": "2018-01-08T18:03:26",
"url": "https://files.pythonhosted.org/packages/03/31/aa104ddf3557836715fc25f4f41fa0ff08f9937863a0337d08eef4f433c9/hyperstream-0.3.8.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ad7dcae1e5eee9183b5a9aa50207f850",
"sha256": "7cf3a54ce791e6c3eb330b7c2b6b8fd6d9a15ac1902afc79761304f795dbcc66"
},
"downloads": -1,
"filename": "hyperstream-0.3.8.tar.gz",
"has_sig": false,
"md5_digest": "ad7dcae1e5eee9183b5a9aa50207f850",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 112232,
"upload_time": "2018-01-08T18:03:26",
"url": "https://files.pythonhosted.org/packages/03/31/aa104ddf3557836715fc25f4f41fa0ff08f9937863a0337d08eef4f433c9/hyperstream-0.3.8.tar.gz"
}
]
}