Difference between revisions of "BES - Modules - FileOut Netcdf"

From OPeNDAP Documentation
(How to use the module)
m (Status)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
The File Out NetCDF module provides the ability to return OPeNDAP DataDDS objects as netcdf files. The module takes an OPeNDAP DataDDS and translates the attrriburtes, data structure, and data into a netcdf file and streams the resulting file back to the caller.
+
The File Out NetCDF module provides the ability to return OPeNDAP DataDDS objects as netcdf files. The module takes an OPeNDAP DataDDS and translates the attributes, data structure, and data into a netcdf file and streams the resulting file back to the caller. Currently, simple types, arrays, structures and grids are supported. Sequences are not yet supported.
 +
<br><br>
 +
Go to [[BES_File_Out_NetCDF|this page]] for more information on the specifics of how OPeNDAP data objects are written to NetCDF.
 +
 
 +
==Status==
 +
Stable release 1.3.2 with Hyrax 1.12
 +
 
 +
==Services Handled==
 +
This module does not handle any services but adds to an existing service
 +
 
 +
==Services Provided==
 +
The module provides an additional format to the <code>dap</code> service's <code>dods</code> command. The format is used to specify a "returnAs" format. Typically you will see responses of the dap2 format. This module provides the additional format of returning the OPenDAP data object as a netcdf file.
  
 
==Download==
 
==Download==
The latest release of this module is fileout_netcdf 0.9.0 and can be downloaded off of the [http://opendap.org/download/fileout_netcdf.html File Out NetCDF opendap web page]
+
The latest version of this handler is included in the BES RPM distribution as of Hyrax 1.12, which you can download from the [http://opendap.org/download/hyrax Hyrax download page]. You can get the source code for this module from the [https://github.com/OPENDAP/bes BES] or [https://github.com/OPENDAP/fileout_netcdf fileout_netcdf] projects from guthub. The BES project can be used to all of the source we use when building the bES for inclusion in the Hyrax releases; the fileout_netcdf project can be used to get just the source code for the module.
  
 
==How to use the module==
 
==How to use the module==
Once installed, the module is used by adding it to the list of modules to load by the BES. To do this you can simply run the bes-fonc-data.sh shell script that is included with the installation. This will update your BES configuration file in the appropriate places. There is a configuration option that you can change for this module. The <code>FONc.Tempdir</code> parameter in the BES configuration file tells the module where to store the netcdf files generated by the module until the file is streamed back to the caller. The default value for this parameter is the /tmp directory. You could change this to a location where there is plenty of disk space/quota.
+
Once installed, the fonc.conf file is installed in the BES etc/bes/modules directory and is automatically loaded by the BES at startup. There is a configuration option that you can change for this module. The <code>FONc.Tempdir</code> parameter in the fonc.conf configuration file tells the module where to store the netcdf files generated by the module until the file is streamed back to the caller. The default value for this parameter is the /tmp directory. You should change this to a location where there is plenty of disk space/quota that is owned by the user set to run the BES.
 +
 
 +
FONc.Tempdir=/tmp
 +
 
 +
Other BES keys that can be used to control the handler's behavior:
 +
 
 +
FONc.UseCompression=true
 +
 
 +
Use compression when making netCDF4 files; true by default
 +
 
 +
FONc.ChunkSize=4096
 +
 
 +
The default chunk size when making netCDF4 files, in KBytes (4k by default)
 +
 
 +
FONc.ClassicModel=true
 +
 
 +
When making a netCDF4 file, use only the 'classic' netCDF data model; true by default.
  
 
The next time the BES is started it will load this module. And, once installed, the OLFS will know that it can use this module to transform your data. Next to a dataset you will see the list of data products provided for that dataset. This will include a link for File Out Netcdf.
 
The next time the BES is started it will load this module. And, once installed, the OLFS will know that it can use this module to transform your data. Next to a dataset you will see the list of data products provided for that dataset. This will include a link for File Out Netcdf.
Line 16: Line 43:
 
<request reqID="some_unique_value" >
 
<request reqID="some_unique_value" >
 
     <setContext name="dap_format">dap2</setContext>
 
     <setContext name="dap_format">dap2</setContext>
     <setContainer name="c" space="catalog">/data/nc/200803061600_HFRadar_USEGC_6km_rtv_SIO.nc</setContainer>
+
     <setContainer name="c" space="catalog">data/nc/fnoc1.nc</setContainer>
 
     <define name="d">
 
     <define name="d">
<container name="c">
+
<container name="c" />
    <constraint>geogrid(u,31.3463,86.4582,15.76,125.7882)</constraint>
 
</container>
 
 
     </define>
 
     </define>
 
     <get type="dods" definition="d" returnAs="netcdf"/>
 
     <get type="dods" definition="d" returnAs="netcdf"/>
 
</request>
 
</request>
 
</pre>
 
</pre>
 +
 +
[[Category:BES Modules|FileOut Netcdf]]

Latest revision as of 17:18, 8 December 2015

1 Description

The File Out NetCDF module provides the ability to return OPeNDAP DataDDS objects as netcdf files. The module takes an OPeNDAP DataDDS and translates the attributes, data structure, and data into a netcdf file and streams the resulting file back to the caller. Currently, simple types, arrays, structures and grids are supported. Sequences are not yet supported.

Go to this page for more information on the specifics of how OPeNDAP data objects are written to NetCDF.

2 Status

Stable release 1.3.2 with Hyrax 1.12

3 Services Handled

This module does not handle any services but adds to an existing service

4 Services Provided

The module provides an additional format to the dap service's dods command. The format is used to specify a "returnAs" format. Typically you will see responses of the dap2 format. This module provides the additional format of returning the OPenDAP data object as a netcdf file.

5 Download

The latest version of this handler is included in the BES RPM distribution as of Hyrax 1.12, which you can download from the Hyrax download page. You can get the source code for this module from the BES or fileout_netcdf projects from guthub. The BES project can be used to all of the source we use when building the bES for inclusion in the Hyrax releases; the fileout_netcdf project can be used to get just the source code for the module.

6 How to use the module

Once installed, the fonc.conf file is installed in the BES etc/bes/modules directory and is automatically loaded by the BES at startup. There is a configuration option that you can change for this module. The FONc.Tempdir parameter in the fonc.conf configuration file tells the module where to store the netcdf files generated by the module until the file is streamed back to the caller. The default value for this parameter is the /tmp directory. You should change this to a location where there is plenty of disk space/quota that is owned by the user set to run the BES.

FONc.Tempdir=/tmp

Other BES keys that can be used to control the handler's behavior:

FONc.UseCompression=true

Use compression when making netCDF4 files; true by default

FONc.ChunkSize=4096

The default chunk size when making netCDF4 files, in KBytes (4k by default)

FONc.ClassicModel=true

When making a netCDF4 file, use only the 'classic' netCDF data model; true by default.

The next time the BES is started it will load this module. And, once installed, the OLFS will know that it can use this module to transform your data. Next to a dataset you will see the list of data products provided for that dataset. This will include a link for File Out Netcdf.

If not using the OLFS to serve your data, for example if using the bescmdln, you would run a command file that would look something like this:

<?xml version="1.0" encoding="UTF-8"?>
<request reqID="some_unique_value" >
    <setContext name="dap_format">dap2</setContext>
    <setContainer name="c" space="catalog">data/nc/fnoc1.nc</setContainer>
    <define name="d">
	<container name="c" />
    </define>
    <get type="dods" definition="d" returnAs="netcdf"/>
</request>