Dclient

Dclient is a program which implements functions of a client for automatic uploading data to a remote host. This document presents instruction for usage, customization and installation.

Contents:

Purpose
Usage
Customization
Installation
History

Purpose.

Dclient is a part of Mark-4 VLBI Analysis Software Calc/Solve. It is a program which provides the easiest user interface to client part of dserver/dclient software for uploading data. It parses a user command, copies the specified files to a local ftp area, compresses them, generates and sends an e-mail message to dserver for initiating data uploading process. Currently, dclient supports uploading VLBI database files, EOP series, solution technical desciptions and solution litings in Sinex format.

Usage:

Usage: dclient FLAGS -t data_type -c config_file -f item_name

FLAGS:
-q -- quiet mode. Request for confirmation of the operation is not issued.
-qq -- the quietest mode. No request for confirmation of the operation no information about the progress is printed on the screen.
-p -- to send a ping to the Data Center in order to check whether it is still running. Arguments data type and database names are ignored and can be omitted if this flag is on.
-h -- help information is printed in stdout.

data_type -- supported data types:

DBH data type is supported: database(s) transfer.

EOPS data type: EOP series from 24 hours VLBI experiments.

EOPI data type: EOP series from NEOS Intensive VLBI experiments.

DESC data type: Technical description of the solutions

DSNX data type: Listing in Sinex format of the standalone solution.

config_file -- File which contains configuration of dclient.
item_name -- item to be transferred. Meaning depends on data_type. If data_type is EOPS or EOPI then it is the filename with EOP series. If data_type is DESC it is the filename with solution description. If data_type is DSNX it is the filename with solution listing. If data_type is DBH them it is the experiment string which is interpreted as

a database file name with absolute path if the first symbol is "/"
a database filename with specific version if the argument contains a pattern "_V". File path will be find in geo-VLBI catalogue system.
a request for transferring a pair of the last versions of -X and -S databases if the argument does not contain a pattern "_V" and starts from the symbol other than "/". Two databases will be transferred.

It is assumed that database name satisfy IVS convention, otherwise dserver will refuse to upload the data. Examples:

      dclient -t DBH  -c $MK4/local.GSFC.dbs  -f /diskA1/data1/99JUL01XA_V004
      dclient -t DBH  -c $MK4/local.GSFC.dbs  -f 99JUL19SH_V002
      dclient -t DBH  -c $MK4/local.GSFC.dbs  -f 99JUN14XH
      dclient -q -t EOPS -c $MK4/local.GSFC.eops -f $SAVE_DIR/last.eops
      dclient -h
      dclient -p -c $MK4/local.GSFC.dbs

Dclient reads configure file, checks its syntax. Further work depends on a data type. If the data_type is DBH then dclient checks a item_name argument and determines its mode. In the case of modes "b" and "c" dclient asks catalogue and finds filename(s) of the database(s) with absolute path(s). If the data_type is EOPS, EOPI, DESC or DSNX then dclient copies EOP series or technical description or solution listing file to the directory and filename which specified in the configuration file. Dclient processes data types EOPS and EOPI, DESC, DSNX similar way. Then it creates a temporary file with e-mail message to dserver and creates a temporary file with C-Shell program which copies the data file(s) to a local ftp-directory and gzips them on the fly. Finally a e-mail message is sent to dserver which should initiate retrieving the databases or EOP series from the host where dclient has been launched (Operating Center) to a a host where dserver is running (Data Center). E-mail messages from dserver with confirmation of a request or denying it and successful termination of retrieving (or error during retrieving) will be sent to user(s) in according specifications in config_file. Dclient doesn't check data contents, but dserver does. Dclient also doesn't check whether filename is legal (follows IVS datafile convention), but dserver checks.

Customization.

All site-specific dependencies are in the configuration file. This file contains configuration parameters used by a program dclient. Format: #, blank, keyword, delimiters, value. Lines starting from ## or empty lines are considered as comments and ignored. All parameters should be specified. No defaults are supported. All keywords have to be specified. All values are of character type.

Supported keywords:

DATA_CENTER -- Name of the Data Center where data are to be sent.

DSERVER_EMAIL -- E-mail address of the Data Center where data are to be sent.

FTP_DIR -- Name of the directory which is used for anonymous ftp. It should be accessible via NFS from on the local machine and at the same time be accessible via anonymous ftp for the other world.

URL_PREFIX -- Prefix of URL which is mapped to the directory FTP_DIR. This prefix should contain protocol ( http or ftp ), machine name, and directory name (which may be only "/" ). NB: You should send your URL prefix to the dserver maintainer for registration. You are supposed to notify the dserver maintainer if your URL prefix is changed. Otherwise, your request to dserver will be denied for security reason.

MAIL_COMMAND: -- command (with switches) used for sending e-mails from the local machine.

EOP_SUFFIX: -- solution name. It consists of 8 characters. The first three characters are analysis center code, the last 5 characters are solution identifier. This field should be specified ONLY if the file with EOP series is submitted.

CONFIRM_EMAIL -- Blank-separated list of e-mail addresses where a message confirming acceptance of a request by dserver is to be sent. A dot in the list is expanded to the e-mail address of the user who launched dclient. Duplicates in the list of e-addresses are detected and removed.

SUCCESS_EMAIL -- Blank-separated list of e-mail addresses where dserver sends a message confirming successful data transferring. A dot in the list is expanded to e-mail address of the user who launched dclient. Duplicates in the list of e-addresses are detected and removed.

SUBMIT_LOG -- Filename with path where dclient writes a record about sending a messages to dserver with request for transferring data.

TMP_DIR -- Path to directory for temporary files.

DO_PURGE -- Value YES or NO are allowed. YES means that temporary files will be purged upon dclient completion.

DO_LINK -- Value YES or NO are allowed. YES means that where will be created a link to the files with gzipped databases in FTP_DIR directory with .gzp extensions (This option is for internal use in GIUB only).

Example 1:

#############################################################################
##                                                                         ##
##  dclient configuration file for submitting databases from GSFC (GSF)    ##
##                                                                         ##
##  11-OCT-2000 17:05:53                                                   ##
##                                                                         ##
#############################################################################
# DATA_CENTER:    CDDISA, NASA/GSFC
# DSERVER_EMAIL:  dserver@ivscc.gsfc.nasa.gov
# FTP_DIR:        /home/ftp/pub/databases
# URL_PREFIX:     ftp://gemini.gsfc.nasa.gov/pub/databases/
# MAIL_COMMAND:   mailx 
# CONFIRM_EMAIL:  NO
# SUCCESS_EMAIL:  . cav@gemini.gsfc.nasa.gov dgg@leo.gsfc.nasa.gov 
# SUBMIT_LOG:     /data1/save_files/dbs_GSF.log
# TMP_DIR:        /tmp/
# DO_PURGE:       YES
# DO_LINK:        NO
#!

Example 2:

#############################################################################
##                                                                         ##
##  dclient configuration file for submitting EOP series from VLBI         ##
##  NEOS Intensive experiments from GSFC (GSF)                             ##
##                                                                         ##
##                                                   20-NOV-2000 17:07:12  ##
##                                                                         ##
#############################################################################
# DATA_CENTER:    CDDISA, NASA/GSFC
# DSERVER_EMAIL:  dserver@ivscc.gsfc.nasa.gov
# FTP_DIR:        /home/ftp/pub/eop/
# URL_PREFIX:     ftp://gemini.gsfc.nasa.gov/pub/eop/
# EOP_SUFFIX:     gsfint01
# MAIL_COMMAND:   mailx 
# CONFIRM_EMAIL:  NO
# SUCCESS_EMAIL:  . 
# TMP_DIR:        /tmp/
# DO_PURGE:       YES
#!

Installation.

Dclient is a part of Mark4 VLBI analysis software and is supported by solve_install. It is installed automatically when Calc/Solve is installed. Source code is located in ../mk4/src/dclient/ directory. Dclient can be compiled and linked also separately by

  ${MK4_ROOT}/support/make_progs

  cd ${MK4_ROOT}/progs/dclient/ 
  make

Installation process consists of compiling and linking dclient and creating three executable c-shell programs which facilitate using dclient. They are put in ${MK4_ROOT}/bin directory:

db_submit -- program for submitting database files.
eops_submit -- program for submission EOP series obtained from analysis of the 24 hours VLBI experiments.
eopi_submit -- program for submission EOP series obtained from analysis of the NEOS Intensive VLBI experiments.

All these programs has syntax: {program name} {file_name}.

These programs are created on the basis of prototype scripts $MK4_ROOT/local/{analysis_center}.dbs, $MK4_ROOT/local/{analysis_center}.eops, $MK4_ROOT/local/{analysis_center}.eopi . These files should exist before installing dclient.

History

1999.09.30 v 0.0	Beginning of development.
1999.10.01 v 0.5	First working version.
1999.10.04 v 1.0	First version was released.
2000.09.21 v 2.0	Support of EOPS solution type submission was added
2000.11.20 v 2.1	Support of EOPI solution type submission was added
2001.01.10 v 2.2	Support of -qq flag was added. A bug related to uiseing -q flag was fixed.
2001.01.16 v 2.3	Support of -p flag was added
2002.06.11 v 2.4	Support of solution types DESC and DSNX is added

Dclient was developed by Leonid Petrov ( pet@leo.gsfc.nasa.gov ).

Back to Dserver home page

Back to Mark-4 VLBI Analysis software Calc/Solve home page

Back to "Development of advanced methods of VLBI data analysis"

Back to Leonid Petrov's Home Page

Last update: 11-JUN-2002 14:44:10