ensfiles.pl - Revision history

Edit: /* Options */

2009-07-30T14:21:50Z

Options

Edit: /* Description */

2009-07-30T14:19:40Z

Description

Feig at 14:31, 12 August 2006

2006-08-12T14:31:29Z

New page

__NOTOC__
== Usage ==

<mmtsbToolUsage cmd="ensfiles.pl"></mmtsbToolUsage>

== Description ==

This script is used to extract a list of files from an ensemble structure.
It requires an ensemble tag as argument and -dir may be
used to specify the ensemble directory. If no further arguments are given
it will list all ensemble files associated with the given tag. 
The option -cluster may be used to list only the files from
a specific cluster if <docmark>enscluster.pl</docmark> was run
previously to perform the clustering. The utility
<docmark>showcluster.pl</docmark> is available to list all identified
clusters. Normally cluster information is read for the tag for which the
list of files is obtained. If clustering information is only available for
a different tag in the same ensemble of structures this tag may be given with
-ctag so that the corresponding cluster file is used instead. 
The file list may be sorted according to values of
an associated ensemble property if the property tag is given with -sort. 
The option -list is available to provide a file with indices to
obtain file names for selected structures. 
Please note that by default the files are stored in compressed form
(gzip). This script, however, always returns the file names in
uncompressed form without the .gz extension, whether the
files are compressed or not.
== Options ==

; -help : usage information

== Examples ==

<mmtsbToolExample cmd="ensfiles.pl" set="/apps/mmtsb/bench/ensfiles.pl-test/test1"></mmtsbToolExample>

<mmtsbToolExample cmd="ensfiles.pl" set="/apps/mmtsb/bench/ensfiles.pl-test/test2"></mmtsbToolExample>

<mmtsbToolExample cmd="ensfiles.pl" set="/apps/mmtsb/bench/ensfiles.pl-test/test3"></mmtsbToolExample>

@@ Line 33: / Line 33: @@
 ; -help : usage information
+; -cluster level : clustering level for hierarchical clusters
 == Examples ==

@@ Line 10: / Line 10: @@
 used to specify the ensemble directory. If no further arguments are given
 it will list all ensemble files associated with the given tag.<BR>
 The option <B>-cluster</B> may be used to list only the files from
-a specific cluster if <docmark>enscluster.pl</docmark> was run
+a specific cluster if [[enscluster.pl]] was run
 previously to perform the clustering. The utility
-<docmark>showcluster.pl</docmark> is available to list all identified
+[[showcluster.pl]] is available to list all identified
 clusters. Normally cluster information is read for the tag for which the
 list of files is obtained. If clustering information is only available for
 a different tag in the same ensemble of structures this tag may be given with
 <B>-ctag</B> so that the corresponding cluster file is used instead.<BR>
 The file list may be sorted according to values of
 an associated ensemble property if the property tag is given with <B>-sort</B>.<BR>
 The option <B>-list</B> is available to provide a file with indices to
 obtain file names for selected structures.<BR>
 Please note that by default the files are stored in compressed form
 (gzip). This script, however, always returns the file names in
-uncompressed form without the <font color=#508060>.gz</font> extension, whether the
+uncompressed form without the <font color=#508060>.gz</font> extension, whether the files are compressed or not.
 files are compressed or not.
 == Options ==