Skip to main content

Tool to submit genomics pipeline outputs to the ENCODE Portal

Project description

Code Style: Black License: MIT CircleCI status

accession is a Python module and command line tool for submitting genomics pipeline analysis output files and metadata to the ENCODE Portal.

Installation

Note: intallation requires Python >= 3.6

$ pip install accession

Next, provide your API keys from the ENCODE portal:

$ export DCC_API_KEY=XXXXXXXX
$ export DCC_SECRET_KEY=yyyyyyyyyyy

You will also need to authenticate with Google Cloud if using WDL metadata from pipeline runs on Google Cloud. Run the following two commands and follow the prompts:

$ gcloud auth login --no-launch-browser
$ gcloud auth application-default login --no-launch-browser
In addition, it is highly recommended to set the DCC_LAB and DCC_AWARD environment variables for ease of use. These correspond to the lab and award identifiers given by the ENCODE portal, e.g. /labs/foo/ and U00HG123456, respectively.
$ export DCC_LAB=XXXXXXXX
$ export DCC_AWARD=yyyyyyyyyyy
If you would like to be able to pass Caper workflow IDs or labels you will need to configure access to the Caper server. If you are invoking accession from a machine where you already have a Caper set up, and you have the Caper configuration file available at ~/.caper/default.conf, then there is no extra setup required. If the Caper server is on another machine, you will need so configure HTTP access to it by setting the hostname and port values in the Caper conf file.
(Optional) Finally, to enable using Cloud Tasks to upload files from Google Cloud Storage to AWS S3, set the following two environment variables. If one or more of them is not set, then files will be uploaded using the same machine that the accessioning code is run from. For more information on how to set up Cloud Tasks and the upload service, see the docs for the gcs-s3-transfer-service
$ export ACCESSION_CLOUD_TASKS_QUEUE_NAME=my-queue
$ export ACCESSION_CLOUD_TASKS_QUEUE_REGION=us-west1

Usage

$ accession -m metadata.json \
            -p mirna \
            -s dev

Please see the docs for greater detail on these input parameters.

Project Information

accession is released under the MIT license, documentation lives in readthedocs, code is hosted on github and the releases on PyPI.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

accession-2.0.0.tar.gz (61.6 kB view details)

Uploaded Source

Built Distribution

accession-2.0.0-py3-none-any.whl (82.7 kB view details)

Uploaded Python 3

File details

Details for the file accession-2.0.0.tar.gz.

File metadata

  • Download URL: accession-2.0.0.tar.gz
  • Upload date:
  • Size: 61.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10

File hashes

Hashes for accession-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4676cc49e7bee54e0b6766b2686187b1a6a878bc6257662ed72f82af21a2015f
MD5 2b0711d11a7a3484e070eaa0e46a837c
BLAKE2b-256 c4be025fbaa157be7a26cf32c92a45dc30065006aa8f52be5303e3f1f35e0bfc

See more details on using hashes here.

File details

Details for the file accession-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: accession-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 82.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10

File hashes

Hashes for accession-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1da11aeb73181a53cbd12c03b23ce2a703b6fddabf728230bb9b14dc321f63e1
MD5 f7e16e8403805063b198b216b0778ca3
BLAKE2b-256 6c829310a41dbea6dff26b250a60ccda6c836ed69cc699cbc0a536d6890f84e0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page