Skip to main content

ATLAS

DOI

resources/images/atlas_workflow.png

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 python=3.6 \
    snakemake bbmap=37.78 click ruamel.yaml

Load the environment:

source activate atlas

Install atlas:

pip install -U pnnl-atlas

In the Same Environment

conda install -c bioconda python=3.6 \
    snakemake bbmap=37.78 click ruamel.yaml
pip install -U pnnl-atlas

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 30 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

Release files for pnnl-atlas 1.0.32

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pnnl-atlas 1.0.32
File Size Uploaded
pnnl-atlas-1.0.32.tar.gz 48.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pnnl-atlas 1.0.32
File Interpreter ABI Platform
pnnl_atlas-1.0.32-py3-none-any.whl Python 3 none any Details

Total release size: 107.3 kB

Release files / pnnl-atlas-1.0.32.tar.gz

Download URL pnnl-atlas-1.0.32.tar.gz
Size 48.2 kB
Tags Source
SHA-256 checksum
How to use checksums
8c2e35a6ccc3f33b62fa804dbf9449d41b5e49b8a2c01f94264d4886b91ed2c9
BLAKE2b-256 checksum
How to use checksums
4056350053bfd2d777a02ccdfeb93da6be2fc9164ba3f0d2d9729fa13751530f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pnnl_atlas-1.0.32-py3-none-any.whl

Download URL pnnl_atlas-1.0.32-py3-none-any.whl
Size 59.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
70c77194d7bebfc756b11a1d55840362a3be9f4410a3cbc4d91089d32352ad6a
BLAKE2b-256 checksum
How to use checksums
a98952523cc3f9cbb3647005495a1e875fb3680a3085a73f7aa54af92d74e67c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.32 This release

2 release files

1.0.30

2 release files

1.0.29

2 release files

1.0.28

2 release files

1.0.27

2 release files

1.0.26

2 release files

1.0.25

2 release files

1.0.19

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page