Using Emscripten GLVis can be built as a JavaScript & WebAssembly library.
A fully-featured web version of GLVis is available at https://glvis.org/live with documentation in live/README.md.
A pre-built JavaScript library is included at src/glvis.js, but because of its size it is stored using Git's Large File Storage, git-lfs.
To use the pre-built library, e.g. with the examples in the examples/
directory, or with the web version
in the live/
directory, you need first to enable git-lfs
on your system, see the instructions on the
git-lfs page.
For example, a simple run with the pre-built library can be executed on a Mac from scratch with:
brew install git-lfs
git lfs install
git clone [email protected]:GLVis/glvis-js.git
cd glvis-js/examples
open basic.html
-
Install Emscripten
[git clone https://github.com/emscripten-core/emsdk.git] cd emsdk git pull ./emsdk install latest ./emsdk activate latest source "/path/to/emsdk/emsdk_env.sh"
-
Get copies of glvis and mfem
git clone [email protected]:mfem/mfem.git git clone [email protected]:GLVis/glvis.git
-
Clone included submodules
git clone --recurse-submodules [email protected]:GLVis/glvis-js.git
If you've already cloned you can pull submodules with:
git submodule update --init --recursive
-
Build:
make realclean # or just clean if you don't want to rebuild mfem make install -j
-
Patch glvis.js (temporary):
Edit src/glvis.js and add
return 0;
to the top of_JSEvents_requestFullscreen
(see Known Issues)
NOTE: Emscripten handles SDL2 and GLEW but if you have another installation in your path the link might fail.
The serve
make target allows you to serve your local glvis-js to other devices on your
network.
For example, on a Mac:
-
First, get
your IP address
:ipconfig getifaddr en0
or alternatively your
hostname
:hostname -s
-
Then, serve
glvis-js
to all devices in your local network:make serve
-
Any device in your network can now connect to
{your IP address}:8000
or{hostname}:8000
to use the local version ofglvis-js
. On the local host, you can also uselocalhost:8000
.
Please run make style
before pushing your changes. make style
uses
prettier
and requires that you have
npx
in your path. prettier
will
be installed for you when running make style
if you don't already have it.
-
Use
make install
to build and install a newglvis.js
andversions.js
to src/ -
Please add the output of
make versions
to the commit body.
-
Update the version:
npm version <update_type>
<update_type>
is one ofpatch
,minor
, ormajor
-
npm login
-
npm publish
More info here.
-
Opening new examples results in memory growth
-
Lots of console warnings
- Multiple output windows
- MFEM stream with multiple fields causes the visualizations to write over each other
- Improve the I/O e.g. corresponding to key
F6
- Improve experience on mobile devices with touch interfaces
- Allow for screenshots/printing with
S
/Ctr-P
, see GLVis/pyglvis#5 - Provide easier ways to generate
*.saved
files - Support Binary streams
- Browser differences
- Fullscreen in Safari
- Help menu overflow in Safari and Firefox
- Secure websockets