Skip to main content

A Python based soft to launch neuroimaging containers on clusters

Project description

logo launchcontainers

launchcontainers

Launchcontainers is a Python-based tool for automatically launching parallel computing tasks on HPC or local clusters. It was designed to:

  1. Prepare folder structures and input files automatically for Neuroimaging pipelines
  2. Backup the input configs for data provenance
  3. Deploy jobs in local HPC, SGE, or SLURM in parallel

Currently, launchcontainers works along with anatROIs, RTP-preproc, and RTP2-pipeline.

To use the newest version, please pip install launchcontainers==0.4.3

NEW FEATURES

  • Update to 0.4.3. Add feature QC rtp2pipelines, it was integrated in the code launchcontainers/launchcontainers /quality_control/, you can use it by doing python qc_rtp2pipeline_output.py analysis_dir, it will read if all the tracts is finished for you
  • Update to 0.4.2. Refactor the launchcontainer command-line interaction to make it more user-friendly
    • For prepare mode, the user will do: lc --log-dir path/to/log/dir prepare -lcc path/to/lc_yaml -ssl path/to/subseslist -cc path/to/cc
      • The prepare mode will create symlink and prepare analysis folder structure. it will output analysis_dir in the commandline for run mode
    • For run mode, the user will do: lc --log-dir path/to/log/dir run -w path/to/analysis_dir --run_lc
      • The run mode will do a independent check on analysis dir to see if the configs there is correct
      • Then it will summarize the config settings and folder structure (using the cli tree command) to the user and ask for user input
      • Once user type y or yes, the program will launch
    • Several helper functions also implemented in the cli lc :
      • lc --copy_configs -o path/to/working/dir you can type this to copy all the example configs to the working directory
      • lc --create_bids -csc path/to/csc/yaml -ssl path/to/subseslist you can use this to create a fake BIDS folder for testing
    • for more info, pip install lc and type lc -h
  • The update 0.3.5 will be capable work with heudiconv, Presurfer and NORDIC_raw, there will be a new derivatives folder called Processed_nifti, it will stored the processed .nii.gz by NORDIC_raw and Presurfer
  • 0.3.5: The add_intended_for function from heudiconv will be used here to edit the fmap _epi.json
  • Add requests into pyproject.toml, remove version limit to common package such as nibabel and numpy
  • Changed rtp/rtp2-preproc multishell option to separateed_shell_files
  • Edited lc_config.yaml comment about dask_worker options
  • Fixed error message by dask progress (0.3.18)
  • launchcontainers --copy_configs "~/path/to/working_directory" will copy the corresponding config files to your specified directory!
  • We updated the lc_config.yaml for RTP2-pipelines, please have a look!

check the How to use for more information

Check also:

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

launchcontainers-0.4.3.tar.gz (12.7 MB view details)

Uploaded Source

Built Distribution

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

launchcontainers-0.4.3-py3-none-any.whl (12.8 MB view details)

Uploaded Python 3

File details

Details for the file launchcontainers-0.4.3.tar.gz.

File metadata

  • Download URL: launchcontainers-0.4.3.tar.gz
  • Upload date:
  • Size: 12.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for launchcontainers-0.4.3.tar.gz
Algorithm Hash digest
SHA256 5c949881be9d145e5abe72f5f9cf84fe3f2bd233db44b5aa0269f8068d2e8077
MD5 5b391e33f6f04e64ac511334b2939715
BLAKE2b-256 c0b7cea690b96e8d664262620bef2065d8622f623e235c7eb31bdbd32c404303

See more details on using hashes here.

File details

Details for the file launchcontainers-0.4.3-py3-none-any.whl.

File metadata

File hashes

Hashes for launchcontainers-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db4afff3aef4ae18353d9b0ad78a920671679fe7f0ed661e2d8be501115ae98c
MD5 bfd77cc1196d4ef183f101aa3169a36b
BLAKE2b-256 0c04312b2b90540957979255fe5dbf41993767a73a0cf18aaf8bf1bd293bfc7d

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