Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.29 KB

tutorial_setup.md

File metadata and controls

43 lines (30 loc) · 2.29 KB

Tutorial: ImmVis Setup

This tutorial covers how to set up and run ImmVis Python Server.

Requirements

Running ImmVis Server

  1. Clone ImmVisServerPython or download its source code
  2. Open a terminal and navigate to the folder where the code was cloned/downloaded
  3. Install the required dependencies by using the install_python_dependenciesscript available on utilities folder or running the command pip install -r requirements.txt
  4. Still inside the project folder, run the command python3 -m immvis.grpc.
  5. If everything worked fine, you are going to see the following output on the terminal:
Creating DataManager
Creating ImmvisGrpcServicer
Creating GRPC server...
Creating Discovery server...
Starting ImmvisGrpcServer...
ImmvisGrpcServer has started!
Starting discovery service.
Broadcasting...
  1. To finish the server, press CTRL + C

Note: if you want to test ImmVis inside an immersive application, please refer to ImmVisClientLibraryUnity to check samples implemented using the Unity game engine.

Configuring IMMVIS_DATASETS environment variable

The ImmVis server currently provides the ListAvailableDatasets function to list the available datasets from a specific folder. To configure which folder ImmVis Server should scan, you need to have the IMMVIS_DATASETS environment variable set in your operating system.

If the variable is not available, the framework will look for datasets inside a folder named datasets inside the root folder inside this project. If you don't want to set the environment variable, consider just creating the folder and copying the datasets to it.

Development IDE

This project was developed using Visual Studio Code but feel free to use any Python IDE from your preference.

If you are using Visual Studio Code, please note that we included the launch configuration Python: Immvis Grpc to ease the development process.