Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/facebookresearch/labgraph
LabGraph is a Python framework for rapidly prototyping experimental systems for real-time streaming applications. It is particularly well-suited to real-time neuroscience, physiology and psychology experiments.
https://github.com/facebookresearch/labgraph
Last synced: 8 days ago
JSON representation
LabGraph is a Python framework for rapidly prototyping experimental systems for real-time streaming applications. It is particularly well-suited to real-time neuroscience, physiology and psychology experiments.
- Host: GitHub
- URL: https://github.com/facebookresearch/labgraph
- Owner: facebookresearch
- License: mit
- Created: 2021-04-23T20:46:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-20T23:56:44.000Z (11 months ago)
- Last Synced: 2024-10-10T19:47:35.721Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 108 MB
- Stars: 161
- Watchers: 16
- Forks: 48
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# LabGraph
LabGraph is a streaming framework built by the Facebook Reality Labs Research team at Facebook. LabGraph is also mentioned in this [story](https://tech.fb.com/bci-milestone-new-research-from-ucsf-with-support-from-facebook-shows-the-potential-of-brain-computer-interfaces-for-restoring-speech-communication/). More information can be found [here](docs/index.md).
## Quick Start
### Method 1 - using PyPI (Recommended)
**Prerequisites**:
- [Python3.6+](https://www.python.org/downloads/) (Python 3.8 recommended)
- Mac (Big Sur, Monterey), Windows and Linux (CentOS 7, CentOS 8, Ubuntu 20.04; Python3.6/3.8)
- Based on [PyPa](https://github.com/pypa/manylinux), the following Linux systems are also supported: Fedora 32+, Mageia 8+, openSUSE 15.3+, Photon OS 4.0+ (3.0+ with updates), Ubuntu 20.04+
```
pip install labgraph
```
For more documentation on installation and trouble shooting, please use this [link](https://github.com/facebookresearch/labgraph/tree/main/docs/installation).
### Method 2 - building from source code
**Prerequisites**:
- [Buck](https://buck.build/setup/getting_started.html) ([Watchman](https://facebook.github.io/watchman/docs/install) also recommended)
- [Python3.6-Python3.10](https://www.python.org/downloads/)
- **Windows only:** [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019)
```
cd labgraph
python setup.py install
```
### Method 3 - using Docker
**Prerequisites**:
- [Docker](https://docs.docker.com/get-docker/)
**Setup**:
```
docker login
docker build -t IMAGE_NAME:VERSION .
docker images
docker run -it -d Image_ID
docker ps -a
docker exec -it CONTAINER_ID bash
```
### Testing:
To make sure things are working you can run the example:
```
python -m labgraph.examples.simple_viz
```
You can also run the test suite as follows:
```
python -m pytest --pyargs labgraph
```
or
```
RUN export LC_ALL=C.UTF-8
RUN export LANG=en_US.utf-8
. test_script.sh
```
Now go to the [index](docs/index.md) and [documentation](docs/) to learn more!
**License**:
LabGraph is MIT licensed, as found in the LICENSE file.