init_pipeline.pl 2.47 KB
Newer Older
Leo Gordon's avatar
Leo Gordon committed
1
#!/usr/bin/env perl
2
3
4
5
#
# A generic loader of hive pipelines.
#
# Because all of the functionality is hidden in Bio::EnsEMBL::Hive::PipeConfig::HiveGeneric_conf
6
7
# you can create pipelines by calling the right methods of HiveGeneric_conf directly,
# so this script is just a commandline wrapper that can conveniently find modules by their filename.
8
9

use strict;
Leo Gordon's avatar
Leo Gordon committed
10
use warnings;
11
use Bio::EnsEMBL::Hive::Utils ('script_usage', 'load_file_or_module');
12

13
14

sub main {
15
    my $file_or_module = shift @ARGV or script_usage(0);
16

17
    my $config_module = load_file_or_module( $file_or_module );
18

19
20
21
    my $config_object = $config_module->new();
    $config_object->process_options();
    $config_object->run();
22
23
24
25
26
27
28
29
30
31
32
33
34
35
}

main();

__DATA__

=pod

=head1 NAME

    init_pipeline.pl

=head1 SYNOPSIS

36
    init_pipeline.pl <config_module_or_filename> [-help | [-analysis_topup | -job_topup] <options_for_this_particular_pipeline>]
37
38
39

=head1 DESCRIPTION

Leo Gordon's avatar
Leo Gordon committed
40
    init_pipeline.pl is a generic script that is used to create+setup=initialize eHive pipelines from PipeConfig configuration modules.
41
42
43

=head1 USAGE EXAMPLES

Leo Gordon's avatar
Leo Gordon committed
44
45
        # get this help message:
    init_pipeline.pl
46

Leo Gordon's avatar
Leo Gordon committed
47
48
        # initialize a generic eHive pipeline:
    init_pipeline.pl Bio::EnsEMBL::Hive::PipeConfig::HiveGeneric_conf -password <yourpassword>
49

Leo Gordon's avatar
Leo Gordon committed
50
51
52
        # see what command line options are available when initializing long multiplication example pipeline
        #   (assuming your current directory is ensembl-hive/modules/Bio/EnsEMBL/Hive) :
    init_pipeline.pl PipeConfig/LongMult_conf -help
53

Leo Gordon's avatar
Leo Gordon committed
54
55
56
        # initialize the long multiplicaton pipeline by supplying not only mandatory but also optional data:
        #   (assuming your current directory is ensembl-hive/modules/Bio/EnsEMBL/Hive/PipeConfig) :
    init_pipeline.pl LongMult_conf -password <yourpassword> -first_mult 375857335 -second_mult 1111333355556666 
57
58
59

=head1 OPTIONS

60
    -help           :   get automatically generated list of options that can be set/changed when initializing a particular pipeline
61

62
63
64
65
    -analysis_topup :   a special initialization mode when (1) pipeline_create_commands are switched off and (2) only newly defined analyses are added to the database
                        This mode is only useful in the process of putting together a new pipeline.

    -job_topup      :   another special initialization mode when only jobs are created - no other structural changes to the pipeline are acted upon.
66
67
68
69
70
71

=head1 CONTACT

    Please contact ehive-users@ebi.ac.uk mailing list with questions/suggestions.

=cut
72