Alpha release requirements

[atteggiani]

um-modify requirements for Alpha release

General requirements​

• Main functionality: replace the data of a UM file​
• Language: Python (>=3.10)​
• Audience: Researchers / ACCESS model users​
• Interface type: API and CLI​

Specific requirements​

• Supported UM input files: UM files (Ancillary files, Restart Dump files, Fields files​)
• Supported replacement sources: NetCDF data

API requirements​

• Main functions: um-modify​
• Return: Output path​
• Side effects: Writes the output path (modified UM file) on disk​
  Main function arguments:​
• input_file: path to the UM input file to modify​
• replacement_source: path to the netCDF file
• stash_codes: List of STASH codes to include in the data replacement (only STASH codes listed will have data replaced)​
• output_path: Path to the modified UM output file​
• latitude_name: If replacement_source is NetCDF, name of the latitude coordinate​
• longitude_name: If replacement_source is NetCDF, name of the longitude coordinate​
• level_name: If replacement_source is NetCDF, name of the level coordinate​
• time_name: If replacement_source is NetCDF, name of the time coordinate​

​CLI requirements​

Positional arguments:​

• input_file: path to the UM input file to modify [required if not passed as an optional arg]​

Optional arguments:​

• -h, --help: help​
• -i, --input: path to the UM input file to modify [required if not passed as an optional arg]​
• -s, --source: path to the netCDF file
• --stash: List of STASH codes to include in the data replacement (only STASH codes listed will have data replaced)​
• -o, --output: Path to the modified UM output file​
• --latitude-name: If replacement_source is NetCDF, name of the latitude coordinate​
• --longitude-name: If replacement_source is NetCDF, name of the longitude coordinate​
• --level-name: If replacement_source is NetCDF, name of the level coordinate​

Deployment requirements

• conda package in the accessnri Anaconda channel