-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jeremiah Wala
committed
May 15, 2015
1 parent
ca97c7f
commit 7e63a87
Showing
192 changed files
with
66,877 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
Basic Installation | ||
================== | ||
|
||
To build and install HTSlib, 'cd' to the htslib-1.x directory containing | ||
the package's source and type the following commands: | ||
|
||
./configure | ||
make | ||
make install | ||
|
||
The './configure' command checks your build environment and allows various | ||
optional functionality to be enabled (see Configuration below). If you | ||
don't want to select any optional functionality, you may wish to omit | ||
configure and just type 'make; make install' as for previous versions | ||
of HTSlib. However if the build fails you should run './configure' as | ||
it can diagnose the common reasons for build failures. | ||
|
||
The 'make' command builds the HTSlib library and and various useful | ||
utilities: bgzip, htsfile, and tabix. If compilation fails you should | ||
run './configure' as it can diagnose problems with your build environment | ||
that cause build failures. | ||
|
||
The 'make install' command installs the libraries, library header files, | ||
utilities, several manual pages, and a pkgconfig file to /usr/local. | ||
The installation location can be changed by configuring with --prefix=DIR | ||
or via 'make prefix=DIR install' (see Installation Locations below). | ||
|
||
|
||
Configuration | ||
============= | ||
|
||
By default, './configure' examines your build environment, checking for | ||
requirements such as the zlib development files, and arranges for a plain | ||
HTSlib build. The following configure options can be used to enable | ||
various features and specify further optional external requirements: | ||
|
||
--with-irods[=DIR] | ||
Specifies the location of the iRODS client library to use to enable | ||
access to data objects stored in iRODS (<http://irods.org/>) via file | ||
paths like 'irods:DATAOBJ'. DIR is the base of an iRODS source tree | ||
such that the library is present as DIR/lib/core/obj/libRodsAPI.* and | ||
headers are present under DIR/lib/api/include and so on. If '=DIR' is | ||
omitted, $IRODS_HOME will be used as a base directory. | ||
|
||
The configure script also accepts the usual options and environment variables | ||
for tuning installation locations and compilers: type './configure --help' | ||
for details. For example, | ||
|
||
./configure CC=icc --prefix=/opt/icc-compiled | ||
|
||
would specify that HTSlib is to be built with icc and installed into bin, | ||
lib, etc subdirectories under /opt/icc-compiled. | ||
|
||
|
||
Installation Locations | ||
====================== | ||
|
||
By default, 'make install' installs HTSlib libraries under /usr/local/lib, | ||
HTSlib header files under /usr/local/include, utility programs under | ||
/usr/local/bin, etc. (To be precise, the header files are installed within | ||
a fixed 'htslib' subdirectory under the specified .../include location.) | ||
|
||
You can specify a different location to install HTSlib by configuring | ||
with --prefix=DIR or specify locations for particular parts of HTSlib by | ||
configuring with --libdir=DIR and so on. Type './configure --help' for | ||
the full list of such install directory options. | ||
|
||
Alternatively you can specify different locations at install time by | ||
typing 'make prefix=DIR install' or 'make libdir=DIR install' and so on. | ||
Consult the list of prefix/exec_prefix/etc variables near the top of the | ||
Makefile for the full list of such variables that can be overridden. | ||
|
||
You can also specify a staging area by typing 'make DESTDIR=DIR install', | ||
possibly in conjunction with other --prefix or prefix=DIR settings. | ||
For example, | ||
|
||
make DESTDIR=/tmp/staging prefix=/opt | ||
|
||
would install into bin, lib, etc subdirectories under /tmp/staging/opt. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
[Files in this distribution outwith the cram/ subdirectory are distributed | ||
according to the terms of the following MIT/Expat license.] | ||
|
||
The MIT/Expat License | ||
|
||
Copyright (C) 2012-2014 Genome Research Ltd. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | ||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
DEALINGS IN THE SOFTWARE. | ||
|
||
|
||
[Files within the cram/ subdirectory in this distribution are distributed | ||
according to the terms of the following Modified 3-Clause BSD license.] | ||
|
||
The Modified-BSD License | ||
|
||
Copyright (C) 2012-2014 Genome Research Ltd. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, | ||
this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
3. Neither the names Genome Research Ltd and Wellcome Trust Sanger Institute | ||
nor the names of its contributors may be used to endorse or promote products | ||
derived from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY GENOME RESEARCH LTD AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL GENOME RESEARCH LTD OR ITS CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
||
|
||
[The use of a range of years within a copyright notice in this distribution | ||
should be interpreted as being equivalent to a list of years including the | ||
first and last year specified and all consecutive years between them. | ||
|
||
For example, a copyright notice that reads "Copyright (C) 2005, 2007-2009, | ||
2011-2012" should be interpreted as being identical to a notice that reads | ||
"Copyright (C) 2005, 2007, 2008, 2009, 2011, 2012" and a copyright notice | ||
that reads "Copyright (C) 2005-2012" should be interpreted as being identical | ||
to a notice that reads "Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, | ||
2011, 2012".] |
Oops, something went wrong.