Difference between revisions of "Documentation"

From OPeNDAP Documentation
m (User Guides)
 
(57 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
This site contains the (new) repository for OPeNDAP software documentation.
 
This site contains the (new) repository for OPeNDAP software documentation.
  
 +
=User Guides=
  
=Projects=
+
===[https://opendap.github.io/documentation/QuickStart.html Getting Started with OPeNDAP Software]===
  
===[[Hyrax]]===
+
An overview of our software
The OPeNDAP 4 Data Server, Hyrax, is the latest data server from OPeNDAP.
 
  
===[[libdap]]===
+
===[https://opendap.github.io/documentation/UserGuideComprehensive.html The User's Guide]===
  
Libdap is the C++ implementation of the OPeNDAP Data Access Protocol.
+
A comprehensive guide to sharing data with our software
  
 +
===[[Server Side Processing Functions]]===
  
 +
A listing of functions that Hyrax provides along with their documentation.
  
----
+
===[[How-To Guides]]===
----
 
  
=Wiki Maintenance=
+
This page holds a collection of Jupyter notebooks, Videos, et cetera. These have been developed by us and by other groups.
  
===Wiki Testing===
+
=Software=
  
These pages are here because we are trying out various ways to translate our existing documentation into the MediaWiki syntax. The content is old, and the translation incomplete. Caveat Emptor.
+
===[https://opendap.github.io/hyrax_guide/Master_Hyrax_Guide.html Hyrax - Installation and Customization (BES, OLFS, format & response handlers)]===
  
* [[Writing a client in C++ using libdap]]
+
The OPeNDAP Data Server, Hyrax, is a data server developed by OPeNDAP that supports DAP2, DAP4 and other Web APIs for data access. These pages contain documentation that covers server installation and customization. The old [[Hyrax | MediaWiki documentation pages]] are still available, but are not being maintained.
* [[second try: Writing a Client in C++ Using lidap]]
 
* [[Writing a client]]
 
* [[QuickStart]]
 
----
 
  
===[[Retired|Retired Pages]]===
+
===[[libdap|libdap++: C++ DAP Implementation Documentation]]===
 +
 
 +
Libdap is the C++ implementation of the OPeNDAP Data Access Protocol. This pages contains links to the libdap++ reference guide and a usage guide that explains some of the ins and outs of this class library.
 +
 
 +
===[http://www.opendap.org/api/javaDocs/index.html Java OPeNDAP API Documentation]===
 +
 
 +
The Java OPeNDAP API; this is used by TDS, Netcdf-Java and lots of other software.
 +
 
 +
===[https://opendap.github.io/bes/html/ BES Implementation Documentation]===
 +
 
 +
The BES (OPeNDAP Back-End Server) is a part of the OPeNDAP 4 Server, known as Hyrax. These pages contain the BES reference guide.
 +
 
 +
===[[Aggregation_enhancements|Aggregation Service]]===
 +
 
 +
The Aggregation Service provides a way for users to apply constraints to a number of files and returns the result in a single archive file.
 +
 
 +
=White Papers=
 +
 
 +
===[[Making the transition to DAP4]]===
 +
 
 +
8/27/14
 +
 
 +
This is a short How-To that covers modifying existing modules (aka 'handlers') for the BES so that they will return DAP4 Data and Metadata responses. In this how-to, we cover modifications for modules that read data as well as ones that transform the DAP responses into other things, such as taking a binary data object and transforming it into a netCDF file or a CSV ASCII response.
 +
 
 +
===[[Configuration of BES Modules]]===
 +
11/20/14
 +
 
 +
This is a short How-To for BES modules so that they can be built using autotools as both standalone code and as part of a unified bes build.
 +
 
 +
===[[A One-day Course on Hyrax Development]]===
 +
 
 +
2/11/2013
 +
 
 +
This one day course on Hyrax development focuses on building and debugging the Back End Server (BES) component of Hyrax, with a particular emphasis on writing server side functions. Included is a SUSE linux virtual machine that contains a complete copy of Hyrax, ready to run, along with some sample data and Eclipse. The course is a mixture of PowerPoint slide sets, hands-on work and MediaWiki pages.
 +
 
 +
===[[Writing a Client]]===
 +
 
 +
A short tutorial on how to write a client. Still under development.
 +
 
 +
===[[Writing a Module for Hyrax]]===
 +
 
 +
A short tutorial on how to write a module for Hyrax. This is one of many such 'short tutorials on ...'. Another, much older, one can be found at [[Wiki_Testing/WritingAServer|Writing A Server]]. It covers the older server design, but many of the concepts are still valid.
 +
 
 +
===[[Using Virtual Machines to Serve Data]]===
 +
 
 +
This short guide discusses using a virtual machine and a [http://en.wikipedia.org/wiki/Hypervisor hypervisor] ([http://www.vmware.com/ VMware] Server) to serve data. In the guide we cover both serving data with Hyrax running within a VM and also using Hyrax in a workshop where the hypervisor is VMware Workstation. You cannot actually serve data to remote users with Workstation, but it's a great environment in which to learn about the server's different capabilities. In both cases the advantages of using a VM are that the server runs in Linux on the virtual machine while you run the hypervisor under any of its supported operating systems. An additional advantage is that the hypervisor can be used very effectively in the context of an overall security plan.
 +
 
 +
===[[ServerDispatchOperations|Server Dispatch Operations]]===
 +
 
 +
===Building OPeNDAP Software ===
 +
 
 +
We have several pages that describe how to set up an OS/X or CentOS machine to build our code, particularly Hyrax, which can be tricky to build. See the [[Developer Info]] page for more information.
 +
<!--
 +
How to build our code on OS X. Really, the short answer "./configure; make; make install" is only technically true. To work with the code as a developer you will need to update parts of teh stock OS X development environment. This describes how to do that and avoid some common pitfalls.
 +
*[[Libdap On Leopard|Building OPeNDAP Software on OS X 10.5 Leopard]]
 +
*[[Libdap On Lion|Building OPeNDAP Software on OS X 10.7 Lion]]
 +
 
 +
===[[ Hyrax-1.6.2 Packages for OS-X| Building Hyrax-1.6.2 Package Installer(s) for OS-X 10.5 (Leopard)]]===
 +
 
 +
This describes how to take our '''shrew''' project and build an OS/X package that enables users to install Hyrax with a single click. The resulting server can be easily uninstalled as well. Included with the server is a set of dependencies, so all a person needs is an OS/X 10.5 or greater machine and this package. -->
 +
 
 +
=Housekeeping=
 +
 
 +
====[[Wiki Testing]]====
 +
 
 +
====[[Retired|Retired Pages]]====

Latest revision as of 17:25, 4 December 2020

This site contains the (new) repository for OPeNDAP software documentation.

1 User Guides

1.1 Getting Started with OPeNDAP Software

An overview of our software

1.2 The User's Guide

A comprehensive guide to sharing data with our software

1.3 Server Side Processing Functions

A listing of functions that Hyrax provides along with their documentation.

1.4 How-To Guides

This page holds a collection of Jupyter notebooks, Videos, et cetera. These have been developed by us and by other groups.

2 Software

2.1 Hyrax - Installation and Customization (BES, OLFS, format & response handlers)

The OPeNDAP Data Server, Hyrax, is a data server developed by OPeNDAP that supports DAP2, DAP4 and other Web APIs for data access. These pages contain documentation that covers server installation and customization. The old MediaWiki documentation pages are still available, but are not being maintained.

2.2 libdap++: C++ DAP Implementation Documentation

Libdap is the C++ implementation of the OPeNDAP Data Access Protocol. This pages contains links to the libdap++ reference guide and a usage guide that explains some of the ins and outs of this class library.

2.3 Java OPeNDAP API Documentation

The Java OPeNDAP API; this is used by TDS, Netcdf-Java and lots of other software.

2.4 BES Implementation Documentation

The BES (OPeNDAP Back-End Server) is a part of the OPeNDAP 4 Server, known as Hyrax. These pages contain the BES reference guide.

2.5 Aggregation Service

The Aggregation Service provides a way for users to apply constraints to a number of files and returns the result in a single archive file.

3 White Papers

3.1 Making the transition to DAP4

8/27/14

This is a short How-To that covers modifying existing modules (aka 'handlers') for the BES so that they will return DAP4 Data and Metadata responses. In this how-to, we cover modifications for modules that read data as well as ones that transform the DAP responses into other things, such as taking a binary data object and transforming it into a netCDF file or a CSV ASCII response.

3.2 Configuration of BES Modules

11/20/14

This is a short How-To for BES modules so that they can be built using autotools as both standalone code and as part of a unified bes build.

3.3 A One-day Course on Hyrax Development

2/11/2013

This one day course on Hyrax development focuses on building and debugging the Back End Server (BES) component of Hyrax, with a particular emphasis on writing server side functions. Included is a SUSE linux virtual machine that contains a complete copy of Hyrax, ready to run, along with some sample data and Eclipse. The course is a mixture of PowerPoint slide sets, hands-on work and MediaWiki pages.

3.4 Writing a Client

A short tutorial on how to write a client. Still under development.

3.5 Writing a Module for Hyrax

A short tutorial on how to write a module for Hyrax. This is one of many such 'short tutorials on ...'. Another, much older, one can be found at Writing A Server. It covers the older server design, but many of the concepts are still valid.

3.6 Using Virtual Machines to Serve Data

This short guide discusses using a virtual machine and a hypervisor (VMware Server) to serve data. In the guide we cover both serving data with Hyrax running within a VM and also using Hyrax in a workshop where the hypervisor is VMware Workstation. You cannot actually serve data to remote users with Workstation, but it's a great environment in which to learn about the server's different capabilities. In both cases the advantages of using a VM are that the server runs in Linux on the virtual machine while you run the hypervisor under any of its supported operating systems. An additional advantage is that the hypervisor can be used very effectively in the context of an overall security plan.

3.7 Server Dispatch Operations

3.8 Building OPeNDAP Software

We have several pages that describe how to set up an OS/X or CentOS machine to build our code, particularly Hyrax, which can be tricky to build. See the Developer Info page for more information.

4 Housekeeping

4.1 Wiki Testing

4.2 Retired Pages