Command Line HOWTO

Generate

Basic configuration

Pipeline

With Parameters

Distributed options

The default distributed options will assume a normal distribution with mu=0.5, sigma=.2433, n=5, and range 0-1. To choose a different distribution, specify dist, the parameter flags, or the range respectively.

Example

bagpipes pl -np testPhase --cross dummies.dummyComponent -X foo

Will result in:

phase: testPhase
options:
  - inherit: dummies.dummyReader
    params:
      foo: '0.2229648733341804'
  - inherit: dummies.dummyReader
    params:
      foo: '0.4344104743445896'
  - inherit: dummies.dummyReader
    params:
      foo: '0.48870936286436595'
  - inherit: dummies.dummyReader
    params:
      foo: '0.5572669818556261'
  - inherit: dummies.dummyReader
    params:
      foo: '0.5648321558547064'

Execute

Visualize

Help

BagPipes 0.0.1 (c) 2014 Avner Maiberg (amaiberg@cs.cmu.edu)
Usage: bp [OPTION]... |init|pl|create|+ |OPTION|...
bp generates, manages, and executes pipeline descriptors using the BagPipes framework.      
Options:

  -a, --append
      --noappend
  -p, --pipe
      --nopipe
  -q, --quiet
      --noquiet
      --help       Show help message
      --version    Show version of this program

Subcommand: pl
  -c, --component  <arg>
  -C, --cross  <arg>
  -d, --dist  <arg>             (default = gauss)
  -m, --mu  <arg>               (default = 0.5)
  -n, --new
      --nonew
  -N, --numComponents  <arg>    (default = 10)
  -o, --options
      --nooptions
  -Pkey=value [key=value]...
  -X, --param  <arg>
  -p, --phase  <arg>            (default = defaultPhase)
  -s, --sigma  <arg>            (default = 0.24333)
      --help                   Show help message

 trailing arguments:
  begin (not required)    (default = 0.0)
  end (not required)      (default = 1.0)
Subcommand: create
  -c, --class  <arg>
  -Pkey=value [key=value]...
      --help                   Show help message
Subcommand: init
  -a, --author  <arg>              the author of the descriptor
                                   (default = default)
  -c, --collection-reader  <arg>   specifies the collection reader
                                   (default = collection_reader.filesystem-collection-reader)
  -n, --name  <arg>                the name of the descriptor (default = default)
      --help                       Show help message

Subcommand: init pl
  -c, --component  <arg>
  -C, --cross  <arg>
  -d, --dist  <arg>             (default = gauss)
  -m, --mu  <arg>               (default = 0.5)
  -n, --new
      --nonew
  -N, --numComponents  <arg>    (default = 10)
  -o, --options
      --nooptions
  -Pkey=value [key=value]...
  -X, --param  <arg>
  -p, --phase  <arg>            (default = defaultPhase)
  -s, --sigma  <arg>            (default = 0.24333)
      --help                   Show help message

 trailing arguments:
  begin (not required)    (default = 0.0)
  end (not required)      (default = 1.0)
Subcommand: exec
      --help   Show help message

 trailing arguments:
  descriptor (required)