Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.01 KB

README.md

File metadata and controls

44 lines (28 loc) · 2.01 KB

The ARFlow Python Server

image image image Ruff Checked with pyright CI status Release status

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 the rerun logger and saved to a pickle file at the end of a session, which can be visualized later using the ARFlow Player.

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 serve # ARFlow port 8500, no save file

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

arflow replay ./FRAME_DATA_PATH.pkl # replay ARFlow data file

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.