Skip to main content

Tools for creating and validating Daylily omics analysis reference buckets

Project description

daylily-omics-references

Bash utilities for creating and validating the reference S3 buckets used by daylily-ephemeral-cluster. The project now ships a single shell script that wraps AWS CLI commands to clone public reference data, validate an existing bucket, or ensure a bucket exists and matches the expected structure.

The commands shell out to the AWS CLI for recursive S3 copy operations. Ensure that the AWS CLI and jq are installed and that your environment is authenticated before running the script.

Usage

The entry point lives at scripts/daylily-omics-references.sh. Global options may be placed before the subcommand.

Usage: daylily-omics-references.sh [GLOBAL OPTIONS] <command> [ARGS]

Global options:
  --profile PROFILE   AWS profile to use
  --region REGION     AWS region to target (required for clone/ensure)

Commands:
  clone   Create a new reference bucket from the public source
  verify  Validate that a bucket matches the expected structure
  ensure  Verify a bucket or create it if missing

Clone a new reference bucket

scripts/daylily-omics-references.sh \
  --profile daylily-service \
  clone \
  --bucket-prefix myorg \
  --region us-west-2 \
  --execute

This creates myorg-omics-analysis-us-west-2, enables transfer acceleration and copies the default reference version (0.7.131c). Use --exclude-hg38, --exclude-b37, or --exclude-giab to omit large subsets. Pass --use-acceleration to copy via the S3 accelerate endpoint.

Verify an existing bucket

scripts/daylily-omics-references.sh \
  --profile daylily-service \
  verify \
  --bucket myorg-omics-analysis-us-west-2

This validates that the bucket exists, contains the expected folder structure and that its s3_reference_data_version.info marker matches the default version.

Ensure a bucket is ready for daylily-ephemeral-cluster

scripts/daylily-omics-references.sh \
  --profile daylily-service \
  ensure \
  --bucket-prefix myorg \
  --region us-west-2 \
  --execute

The command verifies the bucket when it already exists; otherwise it creates the bucket using the same cloning logic.

Development

The repository now consists solely of the bash script above. No Python dependencies are required. If you modify the script, ensure it remains POSIX shell compatible and keep the usage examples up to date.

Project details


Download files

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

Source Distribution

daylily_omics_references-0.3.1.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

daylily_omics_references-0.3.1-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file daylily_omics_references-0.3.1.tar.gz.

File metadata

File hashes

Hashes for daylily_omics_references-0.3.1.tar.gz
Algorithm Hash digest
SHA256 18dc201a7f264f5e88312476553563608fc7590a4fb86dcb3498ec15985ff863
MD5 1a8aeb0e540fdd45326d5786407232c7
BLAKE2b-256 2c97a29b69f6d41b15273ca16eb0d5196ce7d517a15930b758b514596a136368

See more details on using hashes here.

File details

Details for the file daylily_omics_references-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for daylily_omics_references-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dfa830381a4d3fcdeb8d280d145e23d120b4f4a092311f243bc6a98ea377af52
MD5 5990a0e1f2c17b4b847c3bf9de7e0c71
BLAKE2b-256 a57493051af3aeeb99f58da7fa534d834e7a6e7d4ce6c529c3ebe377f73c5056

See more details on using hashes here.

Supported by

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