Difference between revisions of "WCS Wrapper Configuration"

From Earth Science Information Partners (ESIP)
 
(18 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
[http://sourceforge.net/p/aq-ogc-services/home/ Project on SourceForge]
 
[http://sourceforge.net/p/aq-ogc-services/home/ Project on SourceForge]
 +
 +
This page describes how to install the information for humans: Home pages, contact information etc.
 +
 +
For data Configuration go to following pages:
  
 
* [[WCS_Wrapper_Configuration_for_Cubes| Configuring NetCDF based Cube Data]]
 
* [[WCS_Wrapper_Configuration_for_Cubes| Configuring NetCDF based Cube Data]]
Line 11: Line 15:
 
'''OWS/web''' is for system developers only.
 
'''OWS/web''' is for system developers only.
  
OWS/web/'''static''' contains static web content. You can put any documentation here and it will be served as a web page or download. The home page index.html is pretty much mandatory, and you should change favicon.ico to reflect your organization. We highly recommend, that you customize documents for your WCS service.
+
OWS/web/'''static''' contains static web content. You can put any documentation here and it will be served as a web page or download. The home page '''index.html''' is pretty much mandatory, and you should change '''favicon.ico''' to reflect your organization. We highly recommend, that you customize documents for your WCS service.
  
 
OWS/web/static/'''cache''' is a folder for temporary files. The service uses it for output files. Anything you put there will be deleted when space is needed.
 
OWS/web/static/'''cache''' is a folder for temporary files. The service uses it for output files. Anything you put there will be deleted when space is needed.
  
The installation contains an example datasets OWS/web/static/'''testprovider''' and OWS/web/static/'''point'''. The testprovider is a demo NetCDF dataset, point is an example how to server point data from a SQL database. Every service will have a folder with the same name here. So create yourself a folder datasets OWS/web/static/'''myservice''' and your service URL will be at http://localhost:8080/myservice  
+
The installation contains an example datasets OWS/web/static/'''testprovider''' and OWS/web/static/'''point'''. The testprovider is a demo NetCDF dataset, point is an example how to server point data from a SQL database. Every service will have a folder with the same name here. So create yourself a folder datasets OWS/web/static/'''myservice''' and your service URL will be at http://localhost:8080/myservice
  
== Enter Provider Metadata ==
+
== The Human Interface: Create the index.html Front Pages for Visitors. ==
  
Every provider should have wcs_capabilities.conf that lists keywords and contact information. The format is simple, copy one from the testprovider and edit it.
+
If no query is present, the server gives a default page '''index.html'''. You should create these pages for your server and for all the providers.  
  
# this file provides some information about the provider
+
The server index.html is at '''OWS/web/static/index.html''', which will be displayed from url http://128.252.202.19:8080/ at test server or at [http://localhost:8080/ localhost] if you have a server running.
# and is incorporated into the respective WCS responses.
 
# all currently available field identifiers are listed below.
 
# please define every identifier only once.
 
# other identifiers will be ignored, input is case sensitive.
 
# the format is always <identifier>: <value>.
 
# whitespaces before and after <value> will be stripped.
 
# KEYWORDS can take a comma separated list that will then be
 
# included in the respective keyword tags
 
# empty lines and lines starting with "#" will be ignored.
 
PROVIDER_TITLE: ASOS 1 minute data
 
PROVIDER_ABSTRACT: NCDC
 
KEYWORDS: Domain:Aerosol,Platform:Network,Instrument:Unknown,DataType:Point,Distributor:DataFed,Originator:NCDC,TimeRes:Minute,Vertical:Surface,TopicCategory:climatologyMeteorologyAtmosphere
 
FEES: NONE
 
CONSTRAINTS: NONE
 
PROVIDER_SITE: insert URL here
 
CONTACT_INDIVIDUAL: TBD
 
CONTACT_PHONE: undef
 
CONTACT_STREET: street
 
CONTACT_CITY: city
 
CONTACT_ADM_AREA: adm. area
 
CONTACT_POSTCODE: postcode
 
CONTACT_COUNTRY: country
 
CONTACT_EMAIL: contact email
 
  
== The Human Interface: Create the index.html Front Pages for Visitors. ==
+
Every provider folder should also have an index.html like '''OWS/web/static/testprovider/index.html''' which will be displayed from  http://128.252.202.19:8080/HTAP at test server or at [http://localhost:8080/testprovider localhost].
 +
 
 +
== Enter Provider Metadata ==
  
If no query is present, the server gives a default page '''index.html'''. You should create these pages for your server and for all the providers.  
+
Every provider should have '''wcs_capabilities.conf''' that lists keywords and contact information. The format is simple, copy one from the testprovider and edit it.
  
The server index.html is at '''OWS/web/static/index.html''', which will be displayed from url http://128.252.202.19:8080/ at test server or at [http://localhost:8080/ localhost].  
+
    # this file provides some information about the provider
 +
    # and is incorporated into the respective WCS responses.
 +
    # all currently available field identifiers are listed below.
 +
    # please define every identifier only once.
 +
    # other identifiers will be ignored, input is case sensitive.
 +
    # the format is always <identifier>: <value>.
 +
    # whitespaces before and after <value> will be stripped.
 +
    # KEYWORDS can take a comma separated list that will then be
 +
    # included in the respective keyword tags
 +
    # empty lines and lines starting with "#" will be ignored.
 +
    PROVIDER_TITLE: National Climate Data Center
 +
    PROVIDER_ABSTRACT: National Climate Data Center is the worlds largest archive of climate data.
 +
    KEYWORDS: Domain:Aerosol, Platform:Network, Instrument:Unknown, DataType:Point, Distributor:DataFed, Originator:NCDC, TimeRes:Minute, Vertical:Surface, TopicCategory:climatologyMeteorologyAtmosphere
 +
    FEES: NONE
 +
    CONSTRAINTS: NONE
 +
    PROVIDER_SITE: http://lwf.ncdc.noaa.gov/oa/ncdc.html
 +
    CONTACT_INDIVIDUAL: Climate Contact, Climate Services Branch, National Climatic Data Center
 +
    CONTACT_PHONE: 828-271-4800
 +
    CONTACT_STREET: 151 Patton Avenue Room 468
 +
    CONTACT_CITY: Asheville
 +
    CONTACT_ADM_AREA: North Carolina
 +
    CONTACT_POSTCODE: 28801-5001
 +
    CONTACT_COUNTRY: USA
 +
    CONTACT_EMAIL: ncdc.info@noaa.gov
  
Every provider folder should also have an index.html like '''OWS/web/static/testprovider/index.html''' which will be displayed from  http://128.252.202.19:8080/HTAP at test server or at [http://localhost:8080/testprovider localhost].
+
Here is the real live NCDC [http://128.252.202.19:8080/static/NCDC/wcs_capabilities.conf wcs_capabilities.conf]
  
=== Windows Implementation Bug ===
+
== Windows Implementation Issue ==
 
'''Important''' There is a bug deep in python core libraries that make serving text files a little special. The files need to be encoded with unix style line ending convention '\n', instead of windows style '\r\n'.  
 
'''Important''' There is a bug deep in python core libraries that make serving text files a little special. The files need to be encoded with unix style line ending convention '\n', instead of windows style '\r\n'.  
  

Latest revision as of 11:29, August 27, 2010

Back to WCS Wrapper

Project on SourceForge

This page describes how to install the information for humans: Home pages, contact information etc.

For data Configuration go to following pages:

Structure of OWS/web

OWS/web is for system developers only.

OWS/web/static contains static web content. You can put any documentation here and it will be served as a web page or download. The home page index.html is pretty much mandatory, and you should change favicon.ico to reflect your organization. We highly recommend, that you customize documents for your WCS service.

OWS/web/static/cache is a folder for temporary files. The service uses it for output files. Anything you put there will be deleted when space is needed.

The installation contains an example datasets OWS/web/static/testprovider and OWS/web/static/point. The testprovider is a demo NetCDF dataset, point is an example how to server point data from a SQL database. Every service will have a folder with the same name here. So create yourself a folder datasets OWS/web/static/myservice and your service URL will be at http://localhost:8080/myservice

The Human Interface: Create the index.html Front Pages for Visitors.

If no query is present, the server gives a default page index.html. You should create these pages for your server and for all the providers.

The server index.html is at OWS/web/static/index.html, which will be displayed from url http://128.252.202.19:8080/ at test server or at localhost if you have a server running.

Every provider folder should also have an index.html like OWS/web/static/testprovider/index.html which will be displayed from http://128.252.202.19:8080/HTAP at test server or at localhost.

Enter Provider Metadata

Every provider should have wcs_capabilities.conf that lists keywords and contact information. The format is simple, copy one from the testprovider and edit it.

   # this file provides some information about the provider
   # and is incorporated into the respective WCS responses.
   # all currently available field identifiers are listed below.
   # please define every identifier only once.
   # other identifiers will be ignored, input is case sensitive.
   # the format is always <identifier>: <value>.
   # whitespaces before and after <value> will be stripped.
   # KEYWORDS can take a comma separated list that will then be
   # included in the respective keyword tags
   # empty lines and lines starting with "#" will be ignored.
   PROVIDER_TITLE: National Climate Data Center
   PROVIDER_ABSTRACT: National Climate Data Center is the worlds largest archive of climate data.
   KEYWORDS: Domain:Aerosol, Platform:Network, Instrument:Unknown, DataType:Point, Distributor:DataFed, Originator:NCDC, TimeRes:Minute, Vertical:Surface, TopicCategory:climatologyMeteorologyAtmosphere
   FEES: NONE
   CONSTRAINTS: NONE
   PROVIDER_SITE: http://lwf.ncdc.noaa.gov/oa/ncdc.html
   CONTACT_INDIVIDUAL: Climate Contact, Climate Services Branch, National Climatic Data Center
   CONTACT_PHONE: 828-271-4800
   CONTACT_STREET: 151 Patton Avenue Room 468
   CONTACT_CITY: Asheville 
   CONTACT_ADM_AREA: North Carolina 
   CONTACT_POSTCODE: 28801-5001
   CONTACT_COUNTRY: USA
   CONTACT_EMAIL: ncdc.info@noaa.gov

Here is the real live NCDC wcs_capabilities.conf

Windows Implementation Issue

Important There is a bug deep in python core libraries that make serving text files a little special. The files need to be encoded with unix style line ending convention '\n', instead of windows style '\r\n'.

To fix this, issue command:

   python /OWS/web/owsadmin.py unix_nl filename.html

for every text file you serve. Binary files are unaffected.