Scientific Data Management » REX » IF Data Handling Client Tools (ifdhc)

h1. ifdh commands

Note that many of these commands are new in ifdh v1_3_x.

h2. Environment variables

* IFDH_DEBUG=1 for voluminous debug output

* EXPERIMENT set to an experiment name ("minerva", "nova", etc.)

  if it can't be guessed from your group,etc.

* IFDH_BASE_URI to pick a particular samweb server.

* IFDH_GRIDFTP_EXTRA, IFDH_SRM_EXTRA, IFDH_DD_EXTRA flags to set options

  flor globus-url-copy, lcg_cp, dd, etc.

* IFDH_WEB_TIMEOUT for samweb timeouts.

h2. Commands

* *ifdh* *cp* _args_

	 general file copy using cpn locks dd, gridftp, or srmcp 

	 supports:  

	 * cp src1 dest1 [';' src2 dest2 [';'...]]                     -- basic source/dest filenames 

	 * cp -r src1 dest1 [';' src2 dest2 [';'...]]                  -- recursive directory copies 

	 * cp -D src1 src2 destdir1 [';' src3 src4 destdir2 [';'...]]  -- copies to dest. directory 

	 * cp -f file_with_src_space_dest_lines                        -- copies to a list file 

	 * any of the above can take --force={cpn,gridftp,srmcp,expgridftp} 

	 * any of the file/dest arguments can be URIs 

	 --- 

* *ifdh* *fetchInput* _src_uri _

	 get input file to local scratch, return scratch location

* *ifdh* *localPath* _src_uri _

	 return scratch location fetchInput would give, without copying

* *ifdh* *addOutputFile* _filename _

	 add output file to set

* *ifdh* *copyBackOutput* _dest_dir _

	 copy output file set to destination with cpn or srmcp

* *ifdh* *log* _args_

	 logging 

* *ifdh* *enterState* _state _

	 log entering/leaving states

* *ifdh* *leaveState* _state _

* *ifdh* *createDefinition* _name  dims  user  group _

	 make a named dataset definition from a dimension string

* *ifdh* *deleteDefinition* _name _

	 remove data set definition

* *ifdh* *describeDefinition* _name _

	 describe a named dataset definition

* *ifdh* *translateConstraints* _dims _

	 give file list for dimension string

* *ifdh* *locateFile* _name _

	 locate a file

* *ifdh* *getMetadata* _name _

	 get a files metadata

* *ifdh* *dumpStation* _name  what  _

	 give a dump of a SAM station status

* *ifdh* *startProject* _name  station  defname_or_id  user  group _

	 start a new file delivery project

* *ifdh* *findProject* _name  station _

	 find a started project

* *ifdh* *establishProcess* _projecturi  appname  appversion  location  user  appfamily   description   filelimit  _

	 set yourself up as a file consumer process for a project

* *ifdh* *getNextFile* _projecturi  processid _

	 get the next file location from a project

* *ifdh* *updateFileStatus* _projecturi  processid  filename  status _

	 update the file status (use: transferred, skipped, or consumed)

* *ifdh* *endProcess* _projecturi  processid _

	 end the process

* *ifdh* *dumpProject* _projecturi _

	 say what the sam station knows about your process

* *ifdh* *setStatus* _projecturi  processid  status _

	 set process status

* *ifdh* *endProject* _projecturi _

	 end the project

* *ifdh* *cleanup* __

	 clean up any tmp file stuff

* *ifdh* *renameOutput* _how _

	 give output files reported with addOutputFile a unique name

* *ifdh* *mv* _args_

	 general file rename using mvn or srmcp

* *ifdh* *ls* _loc  recursion_depth  force _

	 Get a list of directory contents, or check existence of files

* *ifdh* *mkdir* _loc  force _

	 make a directory (i.e. for file destination)

* *ifdh* *rm* _loc  force _

	 remove files