README.md 1.75 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
Purpose of this code:
	The NOMADVR application can be used to visualize in virtual reality
	different materials science datasets provided by NOMAD or final users.
	Multiple platforms are supported by this code.
	
Context:
	NOMADVR is provided in the context of the NOMAD Center of Excellence.
	Datasets from the Encyclopedia and Archive are supported by NOMADVR.

Requirements:
	-Supported virtual reality hardware: HTC Vive or Oculus Rift, GearVR,
12 13
		Google Cardboard for Android or IOS, or the LRZ CAVE 
		environment.
14 15 16 17

Usage Instructions:
	See https://www.nomad-coe.eu/the-project/graphics/VR-prototype
		
18
Subdirectories:
19 20
	OpenVR: Demos for HTC Vive.
	OculusMobile: Demos for GearVR.
21
	GoogleCardboardAndroid: Demos for Google Cardboard (android)
22 23 24
	GoogleCardboardIOS: Demo for Google Cardboard (IOS)
	GoogleCardboard: Common files between Google Cardboard for Android
		and for IOS
25
	CAVE: Demos for LRZ CAVE-like environment (linux)
26 27 28

	NOMADGearVRChooser: Android app to select the dataset for GearVR, which
		calls the OculusMobile app as a subroutine.
29
	
30
	NOMADVRLib: Shared code between HTC Vive, GearVR and Google Cardboard demos related to NOMAD.
31
	libs: Other (external) supporting libs shared by HTC Vive, GearVR, Cardboard and CAVE demos
32 33 34 35
		happyhttp (Zlib license)
		LodePNG (Zlib license)
		rapidjson (MIT license)
		rply (BSD 3-clause license)
36
	
37 38 39 40
	webserver: 
		htdocs: Web pages containing the VR software and documentation.
		cgi-bin: cgi scripts to create suitable config files from a material number.
	
41 42 43 44
	RemoteVisualization: NOMAD2xyz app 
		Transforms a json from encyclopedia or archive into an XYZ file	
		Useful for the remote visualization infrastructure
	
45 46
More platforms will be added in the future.

47 48
The code is distributed under the Apache 2.0 License (See LICENSE file).