Changes

From Genome Analysis Wiki
Jump to navigationJump to search
1,487 bytes added ,  16:33, 23 August 2011
no edit summary
Line 34: Line 34:  
libStatGen can be found at: [https://github.com/statgen/libStatGen https://github.com/statgen/libStatGen]
 
libStatGen can be found at: [https://github.com/statgen/libStatGen https://github.com/statgen/libStatGen]
   −
You can both browse and download the library at that address.
+
libStatGen can also be found within certain releases of statgen tools.  The tools will have a release version that also includes a copy of libStatGen.
 +
 
 +
 
 +
On github, you can both browse and download the latest version of the library, as well as explore the history of changes.
   −
This is also a git repository. You can create your own git clone from this location:
+
You can access the latest version with or without using git.
 +
 
 +
== 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/libStatGen.git
 
  git clone https://github.com/statgen/libStatGen.git
 
or
 
or
Line 43: Line 51:  
Either of these commands create a directory called <code>libStatGen</code> in the current directory.
 
Either of these commands create a directory called <code>libStatGen</code> in the current directory.
    +
Then just <code>cd libStatGen</code> and [[C++ Library: libStatGen#Building the Library|compile the library]].
 +
 +
=== Get the latest Updates (update your copy) ===
 +
To update your copy to the latest version (a major advantage of using git):
 +
# <code>cd pathToYourCopy/libStatGen</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)
 
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)
   −
libStatGen can also be found within certain releases of statgen tools.  The tools will have a release version that also includes a copy of libStatGen.
+
 
 +
== Getting the Latest Development Version without Using Git ==
 +
Periodically download the latest copy from github from the "Downloads" link on the webpage or [https://github.com/statgen/libStatGen/archives/master https://github.com/statgen/libStatGen/archives/master]. 
 +
 
 +
The downloaded tar file is named "statgen-libStatGen-''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 libStatGen, create a link to this directory.  The hex number in the directory name identifies the version of the library 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.
 +
 
 +
 
 +
== Released Versions ==
 +
Released Versions are documented at [[libStatGen Download]]
 +
 
    
= What has changed =
 
= What has changed =
 
The <code>pipeline</code> and <code>statgen</code> repositories have been deprecated, so please update to our new framework.
 
The <code>pipeline</code> and <code>statgen</code> repositories have been deprecated, so please update to our new framework.
   −
libStatGen is the new git repository for our library code.   
+
<code>libStatGen</code> is the new git repository for our library code.   
    
There are now separate repositories for specific tools/groups of tools, allowing us to track everything separately so it is easier to follow changes that impact a specific tool or the library in general.
 
There are now separate repositories for specific tools/groups of tools, allowing us to track everything separately so it is easier to follow changes that impact a specific tool or the library in general.

Navigation menu