Changes between Version 5 and Version 6 of Docs/PostProcessingAppNexcsSetup


Ignore:
Timestamp:
11/02/19 09:18:54 (11 months ago)
Author:
ros
Comment:

Update for 2 scenarios and site files

Legend:

Unmodified
Added
Removed
Modified

  • Docs/PostProcessingAppNexcsSetup

    v5 v6  
    11= NEXCS specific setup instructions for data transfer to JASMIN = 
    22 
    3 == Suite modifications == 
     3= NEXCS specific setup instructions for data transfer to JASMIN = 
    44 
    5 1. Edit `rose-suite-conf`: 
     5Instructions depend on whether your suite has the PP Transfer option already available and also if this is your first time using the Transfer App. 
    66 
    7  Add '''PPTRANSFER=true''' 
     7To 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. 
    88 
    9 2. The PPTRANSFER variable will, by default, appear under ''"suite conf -> jinja2"''.  To tell Rose to place it with all the other suite control switches edit `meta/rose-meta.conf` to add in the metadata for the PPTRANSFER variable.  (This step is optional.) 
     9Determine which of the following scenarios you fall into and follow the instructions listed. 
    1010 
     11=== Scenario 1 - PP Transfer not already in the suite and you have never used the Transfer app before. === 
     12 
     13 * [#addpptransfertask Add PP Transfer task to the suite] 
     14 * [#sshjasmin Setup ssh-key to connect from NEXCS to JASMIN] 
     15 
     16=== Scenario 2: PP Transfer already in suite and you have never used the Transfer app before. === 
     17 
     18 * [#sshjasmin Setup ssh-key to connect from NEXCS to JASMIN] 
     19 
     20== Add PP Transfer task to a suite == #addpptransfertask 
     21 
     22Only follow these instructions if your suite doesn't already have the "PP Transfer" option available. 
     23 
     24=== `rose-suite.conf` === 
     25 
     26 1.  Add '''PPTRANSFER=true''' 
     27 
     28 2. 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.) 
    1129{{{ 
    1230[jinja2:suite.rc=PPTRANSFER] 
    … …  
    1432description=Transfer files archived with PostProc to a remote machine 
    1533help= 
    16 ns=<namespace> 
     34ns=<panel_namespace> 
    1735sort-key=runPostproc1 
    1836title=PP Transfer 
    … …  
    2038}}} 
    2139 
    22  Where `<namespace>` is the name of the panel in which you want the variable listed. For example if want it listed under panel ''"suite conf -> Build and Run"'' replace `<namespace>` with `Build and Run`. 
     40 Where `<panel_namespace>` is the same value as for the POSTPROC entry in this file; e.g. `ns=Build and Run` 
    2341 
    24 3. Add the ''pptransfer'' task into the cylc graph. Edit `suite.rc` file: 
     42=== `suite.rc` === 
    2543 
    26  [To Do: Add in/change to cater for suites with the "SITE" setup] 
     44 '''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`. 
    2745 
    28  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 ''"<="''): 
     46 1. Add the build & run of ''pptransfer'' task into the cylc graph initial cycle.  Add the line:  
     47{{{ 
     48{{ 'fcm_make_pptransfer => fcm_make2_pptransfer' + (' => pptransfer' if RUN else '') if PPTRANSFER else '' }} 
     49}}} 
     50 to the cylc graph for the initial cycle, indicated by ![[[ R1 ]]].  For example: (insertion indicated by ''"<= Add line here"'') 
     51{{{ 
     52    [[dependencies]] 
     53        [[[ R1 ]]] 
     54            graph = """ 
     55{{ 'fcm_make_pp => fcm_make2_pp' + (' => postproc' if RUN else '') if POSTPROC else '' }} 
     56{{ 'fcm_make_pptransfer => fcm_make2_pptransfer' + (' => pptransfer' if RUN else '') if PPTRANSFER else '' }}    <== Add line here 
     57{{ 'fcm_make_ocean => fcm_make2_ocean' + (' => recon' if RECON else ' => coupled' if RUN else '') if BUILD_OCEAN else '' }} 
     58{{ 'fcm_make_um => fcm_make2_um' + (' => recon' if RECON else ' => coupled' if RUN else '') if BUILD_UM else '' }} 
     59{{ 'install_ancil => recon ' if RECON else ('install_ancil => coupled' if RUN else '')}} 
     60{{ 'recon' + (' => coupled' if RUN else '') if RECON else '' }} 
     61{{ 'clearout' + (' => coupled' if RUN else '') if CLEAROUT else '' }} 
     62""" 
     63}}} 
     64 
     65 2. 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 ''"<="''): 
    2966{{{ 
    3067        [[[ {{FMT}} ]]] 
    … …  
    5188}}} 
    5289 
     90 Take care to ensure there is no trailing whitespace at the end of each added line. 
     91 
    53924. Finally at the end of the `suite.rc` file add the ''pptransfer'' task definitions: 
    5493