Skip to content
/ nucamino Public

A nucleotide to amino acid alignment program optimized for virus gene sequences.

License

Notifications You must be signed in to change notification settings

hivdb/nucamino

Repository files navigation

NucAmino

Travis CI codecov donation

NucAmino is a nucleotide to amino acid alignment program optimized for virus gene sequences.

The paper: https://www.ncbi.nlm.nih.gov/pubmed/28249562

Compilation

NucAmino is a program written in Go programming language. You need to have Go installed to compile it. The installation of Go are varied in different systems or even in same system. Therefore, we introduced Docker to simplify the building process. You don't need to have a native Go installed if you have Docker.

The installation of Docker is very simple and it supports most modern operating systems like Linux, MacOS and even Windows. Please visit its website to retrieve installation packages for your system.

Once you installed Docker, just type this single command and you'll have a ready-for-use nucamino executable file under ./build folder:

make build

Note: Windows users need MinGW to run make commands.

Download Binaries

For convenience' sake, we provide pre-compiled executables for mainstream systems. These binary files can be found in release pages. The current release page is v0.1.3.

Usage

Once compiled or installed, you can use NucAmino to analyze virus sequences by using a command line program "nucamino". For now, we only support HIV pol sequences but more may be added in the future. The instruction of the command line tool can be retrieved by the following command:

Linux and MacOS:

./nucamino --help
./nucamino align hiv1b --help

Windows:

nucamino --help
nucamino align hiv1b --help

Donation

If you find NucAmino useful and wish to donate to the HIVDB team, you can do so through Stanford Make a Gift form. Your contribution will be greatly appreciated.