Skip to content

Commit

Permalink
update readme with additional install information
Browse files Browse the repository at this point in the history
  • Loading branch information
thrau authored Jan 31, 2022
1 parent 15a668a commit e98ab95
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,14 @@ The setup includes the following steps

## Seting up the edge node (or your computer)

TODO: install procuedure (or alternatively: pull the docker images)
CognitiveXR is built to run on GPU-accelerated edge computing hardware, such as NVIDIA Jetson devices.
Our [edge-node](https://github.com/cognitivexr/edge-node) documentation gives instructions on how to build your own edge cluster.

If you want to run the platform on your computer you need:
* Docker (for building and running the platform components)
* Python (for calibrating CPOP)
* A webcam (for CPOP)
* (optional) An NVIDIA GPU with CUDA 11 and the [NVIDIA Docker Toolkit](https://github.com/NVIDIA/nvidia-docker)

## Seting up CPOP

Expand Down Expand Up @@ -70,9 +77,16 @@ The `docker-compose.yml` contains a basic docker-compose that starts up all syst
The `.env` file contains relevant parameters.
The `etc/` folder contains several configuration files that are mounted into the system components.

#### System parameters
#### Build the container images

We currently don't host pre-built docker images, so you will have to build them yourself:
* CPOP
* CogStream Mediator
* CogStream Engines (e.g., fermx, and yolov5)

TODO: document
You can find build instructions for the docker images in the respective repositories.

#### System parameters

| Variable | Description |
| -------- | ----------- |
Expand All @@ -94,6 +108,8 @@ See [the CPOP documentation](https://github.com/cognitivexr/cpop#run-the-service

#### Start the CogStream Mediator

See [the CogStream documentation](https://github.com/cognitivexr/CogStream) on how to build and run the mediator.

## Start the HoloLens App

Our [Unity Demo App](https://github.com/cognitivexr/unity-demo-app/) can be built for and deployed on the HoloLens 2.
Expand Down

0 comments on commit e98ab95

Please sign in to comment.