Skip to content

Latest commit

 

History

History
169 lines (116 loc) · 6.14 KB

README.md

File metadata and controls

169 lines (116 loc) · 6.14 KB

BORA: A Personalized Data Display for Large-scale Experiments

Contributors Forks Stargazers Issues MIT License LinkedIn


What is BORA?

BORA 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.

Table of Contents
  1. Gallery
  2. Roadmap
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

Gallery

(back to top)

Roadmap

  • Add BORA 1.0 visual widgets
  • Add documentations

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If 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". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

We follow the guidelines and conventions below:

  1. Javascript - Mozilla
  2. HTML - Mozilla
  3. CSS - Mozilla
  4. Python - PEP8

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nicholas Tan Jerome - [email protected]

(back to top)

Acknowledgments

(back to top)