From Genome Analysis Wiki
Jump to navigationJump to search
2,745 bytes removed
, 10:30, 9 September 2011
| Line 9: |
Line 9: |
| | | | |
| | == Where to Find It == | | == Where to Find It == |
| − | The bamUtil repository is available both via release downloads (coming soon) and via github.
| + | {{ToolGitRepo|repoName=bamUtil|exe=bam}} |
| − | | |
| − | On github, you can both browse and download the latest version of the repository as well as explore the history of changes.
| |
| − | | |
| − | You can access the latest version with or without git.
| |
| − | | |
| − | If you download from github or use git to keep up to date, you also need to download our library: [[C++ Library: libStatGen|libStatGen]].
| |
| − | | |
| − | The releases will be available both with and without libStatGen included. If you download the verison without libStatGen included, you will also need to download libStatGen separately.
| |
| − | (It will be available without libStatGen in case you already have a downloaded version of libStatGen that you want to use.
| |
| − | | |
| − | === Releases ===
| |
| − | Release downloads are '''Coming Soon'''.
| |
| − | | |
| − | | |
| − | === Using github ===
| |
| − | | |
| − | ==== Using Git To Track the Current Development Version ====
| |
| − | | |
| − | ===== Clone (get your own copy) =====
| |
| − | You can create your own git clone (copy) using:
| |
| − | git clone https://github.com/statgen/bamUtil.git
| |
| − | or
| |
| − | git clone git://github.com/statgen/bamUtil.git
| |
| − | | |
| − | Either of these commands create a directory called <code>bamUtil</code> in the current directory.
| |
| − | | |
| − | Then just <code>cd bamUtil</code> and [[BamUtil#Building|compile]].
| |
| − | | |
| − | ===== Get the latest Updates (update your copy) =====
| |
| − | To update your copy to the latest version (a major advantage of using git):
| |
| − | # <code>cd pathToYourCopy/bamUtil</code>
| |
| − | # <code>make clean</code>
| |
| − | # <code>git pull</code>
| |
| − | # <code>make all</code>
| |
| − | | |
| − | === Git Refresher ===
| |
| − | If you decide to use git, but need a refresher, see [[How To Use Git]] or [https://statgen.sph.umich.edu/wiki/How_To_Use_Git Notes on how to use git] (if you have access)
| |
| − | | |
| − | | |
| − | ==== Downloading From GitHub Without Git ====
| |
| − | Periodically download the latest copy from github from the "Downloads" link on the webpage: https://github.com/statgen/bamUtil/archives/master.
| |
| − | | |
| − | The downloaded tar file is named "statgen-bamUtil-someHexNumber.tar.gz". The directory created when it is untared shares the same base name. I recommend that you do not change the name of the directory. If you want one called bamUtil, create a link to this directory. The hex number in the directory name identifies the version of the repository that you downloaded and is necessary to easily troubleshoot any issues you encounter. If you must rename the directory, be sure to record the hex number that was on the download for future reference.
| |
| − | | |
| − | == Building ==
| |
| − | After obtaining the bamUtil repository (either by download or from github), compile the code using <code>make all</code>. This creates the executable, <code>bam</code>, in the <code>bamUtil/bin/</code> directory, the debug executable in the <code>bamUtil/bin/debug/</code> directory, and the profiling executable in the <code>bamUtil/bin/profile/</code> directory.
| |
| − | | |
| − | | |
| | | | |
| | = Programs = | | = Programs = |
