Skip to main content

A package for running neurosynth-compose analyses

Project description

compose-runner

Python package to execute meta-analyses created using neurosynth compose and NiMARE as the meta-analysis execution engine.

AWS Deployment

This repository includes an AWS CDK application that turns compose-runner into a serverless batch pipeline using Step Functions, AWS Lambda, and ECS Fargate. The deployed architecture works like this:

  • ComposeRunnerSubmit (Lambda Function URL) accepts HTTP requests, validates the meta-analysis payload, and starts a Step Functions execution. The response is immediate and returns both a durable job_id (the execution ARN) and the artifact_prefix used for S3 and log correlation.
  • A Standard state machine runs a single Fargate task (compose_runner.ecs_task) and waits for completion. The container downloads inputs, executes the meta-analysis on up to 4 vCPU / 30 GiB of memory, uploads artifacts to S3, and writes metadata.json into the same prefix.
  • ComposeRunnerStatus (Lambda Function URL) wraps DescribeExecution, merges metadata from S3, and exposes a simple status endpoint suitable for polling.
  • ComposeRunnerLogPoller streams the ECS CloudWatch Logs for a given artifact_prefix, while ComposeRunnerResultsFetcher returns presigned URLs for stored artifacts.
  1. Create a virtual environment and install the CDK dependencies:
    cd infra/cdk
    python -m venv .venv
    source .venv/bin/activate
    pip install -r requirements.txt
    
  2. (One-time per account/region) bootstrap the CDK environment:
    cdk bootstrap
    
  3. Deploy the stack (supplying the compose-runner version you want baked into the images):
    cdk deploy \
      -c composeRunnerVersion=$(hatch version) \
      -c resultsPrefix=compose-runner/results \
      -c taskCpu=4096 \
      -c taskMemoryMiB=30720
    
    Pass -c resultsBucketName=<bucket> to use an existing S3 bucket, or omit it to let the stack create and retain a dedicated bucket. Additional knobs:
  • -c stateMachineTimeoutSeconds=32400 to control the max wall clock per run
  • -c submitTimeoutSeconds / -c statusTimeoutSeconds / -c pollTimeoutSeconds to tune Lambda timeouts
  • -c taskEphemeralStorageGiB if the default 21 GiB scratch volume is insufficient

The deployment builds both the Lambda image (aws_lambda/Dockerfile) and the Fargate task image (Dockerfile), provisions the Step Functions state machine, and configures a public VPC so each task has outbound internet access. The CloudFormation outputs list the HTTPS endpoints for submission, status, logs, and artifact retrieval, alongside the Step Functions ARN.

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

compose_runner-0.11.0.tar.gz (60.3 MB view details)

Uploaded Source

Built Distribution

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

compose_runner-0.11.0-py2.py3-none-any.whl (60.5 MB view details)

Uploaded Python 2Python 3

File details

Details for the file compose_runner-0.11.0.tar.gz.

File metadata

  • Download URL: compose_runner-0.11.0.tar.gz
  • Upload date:
  • Size: 60.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for compose_runner-0.11.0.tar.gz
Algorithm Hash digest
SHA256 2baa3f6ab48b4de69f9743d2e256a17477a3d2115270f23e1925f3ccdd0dff68
MD5 3524e17c9c1e6655cbffe3f7fd1a82c3
BLAKE2b-256 f7b85de840e2ae53800402536a2920f159c176f242c54caa7220b8be34e35cfb

See more details on using hashes here.

File details

Details for the file compose_runner-0.11.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for compose_runner-0.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5c6d62a86b94097e9f330019d3b557c9b94d3d9a06c0b1471f58247f90562ae7
MD5 eb04ec740632ebfc539a73d8997fc646
BLAKE2b-256 6c53e5e64150ee50f87b87842feb13f3fb916085913fbc027976fea6ff9331a7

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