README.md

The Artemis Software

The Artemis Software is a set of software tools for genome browsing and annotation.

Contents

• Introduction
• Installation
• Usage
• Building
• License
• Documentation

Introduction

The Artemis Software includes:

• Artemis
• ACT
• BamView
• DNAPlotter

Artemis is a free genome browser and annotation tool that allows visualisation of sequence features, next generation data and the results of analyses within the context of the sequence, and also its six-frame translation. Artemis is written in Java, and is available for UNIX, Macintosh and Windows systems. It can read EMBL and GENBANK database entries or sequence in FASTA, indexed FASTA or raw format. Other sequence features can be in EMBL, GENBANK or GFF format.

ACT is a free tool for displaying pairwise comparisons between two or more DNA sequences. It can be used to identify and analyse regions of similarity and difference between genomes and to explore conservation of synteny, in the context of the entire sequences and their annotation.

DNAPlotter generates images of circular and linear DNA maps.

BamView is a standalone BAM/CRAM file viewer.

For further information, please see the Artemis GitHub page

Prerequisites

Java 9+ must be installed. Ideally Java 11.

Installation

Please refer to the relevant documentation in the Documentation section below.

Usage

Please refer to the relevant documentation in the Documentation section below.

Building

If you would prefer to build the applications from scratch rather than use the pre-built releases in GitHub, then you will firstly need the source code from GitHub. This can be obtained by cloning the repository:

git clone https://github.com/sanger-pathogens/Artemis.git

or by downloading the source zip file for a particular release. The latest version of Apache Maven (Java 11 compatible, e.g. v3.6.0) will need to be installed beforehand, in order to build. The application jars can be built by issuing the following commands in the top-level folder:

When building for the first time:

mvn validate

This is required to install some legacy libraries to the Maven repository and will be phased out in future releases.

And then to build/rebuild the applications :

mvn clean package

Clean is only required if you wish to do a complete rebuild. If you do not wish to run tests then add the -Dskip.tests=true flag to the above command.

Note that if you are running a build from behind a proxy you will need to add the proxy parameters to the mvn command line, e.g.

mvn -Dhttps.proxyHost=myproxyhost -Dhttps.proxyPort=myproxyport -DproxySet=true package

Searching and Using Local Sequence Databases

Artemis and ACT can optionally be used with local sequence databases on non-Windows systems.

[Note: this may require a lot of disk space]

If you wish to do this then carry out the following steps:

1. To download and install BLAST+ locally, check here:

ftp://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/

to get the latest Mac OS X release:

ftp://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/ncbi-blast-2.7.1+-x64-macosx.tar.gz

Uncompress, if you have downloaded a .tar.gz, e.g.

tar -zxvf ncbi-blast-2.7.1+-x64-macosx.tar.gz

For a Mac OS X install you can mount the resulting .dmg image by double-clicking it and then selecting the .pkg installer file to actually install the BLAST+ executables into the default location (/usr/local/ncbi/blast). Comprehensive installation instructions for all operating systems are provided here.

2. To download and install Fasta locally, check here:

ftp://ftp.ebi.ac.uk/pub/software/unix/fasta/

and download the latest release, e.g.

ftp://ftp.ebi.ac.uk/pub/software/unix/fasta/fasta3/fasta-36.3.8g.tar.gz

Uncompress the tar:

tar -zxvf fasta-36.3.8g.tar.gz

Build the executables, e.g. for a Mac:

cd fasta/src
make -f ../make/Makefile.os_x86_64 all