Skip to content

Commit f328594

Browse files
quickstart.md: updating ahead of v1.4.0 release.
1 parent 8ef4b91 commit f328594

File tree

1 file changed

+41
-22
lines changed

1 file changed

+41
-22
lines changed

docs/content/quickstart.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,19 @@ Installation
33

44
## Installation via conda
55

6-
Right now this is probably the easiest way. Dnmtools is among the
7-
bioconda recipes. If you know how to use conda and are setup to use
8-
bioconda, then you might simply be able to do:
6+
*Note (9/26/2023)* Although conda currently works, it seems that using
7+
`mamba` is more reliable. If you have `conda` installed, you can
8+
install mamba very easily by following instructions here:
9+
10+
https://anaconda.org/conda-forge/mamba
11+
12+
In the instructions below, replacing `conda` with `mamba` should work
13+
the same (and, in some cases, more reliably), but with mamba.
14+
15+
Right now conda is probably the easiest way to install
16+
dnmtools. Dnmtools is among the bioconda recipes. If you know how to
17+
use conda and are setup to use bioconda, then you might simply be able
18+
to do:
919
```console
1020
$ conda install dnmtools
1121
```
@@ -25,7 +35,6 @@ recommended by bioconda.
2535
* Bioconda: additional helpful setup instructions can be found
2636
[here](https://bioconda.github.io).
2737

28-
2938
If you encounter further problems, try creating a new environment for
3039
dnmtools within conda:
3140
```console
@@ -42,32 +51,35 @@ would need to be activated when you want to use dnmtools.
4251
### Required libraries
4352

4453
* A recent compiler: most users will be building and installing this
45-
software with GCC. We require a compiler that fully supports C++11,
46-
so we recommend using at least GCC 5.8. There are still many systems
47-
that install a very old version of GCC by default, so if you have
48-
problems with building this software, that might be the first thing
49-
to check.
54+
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
56+
still many systems that install a very old version of GCC by
57+
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.
5062
* The GNU Scientific Library: this has always been required. It can be
5163
installed using apt on Linux (Ubuntu, Debian), using brew on macOS,
5264
or from source available [here](http://www.gnu.org/software/gsl).
65+
* The HTSlib library, which can be installed through brew on macOS,
66+
through apt on Linux (Ubuntu, Debian), or from source downloadable
67+
[here](https://github.com/samtools/htslib).
5368
* The Zlib compression library: Most likely you already have this
5469
installed on your system. If not, it can be installed using apt on
5570
Linux (Ubuntu, Debian) through the package `zlib1g-dev`. On macOS,
5671
Zlib can be installed with brew.
57-
* The HTSlib library, which can be installed through brew on macOS,
58-
through apt on Linux (Ubuntu, Debian), or from source downloadable
59-
[here](https://github.com/samtools/htslib).
6072

6173
### Configuration
6274

63-
* Download [dnmtools-1.3.0.tar.gz](https://github.com/smithlabcode/dnmtools/releases/download/v1.3.0/dnmtools-1.3.0.tar.gz).
75+
* Download [dnmtools-1.4.0.tar.gz](https://github.com/smithlabcode/dnmtools/releases/download/v1.4.0/dnmtools-1.4.0.tar.gz).
6476
* Unpack the archive:
6577
```console
66-
$ tar -zxvf dnmtools-1.3.0.tar.gz
78+
$ tar -zxvf dnmtools-1.4.0.tar.gz
6779
```
6880
* Move into the dnmtools directory and create a build directory:
6981
```console
70-
$ cd dnmtools-1.3.0
82+
$ cd dnmtools-1.4.0
7183
$ mkdir build && cd build
7284
```
7385
* Run the configuration script:
@@ -109,16 +121,23 @@ any arguments and you should see the list of available commands:
109121
```console
110122
$ dnmtools
111123
```
124+
If you want to do more extensive tests, you can run:
125+
```console
126+
$ make check
127+
```
128+
from the directory where you run `make`. This will to several tests of
129+
various commands within `dnmtools`, and might take some time.
112130

113131
## Using a clone of the repo
114132

115-
Not recommended, but if you want to do it this way, we assume you know
116-
what you are doing. We strongly recommend using dnmtools through the
117-
latest stable release under the releases section on GitHub. Developers
118-
who wish to work on the latest commits, which are unstable, can
119-
compile the source using the `Makefile` available in the root of the
120-
source tree. If HTSLib and other libraries are available system-wide,
121-
compile by running:
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
137+
under 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:
122141
```console
123142
$ make
124143
```

0 commit comments

Comments
 (0)