wiki:Docs/PostProcessingAppNexcsSetup

Version 9 (modified by ros, 8 months ago) (diff)

NEXCS specific setup instructions for data transfer to JASMIN

Instructions depend on whether your suite has the PP Transfer option already available and also if this is your first time using the Transfer App.

To determine if your suite already has PP Transfer available search in the rose edit GUI for the variable PPTRANSFER. If PPTRANSFER variable is found then your suite is already setup with the Transfer app.

Determine which of the following scenarios you fall into and follow the instructions listed.

Scenario 1 - PP Transfer not already in the suite and you have never used the Transfer app before.

Scenario 2: PP Transfer already in suite and you have never used the Transfer app before.

Add PP Transfer task to a suite

Only follow these instructions if your suite doesn't already have the "PP Transfer" option available.

rose-suite.conf

  1. Add PPTRANSFER=true
  1. The PPTRANSFER variable will, by default, appear under "suite conf → jinja2". To tell Rose to place it with all the other suite control switches (e.g. "Build UM" & "Run Reconfiguration") usually found in a panel in the suite conf section under "Build and Run" or Tasks edit the meta/rose-meta.conf file to add in the metadata for the PPTRANSFER variable. Place it under the definition for POSTPROC. (This step is optional.)
    [jinja2:suite.rc=PPTRANSFER]
    compulsory=true
    description=Transfer files archived with PostProc to a remote machine
    help=
    ns=<panel_namespace>
    sort-key=runPostproc1
    title=PP Transfer
    type=boolean
    

Where <panel_namespace> is the same value as for the POSTPROC entry in this file; e.g. ns=Build and Run

suite.rc

Note: Depending on the suite setup you may find the appropriate sections to modify in the site/MONSooN.rc file rather than the suite.rc.

  1. Add the build & run of pptransfer task into the cylc graph initial cycle. Add the line:
    {{ 'fcm_make_pptransfer => fcm_make2_pptransfer' + (' => pptransfer' if RUN else '') if PPTRANSFER else '' }}
    
    to the cylc graph for the initial cycle, indicated by [[[ R1 ]]]. For example: (insertion indicated by "⇐ Add line here")
        [[dependencies]]
            [[[ R1 ]]]
                graph = """
    {{ 'fcm_make_pp => fcm_make2_pp' + (' => postproc' if RUN else '') if POSTPROC else '' }}
    {{ 'fcm_make_pptransfer => fcm_make2_pptransfer' + (' => pptransfer' if RUN else '') if PPTRANSFER else '' }}    <== Add line here
    {{ 'fcm_make_ocean => fcm_make2_ocean' + (' => recon' if RECON else ' => coupled' if RUN else '') if BUILD_OCEAN else '' }}
    {{ 'fcm_make_um => fcm_make2_um' + (' => recon' if RECON else ' => coupled' if RUN else '') if BUILD_UM else '' }}
    {{ 'install_ancil => recon ' if RECON else ('install_ancil => coupled' if RUN else '')}}
    {{ 'recon' + (' => coupled' if RUN else '') if RECON else '' }}
    {{ 'clearout' + (' => coupled' if RUN else '') if CLEAROUT else '' }}
    """
    
  1. Add the pptransfer task into the graph for all subsequent cycles such that it runs after the postproc task and also waits for the previous pptransfer task to complete. As an example for a coupled suite (All added lines indicated with "⇐"):
            [[[ {{FMT}} ]]]
                graph = """
    {% if RUN %}
    coupled[-{{FMT}}] => coupled {{ '=> \\' if POSTPROC or HOUSEKEEP else '' }}
      {% if POSTPROC %}
    postproc {{ '=> \\' if PPTRANSFER or HOUSEKEEP else '' }}     <= "PPTRANSFER or" added here
      {% endif %}
      {% if PPTRANSFER %}                                         <=
    pptransfer {{ '=> \\' if HOUSEKEEP else '' }}                 <=
      {% endif %}                                                 <=
      {% if HOUSEKEEP %}
    housekeeping
      {% endif %}
      {% if POSTPROC %}
    postproc[-{{FMT}}] => postproc
      {% endif %}
      {% if PPTRANSFER %}                                         <=
    pptransfer[-{{FMT}}] => pptransfer                            <=
      {% endif %}                                                 <=
    {% endif %}
    """
    

Take care to ensure there is no trailing whitespace at the end of each added line.

  1. Finally at the end of the suite.rc file add the pptransfer task definitions:
  • Rename the existing [[postproc]] section [[POSTPROC]]
  • Add:
        [[postproc]]
            inherit = None, POSTPROC
    
        [[pptransfer]]
            inherit = None, POSTPROC
            [[[environment]]]
    	    ROSE_TASK_APP = postproc
    

Set up ssh-key to connect to JASMIN

Some setup is required to enable non-interactive authentication from NEXCS to JASMIN. Please contact cms_support@… for details.