Skip to main content

ATLAS - workflows for assembly, annotation, and genomic binning of metagenomic and metatranscriptomic data.

Project description

ATLAS

DOI

Gitter chat

scheme of workflow

Documentation

Documentation Status

Install

All dependencies are installed via conda using the bioconda channel. The workflow and some dependencies require Python 3.

The intended usage requires conda.

Further dependencies will be installed on the first execution of the assembly or annotation protocol and re-used on subsequent executions of the protocols.

For more information related to bioconda, see: https://bioconda.github.io/

As a New Environment

With conda, execute:

conda create -n atlas -c bioconda -c conda-forge python>=3.6 snakemake pandas bbmap=37.78 click ruamel.yaml biopython

Load the environment:

source activate atlas

Install atlas:

pip install -U metagenome-atlas

or install the up to date atlas from github:

git clone https://github.com/metagenome-atlas/atlas.git
cd atlas
pip install .

Getting Started

After installing, one needs to download the required databases and create a sample configuration file.

Databases

To download the databases and their respective metadata databases:

atlas download -o ~/databases

The downloads use approximately 100 GB of disk space.

Configuration File

To create a configuration file run:

atlas make-config --database-dir ~/databases config.yaml ~/directory_with_fastqs

Sample names and file paths along with default settings will populate config.yaml. This YAML file can be updated with any text editor.

Sample names should be A-Z characters and can be dash ("-") delimited.

For complete documentation, please see: Documentation Status

Assembly

After editing your configuration file and adjusting any additional parameters we run assemblies across our samples using:

atlas assemble config.yaml

By default, this will write results into our current working directory across the total number of CPU cores available.

License

BSD-3.

Disclaimer

This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.

PACIFIC NORTHWEST NATIONAL LABORATORY operated by BATTELLE for the UNITED STATES DEPARTMENT OF ENERGY under Contract DE-AC05-76RL01830

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for metagenome-atlas, version 2.0.0
Filename, size File type Python version Upload date Hashes
Filename, size metagenome_atlas-2.0.0-py3-none-any.whl (83.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size metagenome-atlas-2.0.0.tar.gz (67.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page