{"id":24087361,"url":"https://github.com/kit-ipe/bora","last_synced_at":"2026-03-02T08:33:25.413Z","repository":{"id":53535348,"uuid":"59098563","full_name":"kit-ipe/bora","owner":"kit-ipe","description":"A Personalized Data Display for Large-scale Experiments","archived":false,"fork":false,"pushed_at":"2024-12-13T19:11:41.000Z","size":15263,"stargazers_count":2,"open_issues_count":3,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-27T04:47:47.292Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kit-ipe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-18T08:52:22.000Z","updated_at":"2024-12-13T19:11:46.000Z","dependencies_parsed_at":"2024-01-13T17:38:09.338Z","dependency_job_id":"b5554ce0-b3f2-457d-95b8-e1d264dcffe3","html_url":"https://github.com/kit-ipe/bora","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/kit-ipe/bora","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-ipe%2Fbora","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-ipe%2Fbora/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-ipe%2Fbora/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-ipe%2Fbora/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kit-ipe","download_url":"https://codeload.github.com/kit-ipe/bora/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-ipe%2Fbora/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29995912,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T01:47:34.672Z","status":"online","status_checked_at":"2026-03-02T02:00:07.342Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-10T03:24:42.978Z","updated_at":"2026-03-02T08:33:25.395Z","avatar_url":"https://github.com/kit-ipe.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n# BORA: A Personalized Data Display for Large-scale Experiments\n \n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./assets/katrin.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\n## What is BORA?\nBORA is an open source visualization framework supporting large-scale experiments by generating personalized data displays and enabling the human-in-the-loop concept within the experiment. Despite the complex experiment setup, BORA allows scientists to build their desired data displays with no programming knowledge. There are two facets to the framework, with the first facet being a read-only data displays where it helps scientists to monitor the health of the experiment subsystems. The second facet enables scientists to control the systems and data acquisition parameters. It enables feedback for multiple data processing pipelines that interact with the large volume of data in real-time. Bora is built around RESTful APIs and offers support for various standard protocols through plugin extensions for databases (e.g., Redis) and for control protocols (e.g., OPC). Furthermore, we implemented experiment-specific protocols used in our projects, such as ORCA. One unique feature of BORA is that it supports video streaming analysis of experimental data, allowing visual representation of the subsystem, e.g., surface temperature monitoring, detector heatmap.\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n    \u003c!--\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    --\u003e\n    \u003cli\u003e\u003ca href=\"#gallery\"\u003eGallery\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n## Prerequisite\n\nPlease start a separate redis database\n\n    $ docker run -p 6379:6379 -it --rm redislabs/redistimeseries\n\n## Getting Started\n\n    $ mkdir new_bora\n\n    $ cd new_bora\n\n    $ git clone https://github.com/kit-ipe/bora.git\n\n    $ python -m venv env\n\n    $ source env/bin/activate\n\n    (env)$ pip install -r bora/requirements.txt\n\n    (env)$ python bora/start.py\n    Enter the new title: slope\n    Enter the new port: 8000\n    Settings updated successfully!\n    Bora repository already cloned.\n    Do you want to use the default background image provided? (Enter 'yes' for default, or enter 'no' to provide your own image path): yes\n    Using default background image.\n\n    (env)$ python bora/core.py\n\nNow launch http://localhost:8000 to see the BORA page, to add widgets, go to http://localhost:8000/designer\n\n\u003c!--\n### Prerequisites\n\nTODO\n\n### Installation\n\nTODO\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n--\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Gallery\n\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./assets/cps.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./assets/dps.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./assets/wgts.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"./assets/wgts_magnet.png\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\n- [ ] Add BORA 1.0 visual widgets\n- [ ] Add documentations\n\nSee the [open issues](https://github.com/kit-ipe/bora/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nWe follow the guidelines and conventions below:\n\n1. [Javascript - Mozilla](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/JavaScript)\n2. [HTML - Mozilla](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/HTML)\n3. [CSS - Mozilla](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/CSS)\n4. [Python - PEP8](https://peps.python.org/pep-0008/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nNicholas Tan Jerome - nicholas.tanjerome@kit.edu\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n\n* [The KATRIN Experiment](https://www.katrin.kit.edu/index.php)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/kit-ipe/bora.svg?style=for-the-badge\n[contributors-url]: https://github.com/kit-ipe/bora/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/kit-ipe/bora.svg?style=for-the-badge\n[forks-url]: https://github.com/kit-ipe/bora/network/members\n[stars-shield]: https://img.shields.io/github/stars/kit-ipe/bora.svg?style=for-the-badge\n[stars-url]: https://github.com/kit-ipe/bora/stargazers\n[issues-shield]: https://img.shields.io/github/issues/kit-ipe/bora.svg?style=for-the-badge\n[issues-url]: https://github.com/kit-ipe/bora/issues\n[license-shield]: https://img.shields.io/github/license/kit-ipe/bora.svg?style=for-the-badge\n[license-url]: https://github.com/kit-ipe/bora/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://www.linkedin.com/in/nicholastanjerome/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkit-ipe%2Fbora","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkit-ipe%2Fbora","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkit-ipe%2Fbora/lists"}