@@ -50,19 +50,17 @@ would need to be activated when you want to use dnmtools.
5050
5151### Required libraries
5252
53- * A recent compiler: most users will be building and installing this
53+ * A recent compiler. Most users will be building and installing this
5454 software with GCC. We require a compiler that fully supports C++17,
55- so we recommend using at least GCC 8 (released in 2018 ). There are
55+ so we recommend using at least GCC 9 (released in 2019 ). There are
5656 still many systems that install a very old version of GCC by
5757 default, so if you have problems with building this software, that
58- might be the first thing to check. On macOS and Ubuntu/Debian
59- systems, the brew and apt package managers can get you a recent
60- compiler easily. Any cluster or high-performance computing
61- environment should give you access to a recent compiler.
62- * The GNU Scientific Library: this has always been required. It can be
63- installed using apt on Linux (Ubuntu, Debian), using brew on macOS,
64- or from source available [ here] ( http://www.gnu.org/software/gsl ) .
65- * The HTSlib library, which can be installed through brew on macOS,
58+ might be the first thing to check. The clang LLVM compiler can
59+ also be used with a recent enough version.
60+ * The GNU Scientific Library. It can be installed using apt on Linux
61+ (Ubuntu, Debian), using brew on macOS, or from source available
62+ [ here] ( http://www.gnu.org/software/gsl ) .
63+ * The HTSlib library. This can be installed through brew on macOS,
6664 through apt on Linux (Ubuntu, Debian), or from source downloadable
6765 [ here] ( https://github.com/samtools/htslib ) .
6866* The Zlib compression library: Most likely you already have this
@@ -72,14 +70,14 @@ would need to be activated when you want to use dnmtools.
7270
7371### Configuration
7472
75- * Download [ dnmtools-1.4.2 .tar.gz] ( https://github.com/smithlabcode/dnmtools/releases/download/v1.4.2 /dnmtools-1.4.2 .tar.gz ) .
73+ * Download [ dnmtools-1.4.3 .tar.gz] ( https://github.com/smithlabcode/dnmtools/releases/download/v1.4.3 /dnmtools-1.4.3 .tar.gz ) .
7674* Unpack the archive:
7775``` console
78- $ tar -zxvf dnmtools-1.4.2 .tar.gz
76+ $ tar -zxvf dnmtools-1.4.3 .tar.gz
7977```
8078* Move into the dnmtools directory and create a build directory:
8179``` console
82- $ cd dnmtools-1.4.2
80+ $ cd dnmtools-1.4.3
8381$ mkdir build && cd build
8482```
8583* Run the configuration script:
@@ -119,25 +117,21 @@ $ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/path/to/htslib/lib
119117To test if everything was successful, simply run ` dnmtools ` without
120118any arguments and you should see the list of available commands:
121119``` console
122- $ dnmtools
120+ dnmtools
123121```
124- If you want to do more extensive tests, you can run:
122+ There is a test suite for ` dnmtools ` and these test can be performed
123+ as follows:
125124``` console
126- $ make check
125+ make check
127126```
128- from the directory where you run ` make ` . This will to several tests of
129- various commands within ` dnmtools ` , and might take some time.
127+ This must be done from the build directory. Note that the tests
128+ performed with ` make check ` are mostly regression tests that cover
129+ prior issues rather than coverage tests to test all the functionality
130+ of ` dnmtools ` .
130131
131132## Using a clone of the repo
132133
133- * This option is deprecated; we are no longer maintaining a Makefile
134- that is not generated by ` ./configure ` .* Not recommended, but if you
135- want to do it this way, we assume you know what you are doing. We
136- strongly recommend using dnmtools through the latest stable release
134+ We strongly recommend using dnmtools through the latest stable release
137135under the releases section on GitHub. Developers who wish to work on
138- the latest commits, which are unstable, can compile the source using
139- the ` Makefile ` available in the root of the source tree. If HTSLib and
140- other libraries are available system-wide, compile by running:
141- ``` console
142- $ make
143- ```
136+ the latest commits, which are unstable, can start the process using
137+ the ` autogen.sh ` script and then using the usual autotools approach.
0 commit comments