Getting Started with VolView

Overview

This guide provides a quick introduction to getting started with the VolView server and viewer. Follow the steps below to set up and run the server, and then explore the remote functionality via the viewer.

Starting the Server

To start the VolView server, you'll need to install Poetry and create a new Python environment.

1. Navigate to the server directory:

   cd ./server/

2. Install the required dependencies using Poetry:

   poetry install

3. The VolView codebase includes several sample APIs located in server/examples/:

   • example_api.py: A basic set of example endpoints
   • example_class_api.py: Example endpoints using a class

4. To run the server with a sample API, use the following command:

   cd ./server/
   poetry run python -m volview_server -P 4014 ./examples/example_api.py

Running the Viewer

1. Configure the viewer to connect to the server by copying .env.example to .env and updating the server URL:

   VITE_REMOTE_SERVER_URL=http://localhost:4014/

2. In a separate terminal from the server terminal, run the following commands to start the viewer application:

   npm install
   npm run build
   npm run preview

3. The preview server will be available at http://localhost:4173/.

Debugging the Volview

steps : Link