Tool to submit genomics pipeline outputs to the ENCODE Portal
Project description
accession is a Python module and command line tool for submitting genomics pipeline analysis output files and metadata to the ENCODE Portal.
Installation
Note: installation requires Python >= 3.6
$ pip install accessionNext, provide your API keys from the ENCODE portal:
$ export DCC_API_KEY=XXXXXXXX
$ export DCC_SECRET_KEY=yyyyyyyyyyyIt 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=yyyyyyyyyyyIf you are accessioning workflows produced using the
Caper local backend, then installation is
complete. However, if using WDL metadata from pipeline runs on Google Cloud, you will
also need to authenticate with Google Cloud. Run the following two commands and follow
the prompts:
$ gcloud auth login --no-launch-browser
$ gcloud auth application-default login --no-launch-browserIf 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-west1To accession workflows produced on AWS backend you will need to set up AWS
credentials. The easiest way to do this is to install the AWS CLI and run
aws configure
Usage
$ accession -m metadata.json \
-p mirna \
-s devPlease see the docs for greater detail on these input parameters.
Deploying on Google Cloud
First authenticate with Google Cloud via gcloud auth login if needed. Then install
the API client with pip install google-api-python-client, it is recommended to do
this inside of a venv. Finally, create the firewall rule and deploy the instance by
running python deploy.py –project $PROJECT. This will also install the accession
package. Finally, SSH onto the new instance and run gcloud auth login to
authenticate on the instance.
For Caper integration, once the instance is up, SSH onto it and create the Caper conf
file at ~/.caper/default.conf, use the private IP of the Caper VM instance as the
hostname and use 8000 for the port. For the connection to work the Caper VM
will need to have the tag caper-server. Also note that the deployment assumes the
Cromwell server port is set to 8000.
AWS Notes
To enable S3 to S3 copy from the pipeline buckets to the ENCODE buckets, ensure that the pipeline bucket policy grants read access to the ENCODE account. Here is an example policy:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "DelegateS3AccessGet",
"Effect": "Allow",
"Principal": {
"AWS": [
"arn:aws:iam::618537831167:root",
"arn:aws:iam::159877419961:root"
]
},
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::PIPELINE-BUCKET/*"
},
{
"Sid": "DelegateS3AccessList",
"Effect": "Allow",
"Principal": {
"AWS": [
"arn:aws:iam::618537831167:root",
"arn:aws:iam::159877419961:root"
]
},
"Action": "s3:ListBucket",
"Resource": "arn:aws:s3:::PIPELINE-BUCKET"
}
]
}Project Information
accession is released under the MIT license, documentation lives in readthedocs, code is hosted on github and the releases on PyPI.
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-4.2.0.tar.gz
(97.9 kB
view details)
Built Distribution
accession-4.2.0-py3-none-any.whl
(126.9 kB
view details)
File details
Details for the file accession-4.2.0.tar.gz.
File metadata
- Download URL: accession-4.2.0.tar.gz
- Upload date:
- Size: 97.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 53504ddca86fea6ce40c6f420920aa54d94b32e2f33e82b7b3ee592a9fa65ee2 |
|
| MD5 | b8716ce5a47a2b279cf4e6475f56a56d |
|
| BLAKE2b-256 | fddef5641981d62134859192484fd9906c750c2ad8c5bd547bf4bfc842f44f27 |
File details
Details for the file accession-4.2.0-py3-none-any.whl.
File metadata
- Download URL: accession-4.2.0-py3-none-any.whl
- Upload date:
- Size: 126.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a13711e837a6878bba500cd7497c22a3d6fca5d962e9098536315e8d1602f068 |
|
| MD5 | 3bc417b7e7f2a849ae79ecdd9463930b |
|
| BLAKE2b-256 | acc3486287db49f860fe06e6598292264abdff2b0aa18c3771b07993fa91a31f |
