Responses

Responses#

Warning

The information regarding this page may be outdated. If you notice the following examples are not running correctly, consider reporting in the Github issue tracker pydap/pydap#issues.

Like handlers, responses are special Python modules that convert between the pydap data model and an external representation. For instance, to access a given dataset an Opendap client request two diferent representations of the dataset: a Dataset Attribute Structure (DAS) response, describing the attributes of the dataset, and a Dataset Descriptor Structure (DDS), describing its structure (shape, type, hierarchy). These responses are returned by appending the extension .das and .dds to the dataset URL, respectively.

Other common responses include the ASCII (.asc or .ascii) response, which returns an ASCII representation of the data; and an HTML form for data request using the browser, at the .html extension. And perhaps the most important response is the .dods response, which actually carries the data in binary format, and is used when clients request data from the server. All these responses are standard and come with pydap.

There are other extension responses available for pydap; these are not defined in the DAP specification, but improve the user experience by allowing data to be accessed in different formats.

Installing additional responses#

Web Map Service#

This response enables pydap to act like a Web Map Service 1.1.1 server, returning images (maps) of the available data. These maps can be visualized in any WMS client like Openlayers or Google Earth.

You can install the WMS response using pip:

pip install "pydap[responses.wms]"

This will take care of the necessary dependencies, which include Matplotlib and pydap itself. Once the response is installed you can introspect the available layers at the URL:

http://server.example.com/dataset.wms?REQUEST=GetCapabilities

The response will create valid layers from any COARDS compliant datasets, ie, grids with properly defined latitude and longitude axes. If the data is not two-dimensional it will be averaged along each axis except for the last two, so the map represents a time and/or level average of the data. Keep in mind that OPeNDAP constraint expressions apply before the map is generated, so it’s possible to create a map of a specific level (or time) by constraining the variable on the URL:

http://server.example.com/dataset.wms?var3d[0]&REQUEST=GetCapabilities

You can specify the default colormap and the DPI resolution in the server.ini file:

[app:main]
use = egg:pydap#server
root = %(here)s/data
templates = %(here)s/templates
x-wsgiorg.throw_errors = 0
pydap.responses.wms.dpi = 80
pydap.responses.wms.cmap = jet

Google Earth#

This response converts a pydap dataset to a KML representation, allowing the data to be visualized using Google Earth as a client. Simply install it with pip:

pip install "pydap[responses.kml]"

And open a URL by appending the .kml extension to the dataset, say:

http://server.example.com/dataset.kml

For now, the KML response will only return datasets that have a valid WMS representation. These datasets can be overlayed as layers on top of Google Earth, and are presented with a nice colorbar.

NetCDF#

This response allows data to be downloaded as a NetCDF file; it works better with gridded data, but sequential data will be converted into 1D variables. To install it, just type:

pip install "pydap[responses.netcdf]"

And try to append the extension .nc to a request. The data will be converted on-the-fly to a NetCDF file.

Matlab#

The Matlab response returns data in a Matlab v5 file. It is returned when the file is requested with the extension .mat, and can be installed by with:

pip install "pydap[responses.matlab]"

Excel spreadsheet#

This response returns sequential data as an Excel spreadsheet when .xls is appended to the URL. Install with:

pip install "pydap[responses.xls]"
Contents