INSTALL.WIN

   1
   2                          Installing Bioperl on Windows
   3
   4    Contents
   5
   6      * 1 Introduction
   7      * 2 Requirements
   8      * 3 To install Perl on Windows
   9      * 4 CPAN for ActivePerl and Strawberry Perl
  10      * 5 Installation using CPAN or manual installation
  11      * 6 Beyond the Core
  12      * 7 Bioperl in Cygwin
  13
  14 1 Introduction
  15
  16 This installation guide was written by Barry Moore, Nathan Haigh and other Bioperl
  17 authors based on the original work of Paul Boutros.
  18
  19 Please report problems and fixes to the BioPerl mailing list, *bioperl-l*
  20 (http://lists.open-bio.org/mailman/listinfo/bioperl-l).
  21
  22 2 Requirements
  23
  24 There are a couple of ways of installing Perl on a Windows machine. One is
  25 to get the most recent build from Strawberry Perl (http://strawberryperl.com),
  26 and the other is to get it from ActiveState (http://www.activestate.com). Both
  27 are software companies that provide free builds of Perl for Windows users, but
  28 Strawberry Perl is recommended since it is more CPAN friendly and because it
  29 includes a compiler (`gcc`) and related tools.
  30
  31 3 To install Perl on Windows:
  32
  33            1) Download the Strawberry Perl MSI from
  34            http://strawberryperl.com/releases.html or ActivePerl MSI from
  35            http://www.activestate.com/activeperl/downloads.
  36            2) Run the Installer (accepting all defaults is fine).
  37
  38 You can also build Perl yourself (which requires a C compiler) or download
  39 one of the other binary distributions. The Perl source for building it
  40 yourself is available from CPAN, as are a few other binary distributions
  41 that are alternatives to ActiveState. This approach is not recommended
  42 unless you have specific reasons for doing so and know what you're doing.
  43 If that's the case you probably don't need to be reading this guide.
  44
  45 4 CPAN for ActivePerl and Strawberry Perl
  46
  47            1) Open a cmd window by going to Start >> Run and typing 'cmd'
  48            into the box and pressing return.
  49
  50            2) Type 'cpan' to enter the CPAN shell.
  51
  52            3) At the cpan> prompt, type 'install CPAN' to upgrade to the
  53            latest version.
  54
  55            4) Quit (by typing 'q') and reload cpan. You may be asked some
  56            configuration questions; accepting defaults is fine.
  57
  58            5) At the cpan> prompt, type 'o conf prefer_installer MB' to tell
  59            CPAN to prefer to use Build.PL scripts for installation. Type 'o
  60            conf commit' to save that choice.
  61
  62            6) At the cpan> prompt, type 'install Module::Build'.
  63
  64            7) At the cpan> prompt, type 'install Test::Harness'.
  65
  66            8) At the cpan> prompt, type 'install Test::Most'.
  67
  68 You can now follow the unix instructions for installing using CPAN (preferred), or install manually:
  69
  70            9) Download the .zip version of the package you want.
  71
  72            10) Extract the archive in the normal way.
  73
  74            11) In a cmd window 'cd' to the directory you extracted to. Eg. if
  75            you extracted to directory 'Temp', 'cd Temp\bioperl-1.5.2_100'
  76
  77            12) Type 'perl Build.PL' and answer the questions appropriately.
  78
  79            13) Type 'perl Build test'. All the tests should pass, but if they
  80            don't, let us know. Your usage of Bioperl may not be affected
  81            by the failure, so you can choose to continue anyway.
  82
  83            14) Type 'perl Build install' to install Bioperl.
  84
  85 GUI Installation
  86
  87            1) Start the Perl Package Manager GUI from the Start menu.
  88
  89            2) Go to Edit >> Preferences and click the Repositories tab. Add a
  90            new repository for each of the following (note the difference based
  91            on the perl version). NOTE - The DB_File installed with ActivePerl
  92            5.10 and above is a stub (i.e. it does not work). The Trouchelle
  93            database below has a working DB_File.
  94
  95                               Repositories to add
  96        +----------------------------------------------------------------+
  97        |           Name           |              Location               |
  98        |--------------------------+-------------------------------------|
  99        |BioPerl-Release Candidates|http://bioperl.org/DIST/RC           |
 100        |--------------------------+-------------------------------------|
 101        |BioPerl-Regular Releases  |http://bioperl.org/DIST              |
 102        |--------------------------+-------------------------------------|
 103        |Kobes                     |http://theoryx5.uwinnipeg.ca/ppms    |
 104        |--------------------------+-------------------------------------|
 105        |Bribes                    |http://www.Bribes.org/perl/ppm       |
 106        |--------------------------+-------------------------------------|
 107        |Trouchelle                |http://trouchelle.com/ppm            |
 108        +----------------------------------------------------------------+
 109
 110            3) Select View >> All Packages.
 111            4) In the search box type bioperl.
 112            5) Right click the latest version of Bioperl available and choose
 113            install. (Note for users of previous Bioperl releases: you should
 114            not have to use the Bundle-BioPerl package anymore.)
 115            5a) From bioperl 1.5.2 onward, all 'optional' pre-requisites will
 116            be marked for installation. If you see that some of them complain
 117            about needing a command-line installation (eg. XML::SAX::ExpatXS),
 118            and you want those particular pre-requisites, stop now (skip step
 119            6) and see the 'Command-line Installation' section.
 120            7) Click the green arrow (Run marked actions) to complete the
 121            installation.
 122
 123 Command-line Installation
 124
 125            Use the ActiveState ppm-shell:
 126
 127            1) Open a cmd window by going to Start >> Run and typing
 128            'cmd' and pressing return.
 129
 130     2) Do
 131               C:> ppm-shell
 132               ppm>
 133
 134     3) Make sure you have the module PPM-Repositories. Try installing it:
 135               ppm> install PPM-Repositories
 136
 137     4) For BioPerl 1.6.1, we require at least the following
 138            repositories. You may have some present already.
 139
 140               ppm> repo add http://bioperl.org/DIST
 141               ppm> repo add uwinnipeg
 142               ppm> repo add trouchelle
 143
 144            Because you have installed PPM-Repositories, PPM will know
 145            your Perl version, and select the correct repo from the
 146            table above.
 147
 148      5) Install BioPerl (not "bioperl").
 149
 150               ppm> install BioPerl
 151
 152
 153 5 Installation using CPAN or manual installation
 154
 155 When using ActivePerl, installation using PPM is preferred since it is
 156 easier, but if you run into problems, or a PPM isn't available for the
 157 latest version/package of BioPerl, or you want to choose which optional
 158 dependencies to install, you can install manually by downloading the
 159 appropriate package or by using CPAN (installation using CPAN will always
 160 get you the latest version). Both manual methods ultimately need an
 161 accessory compiling program like MinGW, which incorporates the necessary
 162 tools like dmake and gcc. MinGW comes by default with Strawberry Perl, but
 163 must be installed through PPM for ActivePerl. Also CPAN neeed to be upgraded
 164 to >= v1.81, Module::Build to be installed (>= v0.2805) and Test::Harness to
 165 be upgraded to >= v2.62:
 166
 167 Dmake for ActivePerl
 168
 169            1) Install MinGW package through PPM: Using a cmd window type
 170            'ppm install MinGW' for 32bits Windows or 'ppm install MinGW64' for
 171            64bits Windows. Is IMPORTANT to check previously if ActiveState
 172            provides the MinGW package for your ActivePerl version. For example,
 173            although ActivePerl 5.18.2.1802 is currently available (May 2014),
 174            the download page point mainly at ActivePerl 5.16.3.1604, and the
 175            MinGW package is available for version 5.16 but NOT for version 5.18.
 176
 177 6 Beyond the Core
 178
 179 You may find that you want some of the features of other Bioperl packages
 180 like bioperl-run or bioperl-db. Check this by doing a Bioperl search in PPM.
 181 If these are not available, though, you can use the following instructions for
 182 installing the other distributions.
 183
 184 For bioperl-run, bioperl-db and bioperl-network v1.5.2 or higher you can use
 185 the PPD or CPAN installation instructions above. For other packages you will
 186 need nmake (see also the CPAN installation instructions), and a willingness
 187 to experiment. You'll have to read the installation documents for each
 188 component that you want to install, and use nmake where the instructions
 189 call for make, like so:
 190
 191     perl Makefile.PL
 192     nmake
 193     nmake test
 194     nmake install
 195
 196 7 Bioperl in Cygwin
 197
 198 Cygwin is a Unix emulator and shell environment available free at
 199 http://www.cygwin.com. It has been reported that Bioperl v. 1.* runs well
 200 within Cygwin, though the latest release has not been tested with Cygwin. Some
 201 users claim that installation of Bioperl is easier within Cygwin than
 202 within Windows, but these may be users with UNIX backgrounds. A note on
 203 Cygwin: it doesn't write to your Registry, it doesn't alter your system or
 204 your existing files in any way, it doesn't create partitions, it simply
 205 creates a cygwin/ directory and writes all of its files to that directory.
 206 To uninstall Cygwin just delete that directory.
 207
 208 To get Bioperl running first install the basic Cygwin package as well as
 209 the Cygwin `perl`, `make`, `binutils`, and `gcc` packages. Clicking the View
 210 button in the upper right of the installer window enables you to see
 211 details on the various packages. Then start up Cygwin and follow the
 212 Bioperl installation instructions for UNIX in Bioperl's INSTALL file.
 213
 214 Cygwin paths
 215
 216 If you're trying to use some application or resource outside of the Cygwin
 217 directory and you're having a problem remember that Cygwin's path syntax
 218 may not be the correct one. Cygwin understands */home/jacky* or
 219 */cygdrive/e/cygwin/home/jacky* (when referring to the E: drive) but the
 220 external resource may want *E:/cygwin/home/jacky*. So your *rc files may end
 221 up with paths written in these different syntaxes, depending.
 222
 223 For example, here's how to set the environmental variable TMPDIR, programs
 224 like BLAST and clustalw need a place to create temporary files:
 225
 226      setenv TMPDIR e:/cygwin/tmp    # csh, tcsh
 227      export TMPDIR=e:/cygwin/tmp    # sh, bash