Skip to content

Commit d1cbd0a

Browse files
committed
Merge branch 'main' of https://github.com/theLongLab/CATE into main
2 parents 6231370 + e1b2a43 commit d1cbd0a

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ Apollo also comes with a video tutorial. You can either download and watch it us
6161

6262
![C/C++ CUDA CI](https://github.com/theLongLab/CATE/actions/workflows/c-cpp.yml/badge.svg?event=push)
6363

64-
CATE can be used **on-device** via **Ananconda** or by downloading and building the **GitHub** repo. It can also be used **online** via **Google Colab**.
64+
CATE can be used **on-device** via **Anaconda** or by downloading and building the **GitHub** repo. It can also be used **online** via **Google Colab**.
6565

66-
For the **Google Colab** notebook please follow the link to [CATE on Colab](https://colab.research.google.com/drive/1p8I2umE1U2gEB95eKwg0-fdtOLbgR13-?usp=sharing).
66+
For the **Google Colab** notebook, please follow the link to [CATE on Colab](https://colab.research.google.com/drive/1p8I2umE1U2gEB95eKwg0-fdtOLbgR13-?usp=sharing).
6767

6868
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/theLongLab/CATE/blob/main/Colab_CATE/CATE_on_Colab.ipynb)
6969

@@ -77,15 +77,15 @@ To install CATE via [**Anaconda**](https://anaconda.org/deshan_CATE/cate):
7777
````
7878
conda install deshan_cate::cate
7979
````
80-
To ensure successful installation run the following:
80+
To ensure a successful installation, run the following:
8181
````
8282
CATE -h
8383
````
8484
**To note:** The conda install, by default, will __not install the latest gcc compiler__ for system stability reasons. If you get a libgcc error, please use the command below to install conda's libgcc and run the above CATE install.
8585
```
8686
conda install -c conda-forge libgcc
8787
```
88-
Else, if you want to install CATE **on-device** using the GitHub repo you might have to compile the code using an nvcc compiler. If so execute the following on the terminal:
88+
Else, if you want to install CATE **on-device** using the GitHub repo, you might have to compile the code using an nvcc compiler. If so, execute the following on the terminal:
8989

9090
Download the repository:
9191
````
@@ -103,7 +103,7 @@ Finally, compile the project:
103103
````
104104
nvcc -std=c++17 *.cu *.cpp -o "CATE"
105105
````
106-
To ensure successful installation try running the following:
106+
To ensure a successful installation, try running the following:
107107
````
108108
CATE -h
109109
````
@@ -124,7 +124,7 @@ The six tests on evolution are:
124124
5. Fixation Index
125125
6. Extended Haplotype Homozygosity
126126

127-
CATE comes equipped with Apollo, our viral simulator that spans from network level to individual virion resolution complete with within-host dynamics. Apollo comes with its main simulation function and five additional utility tools.
127+
CATE comes equipped with Apollo, our viral simulator that spans from network level to individual virion resolution, complete with within-host dynamics. Apollo comes with its main simulation function and five additional utility tools.
128128

129129
1. _Apollo simulator_
130130
2. Haplotype retriever
@@ -138,7 +138,7 @@ CATE comes equipped with Apollo, our viral simulator that spans from network lev
138138
Currently, the program's executable is called:
139139
>Test_Main
140140
141-
To run the software you need a JSON-style parameters file. An example is provided above:
141+
To run the software, you need a JSON-style parameters file. An example is provided above:
142142

143143
> *parameters.json*.
144144
@@ -153,7 +153,7 @@ __Example:__
153153

154154
>./Test_Main -t parameters.json
155155
156-
The __HELP__ menu will list all available functions and how each function can be executed. It can be accessed by simply typing -h as the function as shown below:
156+
The __HELP__ menu will list all available functions and how each can be executed. It can be accessed by simply typing -h as the function, as shown below:
157157

158158
> ./Test_Main -h
159159
@@ -164,7 +164,7 @@ The __HELP__ menu will list all available functions and how each function can be
164164

165165
**CATE** has been successfully published in the journal Methods in Ecology and Evolution (MEE). If you find this framework or the software solution useful in your analyses, please CITE the published article available in [MEE, CATE: A fast and scalable CUDA implementation to conduct highly parallelized evolutionary tests on large scale genomic data](https://doi.org/10.1111/2041-210X.14168).
166166

167-
To cite CATE's code please use the Zenodo release:
167+
To cite CATE's code, please use the Zenodo release:
168168

169169
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7987769.svg)](https://doi.org/10.5281/zenodo.7987769)
170170

@@ -177,24 +177,24 @@ Methods in Ecology and Evolution, 00, 1–15.
177177

178178
[![Static Badge](https://img.shields.io/badge/DOI-Methods%20in%20Ecology%20and%20Evolution-%23db0f14)](https://doi.org/10.1111/2041-210X.14168)
179179

180-
**Apollo** is currently being submitted for review. Its preprint is available on *bioRxiv* and the citation details are as follows:
180+
**Apollo** is currently being submitted for review. Its preprint is available on *bioRxiv*, and the citation details are as follows:
181181

182182
Apollo: A comprehensive GPU-powered within-host simulator for viral evolution and infection dynamics across population, tissue, and cell
183183
Deshan Perera, Evan Li, Frank van der Meer, Tarah Lynch, John Gill, Deirdre L Church, Christian D. Huber, Guido van Marle, Alexander Platt, Quan Long
184184
bioRxiv 2024.10.07.617101; [doi: https://doi.org/10.1101/2024.10.07.617101](https://doi.org/10.1101/2024.10.07.617101)
185185

186186
[![Static Badge](https://img.shields.io/badge/preprint-bioRxiv-black?labelColor=black&color=%23bc2232)](https://doi.org/10.1101/2024.10.07.617101)
187187

188-
To cite CATE's code with Apollo's integration please cite the Zenodo release:
188+
To cite CATE's code with Apollo's integration, please cite the Zenodo release:
189189

190-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15299962.svg)](https://doi.org/10.5281/zenodo.15299962)
190+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15391841.svg)](https://doi.org/10.5281/zenodo.15391841)
191191

192192
[_Return to contents_](#contents)
193193

194194
---
195195
#### Contact
196196

197-
1. For **CATE** please address your correspondence to:
197+
1. For **CATE**, please address your correspondence to:
198198

199199
Dr. **Deshan** Perera (duwagedahampriyabala@ucalgary.ca)
200200

0 commit comments

Comments
 (0)