Wiki Testing/OPeNDAPUserGuide2 - Revision history

TomSgouros: removed stuff relevant to only one of the available client libraries

2009-09-22T19:11:47Z

removed stuff relevant to only one of the available client libraries

← Older revision		Revision as of 19:11, 22 September 2009
Line 232:		Line 232:
	WWW Interface		WWW Interface
	</center>		</center>

	~~==Using an OPeNDAP Program==~~

	~~There are some configuration issues a user must consider in order to use an OPeNDAP~~
	~~client application program. There is a short list of software that is~~
	~~required for some of the advanced features of OPeNDAP, and some~~
	~~environment variables that control the execution of the OPeNDAP software.~~
	~~For a piece of software that has been converted to use OPeNDAP, after~~
	~~these conditions are satisfied, the program will run in the same~~
	~~manner it ran before. Aside from network delays, the user should not~~
	~~be able to tell that they are accessing data from the Internet.~~


	Finally, though it may seem unnecessary to mention, in order for an OPeNDAP client application to communicate with an OPeNDAP server, the computer running the OPeNDAP client must be connected to the Internet.


	~~===Requirements===~~

	~~In order to use of some of the features of the OPeNDAP core software, a~~
	~~user's computer must have some additional software installed, and~~
	~~available on the user's <font color='green'>PATH</font>, in~~
	~~<font color='green'>$DODS_ROOT/bin</font>. or <font color='green'>$DODS_ROOT/etc</font>.~~


	*The <font color='green'>wish</font>. Tcl/Tk interpreter (or whatever program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is
	~~used by the "GUI manager" to provide a progress indicator~~
	~~that displays the status of a pending data request as it is being~~
	~~processed. It is also used by the error reporting system to display~~
	~~error message received from the server.~~
	*The <font color='green'>gzip</font> program, the \ind{GNU compression software, is used to decompress data messages received from an OPeNDAP
	~~server. If this program is not installed, the OPeNDAP core software~~
	~~tells the server not to send compressed messages, so data may still~~
	~~be received. However, having the compression software installed and~~
	~~available will increase the data transfer rate.~~

	~~The required software, like OPeNDAP itself, is free software. Refer to~~
	~~[[Wiki_Testing/OPeNDAPUserGuideAppendix\|Appendix]] for information about acquiring that software.~~

	~~===Environment Variables===~~


	~~After successfully relinking an application program with the OPeNDAP~~
	~~libraries, there is a short list of environment variables that~~
	~~may be defined. Only <font color='green'>DODS_ROOT</font> is required. The other three~~
	~~variables are only used to override default values controlling the GUI~~
	~~manager process. Most users may safely ignore them.~~

	~~<blockquote>~~
	~~; <font color='green'>DODS_ROOT</font> : indicates the root directory of the OPeNDAP~~
	~~software. The OPeNDAP core software must be able to locate utilities~~
	~~that are located in this directory tree. \indc{environment~~
	~~variables!DODS_ROOT}~~
	~~; <font color='green'>DODS_GUI</font> : can contain the name of the program used by the~~
	~~GUI manager. A user might wish to change this variable to~~
	~~point to a "safe" Tcl/Tk interpreter; whatever program is used~~
	~~here must be able to process Tcl and Tk commands. The default value~~
	~~is the <font color='green'>wish</font> program. \indc{environment~~
	~~variables!DODS_GUI}~~
	~~; <font color='green'>DODS_GUI_INIT</font> : indicates the name of any initialization~~
	~~command required by the "GUI manager". The default~~
	~~initialization string executes the Tcl program in~~
	~~<font color='green'>$DODS_ROOT/etc/dods_gui.tc1</font>.~~
	~~environment variables!DODS_GUI_INIT~~
	~~; <font color='green'>DODS_USE_GUI</font> : may be used to turn off the GUI manager. Set~~
	~~the value of this variable to <font color='green'>no</font>, and the progress indicator~~
	~~and the error message windows will not be displayed.~~


	~~</blockquote>~~

	~~<blockquote>NOTE:The user has substantial control over the GUI manager. You can~~
	~~change the program that listens for GUI commands from <font color='green'>wish</font> to~~
	~~anything else, and you can actually change the action of the GUI~~
	~~commands by editing the Tcl code in the files <font color='green'>dods_gui.tcl</font>,~~
	~~<font color='green'>error.tcl}, and \lit{progress.tcl</font>. (These are in the~~
	~~<font color='green'>$DODS_ROOT/etc</font> directory.) However, editing these files and~~
	~~variables will not change the form of the messages from the OPeNDAP~~
	~~server, and from the core software that are meant to invoke these~~
	~~programs. In other words, the user may mess with these, but must be~~
	~~careful to leave the GUI manager in a form that will be able to~~
	~~process the messages it receives.</blockquote>~~

	~~===The Error System===~~



	~~The GUI manager is used to display error messages~~
	~~to the user. The messages themselves will vary with the server~~
	~~implementation. Refer to the documentation of the particular server,~~
	~~or consult the server's <font color='green'>info</font> Service (See~~
	~~([[Wiki_Testing/OPeNDAPUserGuide5\| Section 5.1.1]]), for a list of the error messages~~
	~~that might be issued by a particular server.~~

	~~===Temporary Files===~~




	~~Using an OPeNDAP client application will~~
	~~create a number of temporary files. They are created with the~~
	~~<font color='green'>tmpnam()</font> function, so their names will correspond to the rules~~
	~~for that function on your system (See the manual page for~~
	~~<font color='green'>tmpnam(3)</font>, or type <font color='green'>man tmpnam</font> for more information.)~~
	~~During normal operation, OPeNDAP will delete the temporary files it~~
	~~creates as it goes. However, if execution of the OPeNDAP client is~~
	~~somehow interrupted, these files may remain, and will have to be~~
	~~deleted by hand.~~

Yuan: /* The Error System */

2008-01-05T09:24:05Z

The Error System

← Older revision		Revision as of 09:24, 5 January 2008
Line 322:		Line 322:
	implementation. Refer to the documentation of the particular server,		implementation. Refer to the documentation of the particular server,
	or consult the server's <font color='green'>info</font> Service (See		or consult the server's <font color='green'>info</font> Service (See
	([[Wiki_Testing/OPeNDAPUserGuide5\| Section 5.1.1]]).), for a list of the error messages		([[Wiki_Testing/OPeNDAPUserGuide5\| Section 5.1.1]]), for a list of the error messages
	that might be issued by a particular server.		that might be issued by a particular server.

Yuan: /* Temporary Files */

2008-01-05T09:23:46Z

Temporary Files

← Older revision		Revision as of 09:23, 5 January 2008
Line 334:		Line 334:
	<font color='green'>tmpnam()</font> function, so their names will correspond to the rules		<font color='green'>tmpnam()</font> function, so their names will correspond to the rules
	for that function on your system (See the manual page for		for that function on your system (See the manual page for
	<font color='green'>tmpnam(3)}, or type ~~\lit{~~man tmpnam</font> for more information.)		<font color='green'>tmpnam(3)</font>, or type <font color='green'>man tmpnam</font> for more information.)
	During normal operation, OPeNDAP will delete the temporary files it		During normal operation, OPeNDAP will delete the temporary files it
	creates as it goes. However, if execution of the OPeNDAP client is		creates as it goes. However, if execution of the OPeNDAP client is
	somehow interrupted, these files may remain, and will have to be		somehow interrupted, these files may remain, and will have to be
	deleted by hand.		deleted by hand.

Yuan: /* The Error System */

2008-01-05T09:23:06Z

The Error System

← Older revision		Revision as of 09:23, 5 January 2008
Line 322:		Line 322:
	implementation. Refer to the documentation of the particular server,		implementation. Refer to the documentation of the particular server,
	or consult the server's <font color='green'>info</font> Service (See		or consult the server's <font color='green'>info</font> Service (See
	([~~http:~~/~~/www <cite> opd-server,service</cite>~~]).), for a list of the error messages		([[Wiki_Testing/OPeNDAPUserGuide5\| Section 5.1.1]]).), for a list of the error messages
	that might be issued by a particular server. ~~\tbd{As error codes are~~		that might be issued by a particular server.

	~~finalized, they should be included in an Appendix of this document,~~

	~~and a pointer to them included here.}~~

	===Temporary Files===		===Temporary Files===

Yuan: /* Environment Variables */

2008-01-05T09:22:12Z

Environment Variables

← Older revision		Revision as of 09:22, 5 January 2008
Line 281:		Line 281:
	<blockquote>		<blockquote>
	; <font color='green'>DODS_ROOT</font> : indicates the root directory of the OPeNDAP		; <font color='green'>DODS_ROOT</font> : indicates the root directory of the OPeNDAP

	software. The OPeNDAP core software must be able to locate utilities		software. The OPeNDAP core software must be able to locate utilities

	that are located in this directory tree. \indc{environment		that are located in this directory tree. \indc{environment

	variables!DODS_ROOT}		variables!DODS_ROOT}

	; <font color='green'>DODS_GUI</font> : can contain the name of the program used by the		; <font color='green'>DODS_GUI</font> : can contain the name of the program used by the
			GUI manager. A user might wish to change this variable to
	~~\new{~~GUI manager}. A user might wish to change this variable to

	point to a "safe" Tcl/Tk interpreter; whatever program is used		point to a "safe" Tcl/Tk interpreter; whatever program is used

	here must be able to process Tcl and Tk commands. The default value		here must be able to process Tcl and Tk commands. The default value

	is the <font color='green'>wish</font> program. \indc{environment		is the <font color='green'>wish</font> program. \indc{environment

	variables!DODS_GUI}		variables!DODS_GUI}

	; <font color='green'>DODS_GUI_INIT</font> : indicates the name of any initialization		; <font color='green'>DODS_GUI_INIT</font> : indicates the name of any initialization

	command required by the "GUI manager". The default		command required by the "GUI manager". The default

	initialization string executes the Tcl program in		initialization string executes the Tcl program in

	<font color='green'>$DODS_ROOT/etc/dods_gui.tc1</font>.		<font color='green'>$DODS_ROOT/etc/dods_gui.tc1</font>.
			environment variables!DODS_GUI_INIT

	~~\indc{~~environment

	variables!DODS_GUI_INIT}

	; <font color='green'>DODS_USE_GUI</font> : may be used to turn off the GUI manager. Set		; <font color='green'>DODS_USE_GUI</font> : may be used to turn off the GUI manager. Set

	the value of this variable to <font color='green'>no</font>, and the progress indicator		the value of this variable to <font color='green'>no</font>, and the progress indicator

	and the error message windows will not be displayed.		and the error message windows will not be displayed.


			</blockquote>

	</blockquote>		<blockquote>NOTE:The user has substantial control over the GUI manager. You can
	~~\note{~~The user has substantial control over the GUI manager. You can

	change the program that listens for GUI commands from <font color='green'>wish</font> to		change the program that listens for GUI commands from <font color='green'>wish</font> to

	anything else, and you can actually change the action of the GUI		anything else, and you can actually change the action of the GUI

	commands by editing the Tcl code in the files <font color='green'>dods_gui.tcl</font>,		commands by editing the Tcl code in the files <font color='green'>dods_gui.tcl</font>,

	<font color='green'>error.tcl}, and \lit{progress.tcl</font>. (These are in the		<font color='green'>error.tcl}, and \lit{progress.tcl</font>. (These are in the

	<font color='green'>$DODS_ROOT/etc</font> directory.) However, editing these files and		<font color='green'>$DODS_ROOT/etc</font> directory.) However, editing these files and

	variables will not change the form of the messages from the OPeNDAP		variables will not change the form of the messages from the OPeNDAP

	server, and from the core software that are meant to invoke these		server, and from the core software that are meant to invoke these

	programs. In other words, the user may mess with these, but must be		programs. In other words, the user may mess with these, but must be

	careful to leave the GUI manager in a form that will be able to		careful to leave the GUI manager in a form that will be able to
			process the messages it receives.</blockquote>
	process the messages it receives.}

	===The Error System===		===The Error System===

Yuan: /* Requirements */

2008-01-05T09:19:43Z

Requirements

← Older revision		Revision as of 09:19, 5 January 2008
Line 261:		Line 261:
	processed. It is also used by the error reporting system to display		processed. It is also used by the error reporting system to display
	error message received from the server.		error message received from the server.
	*The <font color='green'>gzip}</font> program, the \ind{GNU compression software, is used to decompress data messages received from an OPeNDAP		*The <font color='green'>gzip</font> program, the \ind{GNU compression software, is used to decompress data messages received from an OPeNDAP
	server. If this program is not installed, the OPeNDAP core software		server. If this program is not installed, the OPeNDAP core software
	tells the server not to send compressed messages, so data may still		tells the server not to send compressed messages, so data may still
Line 268:		Line 268:

	The required software, like OPeNDAP itself, is free software. Refer to		The required software, like OPeNDAP itself, is free software. Refer to
	~~\appref{install}~~ for information about acquiring that software.		[[Wiki_Testing/OPeNDAPUserGuideAppendix\|Appendix]] for information about acquiring that software.

	===Environment Variables===		===Environment Variables===

Yuan: /* Requirements */

2008-01-05T09:18:52Z

Requirements

← Older revision		Revision as of 09:18, 5 January 2008
Line 256:		Line 256:


	*The <font color='green'>wish</font>. Tcl/Tk interpreter (or whatever		*The <font color='green'>wish</font>. Tcl/Tk interpreter (or whatever program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is
	program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is
	used by the "GUI manager" to provide a progress indicator		used by the "GUI manager" to provide a progress indicator
	that displays the status of a pending data request as it is being		that displays the status of a pending data request as it is being
	processed. It is also used by the error reporting system to display		processed. It is also used by the error reporting system to display
	error message received from the server.		error message received from the server.
	*The <font color='green'>gzip}</font> program, the \ind{GNU compression		*The <font color='green'>gzip}</font> program, the \ind{GNU compression software, is used to decompress data messages received from an OPeNDAP
	software, is used to decompress data messages received from an OPeNDAP
	server. If this program is not installed, the OPeNDAP core software		server. If this program is not installed, the OPeNDAP core software
	tells the server not to send compressed messages, so data may still		tells the server not to send compressed messages, so data may still

Yuan: /* Requirements */

2008-01-05T09:18:30Z

Requirements

← Older revision		Revision as of 09:18, 5 January 2008
Line 256:		Line 256:


	*The <font color='green'>wish</font>. {Tcl}}/~~{\ind{~~Tk interpreter (or whatever		*The <font color='green'>wish</font>. Tcl/Tk interpreter (or whatever
	program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is		program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is
	used by the "GUI manager" to provide a progress indicator		used by the "GUI manager" to provide a progress indicator

Yuan: /* Requirements */

2008-01-05T09:18:09Z

Requirements

← Older revision		Revision as of 09:18, 5 January 2008
Line 256:		Line 256:


	*The <font color='green'>wish} {Tcl}}/{\ind{Tk~~</font>~~ interpreter (or whatever		*The <font color='green'>wish</font>. {Tcl}}/{\ind{Tk interpreter (or whatever
	program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is		program is indicated by the <font color='green'>DODS_GUI</font> environment variable) is
	used by the "GUI manager" to provide a progress indicator		used by the "GUI manager" to provide a progress indicator
	that displays the status of a pending data request as it is being		that displays the status of a pending data request as it is being
	processed. It is also used by the error reporting system to display		processed. It is also used by the error reporting system to display
	error message received from the server. ~~\tbd{and by the data~~		error message received from the server.
	~~locator, to display information and query the user}~~
	*The <font color='green'>gzip}</font> program, the \ind{GNU compression		*The <font color='green'>gzip}</font> program, the \ind{GNU compression
	software, is used to decompress data messages received from an OPeNDAP		software, is used to decompress data messages received from an OPeNDAP

Yuan: /* Using an OPeNDAP Program */

2008-01-05T09:17:08Z

Using an OPeNDAP Program

← Older revision		Revision as of 09:17, 5 January 2008
Line 235:		Line 235:
	==Using an OPeNDAP Program==		==Using an OPeNDAP Program==

			There are some configuration issues a user must consider in order to use an OPeNDAP

	There are some
	configuration issues a user must consider in order to use an OPeNDAP
	client application program. There is a short list of software that is		client application program. There is a short list of software that is
	required for some of the advanced features of OPeNDAP, and some		required for some of the advanced features of OPeNDAP, and some
Line 248:		Line 245:


	Finally, though it may seem unnecessary to mention, in order for an OPeNDAP client application to communicate with an OPeNDAP server, the		Finally, though it may seem unnecessary to mention, in order for an OPeNDAP client application to communicate with an OPeNDAP server, the computer running the OPeNDAP client must be connected to the Internet.
	computer running the OPeNDAP client must be connected to the Internet.

	===Requirements===		===Requirements===
Line 256:		Line 253:
	user's computer must have some additional software installed, and		user's computer must have some additional software installed, and
	available on the user's <font color='green'>PATH</font>, in		available on the user's <font color='green'>PATH</font>, in
	<font color='green'>$DODS_ROOT/bin} or ~~\lit{~~$DODS_ROOT/etc</font>.		<font color='green'>$DODS_ROOT/bin</font>. or <font color='green'>$DODS_ROOT/etc</font>.


	~~\indc{system~~

	~~configuration}~~