Difference between revisions of "Template:ToolGitRepo"
m |
|||
(27 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | The {{{repoName}}} repository is available both via release downloads and via github. | + | {{#if: {{{noDownload|}}} | | The {{{repoName}}} repository is available both via [[#Releases|release downloads]] and via github.}} |
− | On github, you can both browse and download the | + | On github, https://github.com/statgen/{{{repoName}}}, you can both browse and download the {{{repoName}}} source code as well as explore the history of changes. |
− | You can | + | You can obtain the source either with or without git. |
− | + | {{#if: {{{nolibStatGen|}}} | | | |
+ | {{#if: {{{libStatGen|}}} | A copy of libStatGen is included in certain releases of some statgen tools. | | ||
+ | The releases may be available both with and without libStatGen included. | ||
− | + | If you do not use the release version that already contains libStatGen, you need to download the library: [[C++ Library: libStatGen|libStatGen]]. | |
− | |||
− | + | If you try to compile {{{repoName}}} and it cannot find libStatGen, it will fail and provide instructions of what to do next: | |
− | + | * if libStatGen is in a different location then expected | |
+ | ** follow the directions to set the path to libStatGen | ||
+ | * if libStatGen is not downloaded and you have git | ||
+ | ** <code>make libStatGen</code> will download via git and build libStatGen | ||
+ | * if libStatGen is not downloaded and you don't have git | ||
+ | ** See [[C++ Library: libStatGen|libStatGen]] | ||
+ | }} | ||
+ | }} | ||
+ | === Using Git To Track the Current Development Version === | ||
− | + | ==== Clone (get your own copy) ==== | |
− | |||
− | |||
− | |||
− | |||
You can create your own git clone (copy) using: | You can create your own git clone (copy) using: | ||
git clone https://github.com/statgen/{{{repoName}}}.git | git clone https://github.com/statgen/{{{repoName}}}.git | ||
Line 28: | Line 33: | ||
Then just <code>cd {{{repoName}}}</code> and [[#Building|compile]]. | Then just <code>cd {{{repoName}}}</code> and [[#Building|compile]]. | ||
− | + | ==== Get the latest Updates (update your copy) ==== | |
To update your copy to the latest version (a major advantage of using git): | To update your copy to the latest version (a major advantage of using git): | ||
# <code>cd pathToYourCopy/{{{repoName}}}</code> | # <code>cd pathToYourCopy/{{{repoName}}}</code> | ||
Line 35: | Line 40: | ||
# <code>make all</code> | # <code>make all</code> | ||
− | === Git Refresher === | + | ==== 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) | 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 === | |
− | + | If you download the latest code/version, make sure you periodically update it by downloading a newer version. | |
− | + | From github you can download: | |
+ | # Latest Code (master branch) | ||
+ | #: via Website | ||
+ | #:# Goto: https://github.com/statgen/{{{repoName}}} | ||
+ | #:# Click on the <code>Download ZIP</code> button on the right side panel. | ||
+ | #: via Command Line | ||
+ | #:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/master.tar.gz</code> | ||
+ | #::: or | ||
+ | #:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/master.zip</code> | ||
+ | # Specific Release (via a tag) | ||
+ | #: via Website | ||
+ | #:# Goto: https://github.com/statgen/{{{repoName}}}/releases to see the available releases | ||
+ | #:# Click <code>zip</code> or <code>tar.gz</code> for the desired version. | ||
+ | #: via Command Line | ||
+ | #:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.tar.gz</code> | ||
+ | #::: or | ||
+ | #:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.zip</code> | ||
+ | {{#if: {{{latestReleaseBranch|}}} | | ||
+ | #Latest Release (via a branch) | ||
+ | #: via Website | ||
+ | #:# Goto: https://github.com/statgen/{{{repoName}}}/tree/{{{latestReleaseBranch}}} to see the latest release | ||
+ | #:# Click on the <code>Download ZIP</code> button on the right side panel. | ||
+ | #: via Command Line | ||
+ | #:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/{{{latestReleaseBranch}}}.tar.gz</code> | ||
+ | #::: or | ||
+ | #:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/{{{latestReleaseBranch}}}.zip</code> | ||
+ | }} | ||
+ | After downloading the file, uncompress (unzip/untar) it. The directory created will be named <code>{{{repoName}}}-<name of version you downloaded></code>. | ||
+ | |||
+ | {{#if: {{{skipBuild|}}}|| | ||
== Building == | == Building == | ||
− | After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using <code>make all</code>. | + | After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using: |
+ | <code>make all</code> | ||
+ | |||
+ | Object (.o) files are compiled into the <code>obj</code> directory with a subdirectory <code>debug</code> and <code>profile</code> for the debugging and profiling objects. | ||
+ | |||
+ | {{#if: {{{libBaseName|}}}| | ||
+ | This creates the libraries, {{{libBaseName}}}.a, {{{libBaseName}}}_debug.a, {{{libBaseName}}}_profile.a at the top level directory. | ||
+ | | | ||
+ | This creates the executable(s) in the <code>{{{repoName}}}/bin/</code> directory, the debug executable(s) in the <code>{{{repoName}}}/bin/debug/</code> directory, and the profiling executable(s) in the <code>{{{repoName}}}/bin/profile/</code> directory. | ||
+ | |||
+ | <code>make install</code> installs the opt binary if you have permission. | ||
+ | }} | ||
+ | |||
+ | <code>make test</code> compiles for opt, debug, and profile and runs the tests (found in the <code>test</code> subdirectory). | ||
+ | |||
+ | To see all make options, type <code>make help</code>. | ||
+ | }} | ||
+ | |||
+ | |||
+ | If compilation fails due to warnings being treated as errors, please contact us so we can fix the warnings. As a work-around to get it to compile, you can disable the treatment of warnings as errors by editing libStatGen/general/Makefile to remove <code>-Werror</code>. |
Latest revision as of 00:18, 13 November 2017
The {{{repoName}}} repository is available both via release downloads and via github.
On github, https://github.com/statgen/{{{repoName}}}, you can both browse and download the {{{repoName}}} source code as well as explore the history of changes.
You can obtain the source either with or without git.
The releases may be available both with and without libStatGen included.
If you do not use the release version that already contains libStatGen, you need to download the library: libStatGen.
If you try to compile {{{repoName}}} and it cannot find libStatGen, it will fail and provide instructions of what to do next:
- if libStatGen is in a different location then expected
- follow the directions to set the path to libStatGen
- if libStatGen is not downloaded and you have git
make libStatGen
will download via git and build libStatGen
- if libStatGen is not downloaded and you don't have git
- See libStatGen
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/{{{repoName}}}.git
or
git clone git://github.com/statgen/{{{repoName}}}.git
Either of these commands create a directory called {{{repoName}}}
in the current directory.
Then just cd {{{repoName}}}
and compile.
Get the latest Updates (update your copy)
To update your copy to the latest version (a major advantage of using git):
cd pathToYourCopy/{{{repoName}}}
make clean
git pull
make all
Git Refresher
If you decide to use git, but need a refresher, see How To Use Git or Notes on how to use git (if you have access)
Downloading From GitHub Without Git
If you download the latest code/version, make sure you periodically update it by downloading a newer version.
From github you can download:
- Latest Code (master branch)
- via Website
- Goto: https://github.com/statgen/{{{repoName}}}
- Click on the
Download ZIP
button on the right side panel.
- via Command Line
- via Website
- Specific Release (via a tag)
- via Website
- Goto: https://github.com/statgen/{{{repoName}}}/releases to see the available releases
- Click
zip
ortar.gz
for the desired version.
- via Command Line
wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.tar.gz
- or
wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.zip
- via Website
After downloading the file, uncompress (unzip/untar) it. The directory created will be named {{{repoName}}}-<name of version you downloaded>
.
Building
After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using:
make all
Object (.o) files are compiled into the obj
directory with a subdirectory debug
and profile
for the debugging and profiling objects.
This creates the executable(s) in the {{{repoName}}}/bin/
directory, the debug executable(s) in the {{{repoName}}}/bin/debug/
directory, and the profiling executable(s) in the {{{repoName}}}/bin/profile/
directory.
make install
installs the opt binary if you have permission.
make test
compiles for opt, debug, and profile and runs the tests (found in the test
subdirectory).
To see all make options, type make help
.
If compilation fails due to warnings being treated as errors, please contact us so we can fix the warnings. As a work-around to get it to compile, you can disable the treatment of warnings as errors by editing libStatGen/general/Makefile to remove -Werror
.