From 86aafea95d8a4a67c2c1fa64e0fd6360e989d8a0 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 28 Mar 2024 02:44:22 +0000 Subject: [PATCH] :memo: Update usage from helpstring --- README.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index aa333929..e89ff598 100644 --- a/README.rst +++ b/README.rst @@ -39,30 +39,30 @@ Usage [--working_dir PATH] [-v] [-vv] {run,utils,version,group,pull,upgrade,enter,bash,shell,parse-resources,parse_resources,crash} ... - - cpac: a Python package that simplifies using C-PAC containerized images. - + + cpac: a Python package that simplifies using C-PAC containerized images. + This commandline interface package is designed to minimize repetition. As such, nearly all arguments are optional. - - When launching a container, this package will try to bind any paths mentioned in + + When launching a container, this package will try to bind any paths mentioned in • the command • the data configuration - + An example minimal run command: cpac run /path/to/data /path/for/outputs - + An example run command with optional arguments: cpac -B /path/to/data/configs:/configs \ --image fcpindi/c-pac --tag latest \ run /path/to/data /path/for/outputs \ --data_config_file /configs/data_config.yml \ --save_working_dir - + Each command can take "--help" to provide additonal usage information, e.g., - + cpac run --help - + Known issues: - Some Docker containers unexpectedly persist after cpac finishes. To clear them, run 1. `docker ps` to list the containers @@ -70,7 +70,7 @@ Usage 2. `docker attach ` 3. `exit` - https://github.com/FCP-INDI/cpac/issues - + positional arguments: {run,utils,version,group,pull,upgrade,enter,bash,shell,parse-resources,parse_resources,crash} run Run C-PAC. See @@ -91,7 +91,7 @@ Usage Enter a new C-PAC container via BASH. parse-resources (parse_resources) . - + When provided with a `callback.log` file, this utility can sort through the memory `runtime` usage, `estimate`, and associated `efficiency`, to identify the `n` tasks with the `highest` or `lowest` of each of these @@ -99,13 +99,13 @@ Usage "parse-resources" is intended to be run outside a C-PAC container. See "cpac parse-resources --help" for more information. crash Convert a crash pickle to plain text (C-PAC < 1.8.0). - + options: -h, --help show this help message and exit --version show program's version number and exit -o OPT, --container_option OPT parameters and flags to pass through to Docker or Singularity - + This flag can take multiple arguments so cannot be the final argument before the command argument (i.e., run or any other command that does not start with - or --) @@ -116,7 +116,7 @@ Usage real_path:container_path (eg, /home/C-PAC/run5/outputs:/outputs). Use absolute paths for both paths. - + This flag can take multiple arguments so cannot be the final argument before the command argument (i.e., run or any other command that does not start with - or --) @@ -127,7 +127,7 @@ Usage --image IMAGE path to Singularity image file OR name of Docker image (eg, "fcpindi/c-pac"). Will attempt to pull from Singularity Hub or Docker Hub if not provided. If image is specified but platform is not, platform is - assumed to be Singularity if image is a path or + assumed to be Singularity if image is a path or Docker if image is an image name. --tag TAG tag of the Docker image to use (eg, "latest" or "nightly"). --working_dir PATH working directory