Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
M. Boemo committed Jul 23, 2024
1 parent 884bef1 commit 93d4558
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,6 @@ src/softwarepath.h
#plots
*.png
*.pdf

#images
*.sif
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,26 @@

DNAscent is software designed to detect the base analogues BrdU and EdU in single molecules of DNA sequenced on the Oxford Nanopore platform. In an experimental setup where BrdU and EdU are incorporated into nascent DNA by replication forks, this software can be used to answer questions that were traditionally answered by DNA fibre analysis. DNAscent can also call the genomic positions of stalled and stressed replication forks for use as a replication stress assay.

DNAscent v4.0.1 supports sequencing data collected on Oxford Nanopore R10.4.1 flow cells. The Oxford Nanopore Flongle, MinION, GridION, and PromethION platforms are all supported.
DNAscent v4.0.2 supports sequencing data collected on Oxford Nanopore R10.4.1 flow cells. The Oxford Nanopore Flongle, MinION, GridION, and PromethION platforms are all supported.

DNAscent is under active development by the [Boemo Group](https://www.boemogroup.org/) based in the [Department of Pathology, University of Cambridge](https://www.path.cam.ac.uk/).

## Downloading and Compiling DNAscent
## Singularity Image
The recommended way to run DNAscent is via one of our supported Singularity images: https://cloud.sylabs.io/library/mboemo/dnascent/dnascent
You can obtain the latest image by running:
```shell
singularity pull DNAscent.sif library://mboemo/dnascent/dnascent:4.0.2
```

## Building from Source
Clone the DNAscent repository with the recursive flag so that the dependencies are cloned as well.
```shell
git clone --recursive https://github.com/MBoemo/DNAscent.git
```
The DNAscent directory will appear in your current directory. Switch to the latest tagged version and compile the software by running:
```shell
cd DNAscent
git checkout 4.0.1
git checkout 4.0.2
make
```
This will put the DNAscent executable into the DNAscent/bin directory. A typical compile time for DNAscent and its dependencies is 5 minutes.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We recommend running DNAscent using one of our supported Singularity images. The

.. code-block:: console
singularity pull DNAscent.sif library://mboemo/DNAscent/DNAscent:4.0.2
singularity pull DNAscent.sif library://mboemo/dnascent/dnascent:4.0.2
You can run DNAscent from the image by passing the desired executable and arguments. The following example shows how to run DNAscent :ref:`detect`:

Expand Down

0 comments on commit 93d4558

Please sign in to comment.