Previous: Miscellaneous Next: IDV Scripting Table of contents Images Frames Unidata's Integrated Data Viewer > Miscellaneous

7.0 Bundles
Bundles let you save a quick "snapshot" of the IDV, including data sources, maps, data displays. Bundles are small information files that specify the state of the IDV. They are a kind of configuration file. They include information about what data sources are in use, and which parameters from the data sources are displayed, and how they are displayed.

The purpose of bundles is for you to save a particular IDV setup and display. A bundle can be used for your own reference at a later time. Others using the IDV can use bundles you made to see data the same way you did.

To make a new bundle file select the File->Save As menu. A pop-up window will let you set a new file location and name:

Bundle File Dialog
Image 1: Bundle File Dialog
The customary IDV bundle filename extension is .xidv; if you do not enter a file extension, .xidv will be appended. You may use any other file extension you like.

Note: For bundle files to work the data must be available in exactly the same way you made connection to it when you made the bundle file. Others who use your bundles must have access to the same file system or to the same remote or local data servers you use, so that file paths or URLs to the data are exactly the same.

The file dialog has a set of buttons on the right that allow you to save off (or not save off) different components of the IDV state.

7.0.0 Opening a Bundle
Use the File->Open menu to open a bundle. When loading in a new bundle you will be prompted whether the current displays and data should be removed. You can also start up the IDV with a bundle file or URL in the command line.
7.0.1 JNLP Bundles
You can also save a bundle inside a "jnlp file" that can be used to start the IDV with the bundle. Use a filename extension of ".jnlp" in place of .xidv. This file, when used as a link on a regular web page, allows IDV users to start the IDV with Web Start on their system with your bundle. Click on the link to your jnlp file. The IDV will start with the bundle you saved in the .jnlp file.
7.0.2 The Default Bundle
Select the File->Default Bundle->Save menu to create a bundle that is read whenever you start the IDV. This will provide a standard starting configuration. You can set up the geographic area, map projection, and maps you prefer, for example.
7.0.3 Favorite Bundles
Favorite bundles are just normal bundles that are categorized and saved off in a particular location on disk and serve as a convenience to the user. This allows the user to organize their favorites by category and readily load them in.

Favorite bundles come in 3 forms: as regular bundles, as display templates and as favorite data sources. Each of these types of favorites can be accessed through the Displays menu as well as through the Dashboard.

A regular favorite bundle can be created through the File->Save As Favorite... Displays->Favorite Bundles->Save As Favorite... menus. The "Save As Favorite" dialog is shown:

Save As Favorite Dialog
Image 2: Save As Favorite Dialog
A favorite bundle has a category which can be entered in the Category field. Categories can be hierarchical, using a ">" as separator. For example: "Toolbar>Weather" The "Toolbar" category is special. These will result in links in the toolbar. After specifying a category specify a Name for the favorite bundle.

The Display Templates favorites are created through the File->Save Display as Favorite menu. This allows you to create a display as you like (e.g., a Contour Plan View at a certain level with certain settings), save it off and recreate it later. Display Templates for displays that showed data will show up in the Displays component of the Field Selector.

Data Source favorites are created through the Data Source popup menu in the Field Selector.

Each of these types of favorites can be with the Favorites Manager:

Favorites Manager
Image 3: Favorites Manager
This is brought up through the Quicklinks in the Dashboard or through the Displays->Favorites Bundles->Manage..., Displays->Display Templates->Manage... and Displays->Data Sources->Manage... menus. The Favorites Manager allows you to reorganize the categories and favorites by drag-and-drop. You can also right click on a favorite or a category to delete it, export, etc.
7.0.4 Data in Bundles

The IDV supports a bundle format: .zidv (or zipped idv). This is a zip file that contains a regular bundle (xidv) and a set of data files. When the user does a Save As... and specifies a .zidv file extension the IDV prompts the user to select the data sources that should be written into the zip file. On opening a zidv file the IDV needs to unzip the data files so it prompts the user as to where to place the files - a tmp directory or a user selected directory (this is a preference as well).

This doesn't seem like such a big deal in and of itself but... We also have implemented a "Make Remote Data Local" facility. We can now, for most of the remote data types, move the data from the server to the local disk. We support the ADDE types: satellite, radar, point, sounding and forecast fronts. We also have support for grids on remote servers (see below).

This is used in two ways. First, the user can right click on a data source in the Field Selector and select "Make Data Local" for remote data sources. The IDV prompts for a file directory and a file prefix (we default to use the name of the data source). The remote data is then copied over. For multiple files we use: <directory><prefix><file count>.<suffix>. The data source object within the IDV is then changed to point to the new file paths.

The second way this is used is when you save off a zidv file. The user is prompted for both the local data sources to be saved off as well as for the remote data sources. For the remote ones the IDV automatically copies the files over and zips them up.

When saving gridded data the user is prompted for the fields to save and the geo-spatial subset is used to subset the grids. We do not yet support sub-setting on times and grid stride/decimation.


Previous: Miscellaneous Next: IDV Scripting Table of contents Images Frames Unidata's Integrated Data Viewer > Miscellaneous