Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.66 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.66 KB

The ARFlow Python Server

Ruff Checked with pyright

The ARFlow Python server collects streaming data from your ARFlow clients. The server is designed to be easily extensible and can be integrated with your own research prototype. Data is streamed to a Rerun logger and saved to RRD files, which can be visualized later using the Rerun Viewer.

Installation

The ARFlow server can be simply installed via pip:

# Create a python environment using your favorite tool, then
pip install arflow

Server CLI

Here are some example usages of the ARFlow server CLI:

arflow view # ARFlow port 8500, view mode, no save to files

arflow save -p 1234 -s ./ # ARFlow port 1234, save to current working directory

arflow rerun ./FRAME_DATA_PATH.rrd # replay ARFlow data file

arflow rerun *.rrd # replay multiple ARFlow data files

arflow -h # show help

Examples

Check out the examples. We recommend starting with the simple example.

Contributing

We welcome contributions to ARFlow! Please refer to the CONTRIBUTING.md file for more information.