SOS Explorer Set-up Guide 1.4


SOS Explorer 1.4

Setup Guide

November 2017


Part 1) Wiring Diagram

Part 2) Screen Resolution Settings and Multiple Monitors

Part 3) Installing the SOS Explorer Software

Part 4) Registering the SOS Explorer Software

Part 5) Running the SOS Explorer Software

Part 6) Selecting Datasets to be Shown in SOS Explorer

Part 7) Modifying the SOS Explorer (SOSx) configuration

Part 8) Dataset Downloads

Part 9) Virtual Reality Support

Part 10) Contacting Support

Part 1) Wiring Diagram

Part 2) Screen Resolution Settings and Multiple Monitors

Before running SOS Explorer, the computer should be configured with the proper display configuration. The application expects two monitors to be attached. The main or primary screen should be the touch screen and the secondary screen should be the larger TV. To access the display settings right click on the desktop and choose “Display settings” as shown in the image below.



This will open the following dialog window where you should try to match the settings shown below. In two monitor mode both monitors should be displayed with the main (primary) touchscreen appears below the larger secondary TV. Further all displays should be set to 100% sizing and the extended desktop mode enabled. In single monitor mode there will be only one display shown. If using a set of virtual reality glasses they will not appear in this dialog.



Access “Advanced display settings” found at the bottom of the dialog window check to make sure that all the attached displays are running at the same screen ratio. Typical resolutions include 1920x1080 (1080P) or 3840x2160 (4K or 2160P).




Finally, it may be necessary to change the refresh rate on the TV. To do this right click on the desktop and select “NVIDIA Control Panel” as shown below.




Select “Change resolution” from the left panel in the dialog window and then verify that the refresh rate is set at 60Hz for all the available displays. See the image below for more instructions.




For Dual Display (2K / 4K Monitors) setups: you will want to run the SOSx Config utility and edit the UI Scale Factors for displays 1 and 2. The recommended settings are 1.65 for dual 2K monitors and 1.65 and 3.0 for 2K / 4K setups.



Part 3) Installing the SOS Explorer (SOSx) Software

Before installing the software, the computer needs to be configured with all the hardware attached the correct screen configuration. For example, if you’re using a touch screen and a 4k television, make sure the proper resolutions are set for each display. See the Setup Guide for instructions on this. You will also need to be connected to the internet for the final steps of the installation.  If you’ve previously installed SOSx, run the upgrade application provided separately called SOSx_upgrade.  These instructions do not apply.


Step-by-step Instructions:

  1. Plug the hard disk into one of the USB3 ports (they’re blue), if you’re installing multiple copies of SOSx, you can use the same hard disk.

  2. If it doesn’t automatically pop up (this behavior depends on configuration settings of your computer), open your file browser and look for the drive named SOSx_Install

  3. Double-click the SOSx-setup.exe file to launch the installation

  4. A license agreement will pop up. Read through and click “I accept the agreement” and then press Next




  1. Then you will be asked to select the destination location. Typically, just accept the default location by pressing Next

    1. If you’ve previously installed SOSx, instead run SOSx_upgrade.  These instructions do not apply.





  1. Next it will give you a prompt asking where to install the Dataset Directory. If you have just one drive, accept the default C:\local-datasets directory. If you have a secondary drive for storage, switch to that location using the browse button. Please note that the datasets should not be installed directly in the root directory. Then press Next





  1. In the Select Start Menu Folder prompt that comes up next, accept the suggested Shortcut by pressing Next




  1. Next you will be asked to Select Additional Tasks. By default “Create a desktop icon” will be checked. The other options for you to select are:

    1. Schedule syncing of datasets Tuesday at 9:00AM

    2. Automatically start on login

      1. This is useful for systems that are set up as a kiosk

    3. Deactivate Windows swipe gestures (Windows 8.1 or 10)

      1. This prevents visitors from easily exiting the application in an exhibit setting

    4. Deactivate screensaver and power savings

      1. Select this if you don’t want a screensaver coming on when there is no user interaction.





  1. After selecting the above options press Next and a prompt will appear where you can click Install





  1. At this point, the install software will download all the SOSx content onto your system. This step will take several hours the first time.

  2. If there are missing software packages, you will be prompted to download these. Agree to all of them in order for the software to run properly. These are video codecs and Windows drivers.

  3. Next you’ll see a prompt about completing the setup. You are given the options to view this instruction manual or check for new data. Once you have selected what you want, click Finish.

    1. If you selected to view the documentation or check for new data, you will see windows for those pop up.

    2. If you selected modify or review configuration the SOSx Configurator will appear.





  1. Double click on the SOS Explorer icon on the Desktop (if you kept that default) or in the Start menu folder that was created. This will initiate the registration process.

  2. You will need to enter the requested information and then click Send Profile. This sends an email to the SOSx team to confirm your registration. An email will be sent to the provided email address once this has been confirmed with directions on what to do next.



Part 4) Registering the SOS Explorer (SOSx) Software

The first time SOSx Explorer is launched it will need to be registered in order to receive a license. If you have purchased multiple copies, it’s not a problem to use the same information for each. You will see a screen that looks like the following:





Name

The name of the person who is responsible for administering the installation.

Email

The email address for the person who is responsible for administering the installation.  If other user accounts on the same machine need to run SOS Explorer those users will need to know this email address.

Organization

The name of the organization in charge of the SOS Explorer installation.

Phone

A contact phone number.

City

The city where the SOS Explorer installation is located.

State

The state where the SOS Explorer installation is located.

Country

The country where the SOS Explorer installation is located.



After filling in the information click on “Send Profile.” You will need to be connected to the Internet for this step. If the submission is successful you will see a screen similar to this:




You will receive an email at the address provided from sos.explorer@noaa.gov

Part 5) Running the SOS Explorer (SOSx) Software

If you accept all the default names and file locations during the installation process, there will be a SOS Explorer icon on your Desktop that you can use to launch the application. In the Start menu, there will be a SOS Explorer folder that contains:

  • Launcher for SOS Explorer

  • Launcher for the Tour Builder

  • Launcher for the SOS Configurator

  • Sync Datasets which updates all datasets

  • Shortcut to the local datasets folder

  • License file

  • Setup guide (this document)

  • Uninstall application


How to start SOS Explorer

Click the icon to start SOSx. You will find the icon in the SOS Explorer folder in the start menu and on the Desktop.



To exit SOS Explorer: Press Alt-F4 on a keyboard

SOS Explorer is difficult to quit when it’s set up as an exhibit because it is designed to operate in an unattended exhibit environment where you would not what visitors gaining access to the desktop or operating system. In a classroom setting, the software can be modified through the config file (see Part 7) to include an exit button if you prefer. In the exhibit setting, you should leave the keyboard and mouse hidden during normal operation. If you need access to the Desktop or Windows environment you should retrieve the keyboard and mouse and press Alt-F4.


Part 6) Selecting Datasets to be Shown in SOS Explorer

There are over 140 datasets loaded onto your exhibit, including real-time datasets that will automatically update every hour. However, if you would prefer to restrict to a particular theme, for example, if your museum is an aquarium and you want only Water and People datasets to appear in the SOSx Search Window, then it’s possible to use our website to select the datasets that you want. You will still be able to access all the datasets from TourBuilder but they will not show up in the SOSx Search Window. Please Note: If you are an SOS user and you wish to make an SOSx Presentation Playlist, you will want to use the TourBuilder application.


Case 1: You want to restrict by category or narrated/non-narrated:

  1. NOTE: You will receive new datasets in the categories that you choose to include automatically.

  2. Open local-datasets directory to find a number of small text files including tag_selection_bak.json. Open it.

  3. This is the text you will find  - an example where only narrated movies would show up in the search window:

{

"inclusive": true,

"tags": {

"Movies": {}

}

}

  1. How to edit: Inclusive can either be set to true or false depending on whether you would like to include or exclude categories (tags), respectively.

For example: If you would like to exclude space datasets and narrated movies, you would edit it to look like this:

{

   "inclusive": false,

   "tags": {

   "Movies": {},

   "Space": {}

   }

}

  1. When you’re finished editing the file, save it and rename it to: tag_selection.json and relaunch SOSx.


Dataset categories on your exhibit are:

Air, Extras, Land, Movies, People, Real-time, Snow and Ice, Space, Tour, Water

Datasets may be in multiple categories.


Case 2: You want to hand select specific datasets. Use our website:

  1. NOTE: You will not receive new datasets automatically using this method. Also, at this point, all NOAA tours show up and cannot be removed from your search.

  2. Go to sos.noaa.gov and select the Datasets tab.

  3. Under Refine by, check the SOSx box. The list of datasets on the left will reflect this.


  1. Click to open a dataset to read the description.

  2. While on the selected dataset page, in the upper left side of the screen, you’ll see the Builder.  


  3. Choose your datasets, one at a time, by clicking the +  They will appear in the list. To view your list, click the button on the right of the + sign. They will appear alphabetically in SOSx Search Screen, therefore there is no need to reorder them.

  4. Once you have selected all of the datasets that you want to appear in your SOSx exhibit, select SOSx from the toggle at the top of your list. Datasets that appear red are not available in SOSx. Download. The list will automatically be named  dataset_selection.json.



  1. Place this file in your local-datasets directory on your SOSx computer.

  2. Please note: Variation Datasets, i.e. Spanish language, with audio, with labels, etc., (10 of these currently exist in the list on the website) are not available for your system but appear to be in SOSx on the website. These cannot actually be selected.

Part 7) Modifying the SOS Explorer (SOSx) configuration

SOS Explorer has many options for customizing your exhibit, from the number of displays, to the timing of data syncs, to whether or not you want to show an exit button (for use in classrooms, for example). In order to change the configuration of your exhibit, we have created a “Configurator” program, which edits a file called “config.json” for SOS Explorer.

When you first launch SOSx, it will automatically open. Any other time, open the SOSx Configurator program (Configurator.exe), located in the same folder as SOSx, to change the primary settings for SOSx.




With Configurator, you can choose which “Hot Buttons” appear on the lower left corner of SOSx, choose basemap / clouds options, link a kiosk tour (a tour that automatically plays after no one has touched the screen for a specified time: “Kiosk Timeout Sec”), various UI Features (for example, 2D/3D button on the lower right of the screen can be hidden), and various display options (for example, enabling a second display monitor or an optional VR Oculus Rift).


If you choose all the default options during the installation, you will find the configuration file at: C:\Program Files\SOS Explorer\SOSx_Data\config\config.json


See table below for additional information and settings you may want to edit.  A few of these settings can only be changed by directly editing the “config.json” file.


Part 8) Dataset Downloads

New datasets are continually being added to SOSx and real-time datasets are being updated regularly. Defaults have been set for automatic data downloads, but you have the ability to change them to meet your site’s needs. All dataset downloads require the computer to have an internet connection.


If you want to manually update the datasets, you can do this by selecting Sync Datasets in the SOS Explorer folder found in the Windows start menu under All Programs.


Real-time Datasets

Most real-time datasets show new imagery either hourly or daily so that you can display current events. They are synced every time the software is idle. The time it takes for the software to be considered idle is defined by kioskTimeoutSec in the config file, which by default is set to 7 minutes. Once idle, the real-time datasets are synced by default every 30 minutes, as defined by the refreshLocalDatasetsSec option in the config file.   Other real-time datasets (such as real-time earthquakes) attempt to download the latest data each time the dataset is loaded and require an Internet connection.


Non real-time Datasets

If the "Schedule syncing of datasets Tuesday at 9:00AM" checkbox was left checked during the setup process all other datasets are updated every Tuesday at 9:00am through the Windows task scheduler. When the data download is happening, it’s possible that you will see a decline in performance for the SOSx software. If you plan on leaving the computer on all the time, you can set this download to occur in the middle of the night to avoid potential performance issues.


If your computer happens to be off at 9:00am on Tuesday, you can use the manual sync described above to get any new datasets that you are missing.


The scheduled task can be modified by starting the “Task Scheduler” found in the Start Menu.





Double clicking on the “SOSx Full Dataset Sync” task pulls up the properties.





Click on “Properties” in the Actions bar on the right to edit the task.





The “Triggers” tab will let you change the time and frequency of the scheduled full dataset sync.



Part 9) Virtual Reality Support

Starting in version 1.4 SOS Explorer (SOSx) offers full support for virtual reality (VR). This feature requires the following additional hardware:



Follow the setup instructions included in both products and ensure the hardware is operational. Next run the Configurator program, check the “Use VR” box to enable VR, and click the Save button to save configuration options. At this time HTC Vive is not supported.  


When you run SOSx with VR enabled on a system where Rift has been installed, you have the option of putting on the Rift headset to experience SOSx. With the Rift on, you will see the Earth in the distance and you will also see a virtual version of your hand. If you extend your index finger, you can touch buttons to activate them. When first starting SOSx, you will see two buttons in the main panel floating in front of the Earth: a Search button and a Navigate button.



Tip: The best way to press a button is to slowly move your index finger into it and then pull the finger directly away after you hear the beep.


If you press the Search button, the Search Window appears with categories of datasets for you to choose among.





If you touch the Air button, for example, you’ll see datasets in that category:




You can touch a dataset button to open that dataset. Note that you will see the dataset in your Rift and any user at the touch screen will also see the dataset load. If you load a dataset that can be animated (e.g., a dataset with multiple images, one for each time) then you’ll see a legend off on the left and below the main panel, you’ll see the Animation window. Press the buttons to pause, rewind, advance frames, etc.




If you press the Navigation button with your finger, the Navigation window appears. Use this window to rotate the globe and zoom in/out.




If you load a tour with 360 degree content (bubbles) like the Florida Keys National Marine Sanctuary Tour, you’ll see a VR window that enables you to choose which 360 degree “bubble” to fly into.





If you press the “Christ of the Abyss” button with your finger, for example, you will fly into that 360 degree bubble and can look around. Once inside the bubble, you can exit back out by touching the “Exit 360 Bubble” button.



Part 10) Contacting Support

If you run into any problems or have any questions, you can contact the SOSx team by emailing sos.explorer@noaa.gov. During regular business hours (we’re in the Mountain time zone), you should receive same day responses.