UserGuidePreface: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
(New page: =Preface= This document describes version 3.4 of the [http://www.opendap.org/<cite>Distributed Oceanographic Data System</cite>] (OPeNDAP), a data system intended to allow researchers tr...)
 
Line 27: Line 27:


*Getting the OPeNDAP software. ([http://www.opendap.org/<cite>install</cite>])
*Getting the OPeNDAP software. ([http://www.opendap.org/<cite>install</cite>])
*Installing the OPeNDAP software. ([http://www.opendap.org/<cite>install</cite>])
*Installing the OPeNDAP software. ([http://www.opendap.org/<cite>install</cite>])
*Using an OPeNDAP client. ([http://www.opendap.org/<cite>opd-client,using-example</cite>])
*Using an OPeNDAP client. ([http://www.opendap.org/<cite>opd-client,using-example</cite>])
*Re-linking a data analysis or display application to become a
 
OPeNDAP client. ([http://www.opendap.org/<cite>opd-client,link-example</cite>])   %
*Re-linking a data analysis or display application to become a OPeNDAP client. ([http://www.opendap.org/<cite>opd-client,link-example</cite>])  
 
*Using the OPeNDAP data locator to find data.
*Using the OPeNDAP data locator to find data.
*Creating and installing an OPeNDAP server.
*Creating and installing an OPeNDAP server.


**Installing the OPeNDAP server and CGI filters.
**Installing the OPeNDAP server and CGI filters.
Line 45: Line 48:
**Implementing a new DODS-compliant API. ([http://www.opendap.org/support/docs.html/api/pguide-html/<cite>The OPeNDAP Programmer's Guide</cite>])
**Implementing a new DODS-compliant API. ([http://www.opendap.org/support/docs.html/api/pguide-html/<cite>The OPeNDAP Programmer's Guide</cite>])


*:
*Writing an OPeNDAP CGI program. ([http://www.opendap.org/support/docs.html/api/pguide-html/<cite>The OPeNDAP Programmer's Guide</cite>] )
*Writing an OPeNDAP CGI program. ([http://www.opendap.org/support/docs.html/api/pguide-html/<cite>The OPeNDAP Programmer's Guide</cite>] )
*Writing the CGI service programs. ([http://www.opendap.org/support/docs.html/api/pguide-html/<cite>The OPeNDAP Programmer's Guide</cite>] )
*Writing the CGI service programs. ([http://www.opendap.org/support/docs.html/api/pguide-html/<cite>The OPeNDAP Programmer's Guide</cite>] )
*A list of all supported APIs. ([http://www.opendap.org/<cite>opd-client,supported-APIs</cite>])
*A list of all supported APIs. ([http://www.opendap.org/<cite>opd-client,supported-APIs</cite>])


==Who is this Guide for?==
==Who is this Guide for?==

Revision as of 02:50, 25 September 2007

Preface

This document describes version 3.4 of the Distributed Oceanographic Data System (OPeNDAP), a data system intended to allow researchers transparent access to oceanographic data---stored in any of several different file formats---across the Internet. Using OPeNDAP function libraries, many existing data analysis programs can be easily modified to accommodate access of distant datasets in a manner identical to the access of local datasets. OPeNDAP includes a protocol for the transmission of data across the Internet, and supports selection of data using constraint expressions, and translation of data from one format to another.

An overview of the system's use is presented, and specific tasks illustrated, for data providers as well as for users.



Tasks Illustrated in this Guide

For a quick start to getting, installing, and using OPeNDAP software, see the list below of tasks described in this document.


  • Getting the OPeNDAP software. (install)
  • Installing the OPeNDAP software. (install)
  • Using the OPeNDAP data locator to find data.
  • Creating and installing an OPeNDAP server.
    • Installing the OPeNDAP server and CGI filters.

(opd-server,cgi-install)

    • Starting and configuring the httpd server. Due to the variety

of available servers, this task is beyond the scope of the manual. Please refer to the documentation for the particular server in question for more information.

Who is this Guide for?

The user documentation for OPeNDAP covers two groups of users: those who want to provide access to data vian OPeNDAP and those who want to use data. In many cases the people will be one and the same since most providers will also be data users.

This documentation assumes that the readers are familiar with computers, but are not necessarily programmers.

This guide also contains technical information that will be of assistance to programmers who plan to write new DODS-compliant APIs for as yet unsupported data models. Data providers and data consumers may find some general questions answered by this material, but it is not necessary to know any of it in order to use the system.


Organization of this Document

This book is organized into separate sections for data providers, data consumers, and technical reference material for programmers.

Part I is for everybody who wants to use OPeNDAP.



\chapterref{intro,opd} provides a high-level overview of

the entire system.



Part II is for data consumers, that is, the people who want

to look at data using the OPeNDAP system.



\chapterref{opd-client} shows how to look at data using

OPeNDAP. It includes a section about the theoretical and practical

problems of data model translation. It also explains how to build

an OPeNDAP client, which is the program used to look at OPeNDAP data.






Part III is for data providers, or people who want to make

their data available through OPeNDAP servers.


\chapterref{opd-server} shows how to use OPeNDAP to

make your data available to others. It explains how to set up a

OPeNDAP server to provide OPeNDAP data to OPeNDAP clients, and also

contains information about modifying or writing an OPeNDAP server.

\tbd{Put stuff about setting up a CS here. Also participating in the

grand CS.}





Part IV contains technical information about how OPeNDAP

works. This information is provided to people who want to write new

libraries to use OPeNDAP through a currently unsupported API.



\chapterref{data} contains general information about

Data and Data Models. This is important information to have for

people intending to use OPeNDAP to provide data to others. It covers

the OPeNDAP data attribute and data descriptor structures. The

chapter also contains a section outlining the problems associated

with Data Model translation.


Appendices



\appref{install} contains the instructions for installing

the OPeNDAP libraries, and software that requires these libraries.


Glossary A small but useful collection of terms.