You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 12, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+38-18Lines changed: 38 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,21 +57,18 @@ The revision history of the library is [here](REVISION_HISTORY.md). The documen
57
57
58
58
### Obtaining the master branch
59
59
You have a few options:
60
-
<ol>
61
-
<li> Clone the repo (best option): git clone https://github.com/molpopgen/libsequence.git</li>
62
-
<li> Click on "Download Zip" at https://github.com/molpopgen/libsequence </li>
63
-
</ol>
60
+
61
+
* Clone the repo (best option): git clone https://github.com/molpopgen/libsequence.git
62
+
* Click on "Download Zip" at https://github.com/molpopgen/libsequence
63
+
64
64
65
65
### Obtaining a specific release
66
66
Again, a few options:
67
-
<ol>
68
-
<li> Click on "Releases" at https://github.com/molpopgen/libsequence, then download the one you want </li>
69
-
<li> Clone the repo (see previous section)</li>
70
-
<ol>
71
-
<li> Get a list of releases by saying "git tag -l" </li>
72
-
<li> Checkout the release you want. For example "git checkout 1.8.0"</li>
73
-
</ol>
74
-
</ol>
67
+
68
+
* Click on "Releases" at https://github.com/molpopgen/libsequence, then download the one you want
69
+
* Clone the repo (see previous section)
70
+
* Get a list of releases by saying "git tag -l"
71
+
* Checkout the release you want. For example "git checkout 1.8.0"
75
72
76
73
## Installation
77
74
@@ -109,6 +106,24 @@ make
109
106
sudo make install
110
107
~~~
111
108
109
+
The build conditions can be adjusted via the usual environment variables. To compile an optimized "release" build:
110
+
111
+
~~~
112
+
./configure CXXFLAGS="-O3 -DNDEBUG"
113
+
~~~
114
+
115
+
To compile a debugger-friendly build:
116
+
117
+
~~~
118
+
./configure CXXFLAGS="-O0 -g"
119
+
~~~
120
+
121
+
To change the compiler, set the C and C++ compiler variables:
122
+
123
+
~~~
124
+
./configure CC=gcc CXX=g++
125
+
~~~
126
+
112
127
#### Compiling unit tests and examples
113
128
114
129
To compile unit testing suite and example programs
@@ -136,13 +151,15 @@ cd test && sh runTests.sh
136
151
137
152
Some users may not have the dependent libraries installed in the standard locations on their systems. Note that "standard" means wherever the compiler system looks for header files during compilation and libraries during linking. This scenario is common on OS X systems where users have used some sort of "system" to install various libraries rather than installing from source directly. In order to accomodate such situations, the user must provide the correct path to the include and lib directories. For example, assume that the dependend libraries are in /opt on your system. You would install libsequence as follows:
Note that the modification of LDFLAGS prepends the current value of LDFLAGS if it exists. This allows for scenarios where the system's search path for libraries may have been modified by the user or sysadmin via a modification of that shell variable. (One could also do the same with CXXFLAGS, FYI.)
162
+
Note that the modification of LDFLAGS prepends the current value of LDFLAGS if it exists. This allows for scenarios where the system's search path for libraries may have been modified by the user or sysadmin via a modification of that shell variable. (One could also do the same with CPPFLAGS, FYI.)
146
163
147
164
### Installing libsequence locally
148
165
@@ -152,15 +169,18 @@ If you do not have permission to "sudo make install", you can install the librar
152
169
153
170
Then, when compiling any program using libsequence, you need to add
154
171
155
-
> -I$HOME/include
156
-
172
+
~~~
173
+
-I$HOME/include
174
+
~~~
157
175
to any compilation commands and
158
176
159
-
> -L$HOME/lib
177
+
~~~
178
+
-L$HOME/lib
179
+
~~~
160
180
161
181
to any linking commands.
162
182
163
-
When running programs linking to any of the above run-time libraries, and depending on your system, you may also need to adjust variables like LD _ LIBRARY _ PATH to prepend $HOME/lib to them, etc., but you'll need to figure that out on case-by-case basis, as different systems can behave quite differently.
183
+
When running programs linking to any of the above run-time libraries, and depending on your system, you may also need to adjust variables like LD_LIBRARY_PATH to prepend $HOME/lib to them, etc., but you'll need to figure that out on case-by-case basis, as different systems can behave quite differently.
164
184
165
185
### Another installation option (not supported by the libsequence author)
Copy file name to clipboardExpand all lines: REVISION_HISTORY.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
This document lists major changes between tags/releases of libsequence. The following caveat is important:
6
6
7
-
If you see a section below referring to libseqeunce version X, and no version X exists as a release, then you must consider the info here inaccurate. In such cases, the list of changes may refer to planned changes for a future release which may or may not be implemented yet in either the master or some development branch.
7
+
If you see a section below referring to libsequence version X, and no version X exists as a release, then you must consider the info here inaccurate. In such cases, the list of changes may refer to planned changes for a future release which may or may not be implemented yet in either the master or some development branch.
8
8
9
9
## Moving towards a "2.0" release: ABI compatibility in flux
10
10
@@ -30,6 +30,11 @@ However:
30
30
31
31
1. Sequence/SeqRegexes.hpp -- not working. This will not be fixed until GCC supports <regex>. The function is now currently implemented in a non-regex manner, which is lame, but it works.
32
32
33
+
## libsequence 1.9.1
34
+
35
+
* Sequence::SeqException was removed. Exceptions from namespace std are preferred, and are easier to wrap in other languages.
36
+
* Sequence::PolySNP::ThetaL throws exception if outrgroup not present
37
+
33
38
## libsequence 1.9.0
34
39
35
40
* Fixed issues with Sequence::Comeron95 that made it impossible to allocate on the stack.
0 commit comments