Skip to content
Snippets Groups Projects
Commit 2a100e29 authored by Nathan Bockisch's avatar Nathan Bockisch
Browse files

WS-1084: Added/updated READMEs for Workspaces CLIs

parent abbe29f4
No related branches found
No related tags found
1 merge request!976WS-1084: Added/updated READMEs for Workspaces CLIs
Pipeline #5626 passed
Pipeline: workspaces

#5628

    Pipeline: workspaces

    #5627

      # iiwf_trigger:
      # Ingest Image Workflow Trigger:
      iiwf_trigger is a command line utility to initiate a workflow for a VLASS image set
      `iiwf_trigger` is a command line utility to initiate a workflow for a VLASS image set.
      It is not typically run by hand, but called by the [ingest_vlass_tile.sh](../../wf_framework/sh) script.
      It works by making a REST call to Workspaces to start the workflow. It is recommended
      to have the `CAPO_PROFILE` environment variable set, otherwise you will need to
      manually specify the CAPO file with the calibration lookup URL.
      ## Usage
      `iiwf_trigger -path /path/to/VLASS/image/set [-prop CAPO_PATH]`
      ```
      Usage: iiwf_trigger -path /path/to/VLASS/image/set [-prop CAPO_PATH]
      -path Path to the VLASS image set
      -prop Path to the CAPO properties file with the calibration lookup URL (default is $CAPO_PROFILE.properties)
      ```
      # mod_analyst:
      mod_analyst is a command line utility to add/remove DAs and AODs from the qa_staff table in the database
      mod_analyst is a command line utility to add/remove DAs and AODs from the
      `qa_staff` table in the database.
      It is recommended that you have the `CAPO_PROFILE`
      environment variable set, otherwise you will need to provide the path to the
      CAPO file with the database login information.
      ## Usage
      `mod_analyst -name "First Last" [-aod] [-email EMAIL] [-rm] [-ssl] [-port PORT] [-dbname DATABASE_NAME] [-host DATABASE_HOST] [-prop CAPO_PATH]`
      ```
      usage: mod_analyst -name "First Last" [-aod] [-email EMAIL] [-rm] [-ssl] [-port PORT] [-dbname DATABASE_NAME] [-host DATABASE_HOST] [-prop CAPO_PATH]
      Add or remove DAs and AODs from the qa_staff table in the database
      -name Provide the name of the analyst, with quotes for more than one name i.e. "First Last"
      -aod Flag to add the user as an AOD. When not included they are added as a DA
      -email Provide the user's email
      -rm Remove the user instead of adding them
      -ssl Use SSL when connecting to the database (typically not needed)
      -port Provide a different port for the database (default 5432)
      -dbname Provide the name of the database (default 'archive')
      -host Provide the name of the host where the database is located (default $HOSTNAME)
      -prop Provide the path to the CAPO profile with the database login information (default $CAPO_PROFILE.properties)
      ```
      ## Examples
      ......
      # SECI Ingestion Status
      This utility checks if a SECI ingestion succeeded or failed and prints this
      information to the console. This is useful to know before cleaning a SECI cache
      area. This utility works by checking the `ingest-result.json` file in the
      workflow's results directory.
      ## Usage
      ```
      Usage: seci_ingestion_status -id <WF Request ID> [-prop CAPO_PATH]
      -id Workflow Request ID of the SECI Ingestion to inspect
      -prop Path to the CAPO properties file (default is $CAPO_PROFILE.properties)
      ```
      # System Mediator: The Workspaces Intervention Utility
      # Mediator: The Workspaces Intervention Utility
      **WARNING: This script can have unintended consequences. Please consult the Workspaces developers before using it!**
      **It should be noted** that Workspaces now has fail and abort buttons in the UI, so
      this utility is typically only useful for VLASS or CARTA jobs that don't go
      through the Workspaces capability system.
      Sometimes it becomes necessary to manually intervene in a running request - either
      capability or workflow. System Mediator is meant to provide easy access for such
      capability or workflow. Mediator is meant to provide easy access for such
      interventions.
      Current interventions include:
      ......
      # Workspaces Annihilator
      **NOTE: This utility is run via a cron job, and typically doesn't need to be run by hand**
      A commandline utility that removes old unused directories from the Workspaces lustre areas.
      ......
      # Workflow Framework Shell Scripts
      These are non-python shell scripts used by some workflows. Use the table of
      contents to jump to documentation for a specific script.
      [[_TOC_]]
      ## framework.sh
      This script ensures a workflow's directory structure is set up correctly for
      CASA and CARTA processing. It is not typically run manually.
      ### Usage
      ```
      Usage: framework [-d|-r|-wp] [parent_directory]
      This script sets up the directory structure required for CASA and CARTA processing.
      The path to the intended parent working directory is required when this script is called.
      Options:
      -d, --directory parent_directory for CASA processing
      -r, --rawdata make only rawdata directory in the given directory
      -wp, --workprod make only working and products directories in the given directory
      -h, --help display help and exit
      "
      }
      ```
      ## ingest-request.sh
      This script starts a calibration or image ingestion workflow, but is not
      currently used by any workflows and typically not run manually.
      ### Usage
      ```
      Usage: ingest-request [-c, -i] [workflow_request_id]
      This script sets off a Workspaces ingestion workflow of the specified type,
      given by the chosen option, for the provided workflow request id.
      Options:
      -c, --calibration run the ingest_cal workflow for the specified request
      -i, --image run the ingest_image workflow for the specified request
      -h, --help display this help and exit
      ```
      ## ingest_vlass_epoch.sh
      This script helps facilitate bulk ingestion of the VLASS quicklook image cache.
      It looks inside the directory for a provided epoch project code and calls the
      `ingest_vlass_tile.sh` script on each tile subdirectory. Accessing the vlass
      tile ingest script requires the `CAPO_PROFILE` environment variable to be set.
      ### Usage
      ```
      Usage: ingest_vlass_epoch PROJECT_CODE
      PROJECT_CODE: The project code with the tiles to be ingested
      ```
      ## ingest_vlass_tile.sh
      This script calls the [iiwf_trigger](../../go/iiwf_trigger) utility on every image directory within a
      VLASS tile directory. It is not typically called by hand, but rather is a helper
      script for `ingest_vlass_epoch.sh`. It requires the `CAPO_PROFILE` environment
      variable be set.
      ### Usage
      ```
      Usage: ingest_vlass_epoch PROJECT_CODE TILE_DIR
      PROJECT_CODE: The project code with the tiles to be ingested
      TILE_DIR: The tile directory with images to be ingested
      ```
      0% Loading or .
      You are about to add 0 people to the discussion. Proceed with caution.
      Finish editing this message first!
      Please register or to comment