github.com/wtsi-ssg/wrstat/v4@v4.5.1/README.md (about)

     1  # wrstat
     2  Efficiently walk a tree then get stats of all files in parallel across many
     3  nodes using wr.
     4  
     5  This is a replacement for https://github.com/wtsi-hgi/mpistat that doesn't use
     6  any run-time inter-process communication, for greater reliability and speed.
     7  
     8  It relies on https://github.com/VertebrateResequencing/wr to do the scheduling
     9  of its work.
    10  
    11  ## Build
    12  
    13  [NPM](https://www.npmjs.com/) is required to build this project.
    14  
    15  ```
    16  git clone https://github.com/wtsi-ssg/wrstat/
    17  cd wrstat
    18  make
    19  ```
    20  
    21  ## Usage
    22  As a user that has permission to see all files on the disks of interest:
    23  
    24  ```
    25  wr manager start -s lsf
    26  wrstat multi -w /working/dir -f /final/dir /disk1 /disk2
    27  wr status -i wrstat -z -o s
    28  ```
    29  
    30  Or if your user account has the ability to sudo without a password when
    31  executing the wrstat executable, add the --sudo option to `wrstat multi`.
    32  If you're running `wr` and `wrstat` without custom configurations, `wr` must
    33  be run as the root user, because `wrstat` will generate `sudo` commands that
    34  attempt to connect to a port number based on the user, which will be the root
    35  user, not the running user.
    36  
    37  To do certain chmod and chown operations on desired paths to bring them in to
    38  line with desired unix groups, create a YAML file like the example ch.yml in the
    39  git repository, and supply it as the --ch option to `wrstat multi`.
    40  For more details on ch, see `wrstat stat -h`.
    41  
    42  Generally, use the `-h` option on wrstat and its sub commands for detailed
    43  help.