clowdr.controller package

Submodules

clowdr.controller.launcher module

clowdr.controller.launcher.configureResource(endpoint, auth, **kwargs)

clowdr.controller.metadata module

clowdr.controller.metadata.bidsTasks(clowdrloc, taskdict)

bidsTask Scans through BIDS app fields for creating more tasks than specified.

clowdrloc : str

Path for storing Clowdr intermediate files and outputs

taskdict : str

Dictionary of the tasks (pre-BIDS-ification)

tuple: (list, list)

The task dictionary JSONs, and associated Boutiques invocation files.

clowdr.controller.metadata.consolidateTask(tool, invocation, clowdrloc, dataloc, bids=False, sweep=[], verbose=False, **kwargs)

Creates Clowdr task JSON files and Boutiques invocations which summarize all associated metadata with the tasks being launched.

tool : str

Path to a boutiques descriptor for the tool to be run.

invocation : str

Path to a boutiques invocation for the tool and parameters to be run.

clowdrloc : str

Path for storing Clowdr intermediate files and output logs.

dataloc : str

Path for accessing input data on an S3 bucket (must include s3://) or localhost for non-cloud hosted data.

bids : bool (default = False)

Flag toggling BIDS-aware metadata preparation.

sweep : list (default = [])

List of parameters to sweep over in the provided invocations.

verbose : bool (default = False)

Flag toggling verbose output printing.

**kwargs : dict

Arbitrary additional keyword arguments which may be passed.

tuple: (list, list)

The task dictionary JSONs, and associated Boutiques invocation files.

clowdr.controller.metadata.prepareForRemote(tasks, tmploc, clowdrloc)

Scans through BIDS app fields for creating more tasks than specified.

tasks : list

List of task dictionaries on disk for Clowdr tasks.

tmploc : str

Temporary location where the invocations and task files are stored.

clowdrloc : str

Path for storing Clowdr intermediate files and outputs

tuple: (list, list)

The task dictionary JSONs, and associated Boutiques invocation files, with paths corrected to eventual remote locations.

clowdr.controller.metadata.sweepTasks(taskdicts, invocations, sweep_param)

Sweeps through provided fields for creating more tasks than specified.

taskdicts : str

Dictionary of the tasks

invocations : str

Corresponding invocations for each task dictionary

sweep_param : str

Parameter to be swept over in each invocation

tuple: (list, list)

The task dictionary JSONs, and associated Boutiques invocation files.

Module contents