Skip to content

create-ras-tmp.md

Latest commit

 

History

History
66 lines (48 loc) · 1.95 KB

create-ras-tmp.md

File metadata and controls

66 lines (48 loc) · 1.95 KB

Create RAS TMP Action

Description

The create-ras-tmp action is designed to prepare a plan RAS model input file for execution by copying the necessary structure and data from an existing RAS hdf file.

Process Flow

  1. Input Validation:

    • Verifies that both src and local_dest attributes are provided
    • Parses save_to_remote to boolean value
    • Checks for remote destination name if remote saving is requested

  2. File Creation:

    • Creates a new temporary file at the specified location
    • Copies core RAS datasets: "Geometry", "Plan Data", "Event Conditions"
    • Preserves essential file metadata attributes:
      • File Type
      • File Version
      • Projection
      • Units System

  3. Remote Storage:

    • If save_to_remote is true, copies the temporary file to the specified remote destination

Configuration

Attributes

Action

Attribute Type Required Description
src string Yes Name of the source RAS file in the model directory
local_dest string Yes Name of the temporary file to create
save_to_remote string No Whether to save the temporary file to a remote destination (default: "false")
remote_dest string No Name of the remote data source if save_to_remote is true

Configuration Example

{
  "action": "create-ras-tmp",
  "attributes": {
    "src": "source_model.ras",
    "local_dest": "temp_model.ras",
    "save_to_remote": "true",
    "remote_dest": "remote_storage"
  }
}

Error Handling

The action returns descriptive error messages for:

  • Missing required attributes
  • File I/O errors during creation or copying
  • Invalid boolean conversion for save_to_remote
  • Remote storage failures

Usage Notes

  • The temporary file is created in the model directory specified by actions.MODEL_DIR (/sim/model)
  • All copied datasets and attributes maintain their original structure and data types