https://github.com/kitware/paraviewweb-demo

Website and launcher for ParaViewWeb container demo
https://github.com/kitware/paraviewweb-demo

Last synced: 3 days ago
JSON representation

Website and launcher for ParaViewWeb container demo

• Host: GitHub
• URL: https://github.com/kitware/paraviewweb-demo
• Owner: Kitware
• License: bsd-3-clause
• Created: 2019-11-06T21:46:59.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-27T17:08:20.000Z (about 1 year ago)
• Last Synced: 2024-12-30T11:44:09.148Z (19 days ago)
• Language: HTML
• Size: 5.8 MB
• Stars: 11
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Introduction

This repository is home to the website and launcher configuration for ParaViewWeb container demos that can be run with the Docker images available on the ParaView DockerHub [repository](https://hub.docker.com/repository/docker/kitware/paraview).

Here is a screenshot of the website, where each screenshot is actually a link to launch an interactive web application within the container.

![ParaViewWeb Demo](images/ParaViewWebDemo.png)

## Instructions for use

The basic idea is to download a [zip](https://github.com/Kitware/paraviewweb-demo/archive/master.zip) of this repository and unpack it into some location on the machine where you want to launch the demo.  Then simply execute a `docker run ...` command line giving the appropriate command-line options, and that's it.

In order for the demo to show something interesting, some data needs to be made available.  In fact, for some of the links from the website to work, there are some requirement about what files are available within the mounted data directory.  At a miminum the data root directory needs to contain the `disk_out_ref.ex2` file available with the ParaView data.

### Detailed Steps

First set some environment variables defining the ParaViewWeb docker image you want to run, and the host/port you want to use:

```

# export IMAGE_TO_RUN="pvw-v5.7.1-osmesa-py2"

# export IMAGE_TO_RUN="pvw-v5.7.1-osmesa-py3"

# export IMAGE_TO_RUN="pvw-v5.7.1-egl-py2"

export IMAGE_TO_RUN="pvw-v5.7.1-egl-py3"

export DEMO_HOST=www.example.com

export DEMO_PORT=9000

```

Then download the demo website and some sample data, and start the demo server.  If you pick an `egl` image to run, you need to invoke `docker` with the `--gpus all` flag.  If you instead choose an `osmesa` image (maybe your machine doesn't have recent enough NVidia graphics card + drivers), you should skip that flag.

```

mkdir -p /path/to/demo

cd /path/to/demo

curl -OL https://github.com/Kitware/paraviewweb-demo/archive/master.zip

unzip master.zip

curl -OL https://www.paraview.org/files/v4.1/ParaViewData-v4.1.0.zip

unzip ParaViewData-v4.1.0.zip

docker run \

  --gpus all \

  -v /path/to/demo/paraviewweb-demo-master/pvw:/pvw \

  -v /path/to/demo/ParaViewData-v4.1/Data:/data \

  -p 0.0.0.0:9000:80 \

  -e SERVER_NAME="${DEMO_HOST}:${DEMO_PORT}" \

  -e PROTOCOL="ws" \

  -ti ${IMAGE_TO_RUN}

```

Then point your browser at `www.example.com:9000`.

### Running as a service

You can run the command line above as a service if you want it to be restarted automatically after reboot.  Simply include the `--restart unless-stopped` command-line argument:

```

docker run \

  --gpus all \

  -v /path/to/demo/paraviewweb-demo-master/pvw:/pvw \

  -v /path/to/demo/ParaViewData-v4.1/Data:/data \

  -p 0.0.0.0:9000:80 \

  -e SERVER_NAME="${DEMO_HOST}:${DEMO_PORT}" \

  -e PROTOCOL="ws" \

  --restart unless-stopped

  -ti ${IMAGE_TO_RUN}

```

If you want to stop the service, first look for the container ID using the `docker ps` command line.  Then you can stop it as follows:

```

docker stop ${CONTAINER_ID}

```

## More Information

For more information on how to run ParaViewWeb applications using the pre-built ParaView Docker images, see the ParaViewWeb [documentation](http://kitware.github.io/paraviewweb/docs).