New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
2020WP (diff) – NEMO

Changes between Version 8 and Version 9 of 2020WP


Ignore:
Timestamp:
2019-10-29T17:12:28+01:00 (5 years ago)
Author:
clevy
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • 2020WP

    v8 v9  
    101101== Add a proposed action in the work plan 
    102102 
    103 At this stage (autumn 2019), we are building the list of possible actions for 2020. The 2020 work plan will be finalised by end of the year, with advice from the Developers Committee and decisions from the Steering committee. 
    104  
    105 The 2020 workplan must be realistic 
    106  
    107 To add a proposed action in 2020 work plan, you need to create the wiki page (all actions) and (only for 2020 IMMERSE actions) the associated ticket. The steps are detailed below:  
    108  
    109 '''Naming convention'''[[BR]] 
    110 The name of an action must follow the convention: "STREAM"_"NUMBER"_"login of PI"_"keyword" [[BR]] 
    111 Following this convention, the name of the wiki page will be:  forge.ipsl.jussieu.fr/nemo/wiki/2020WP/"STREAM"_"NUMBER"_"login of PI"_"keyword" 
     103At this stage (autumn 2019), we are building the list of possible actions for 2020. The 2020 work plan will be finalised by end of the year, with advice from the Developers Committee and decisions from the Steering committee.[[BR]] 
     104The 2020 workplan must be realistic. Each action must define the 2020 objecitve. If the action is expected to take more than one year, it should be explained in the Description section of the associated wiki page.[[BR]] 
     105To ad an action in 2020 work plan proposal, you need to create the wiki page (for all actions) and the associated ticket (for 2020 IMMERSE actions only, since those are for sure already). [[BR]] 
     106Once the 2020 workplan will be finalised (after Steering Committee meeting) each action will need its wiki page (action description) and its ticket (following the state of the work).[[BR]] 
     107 
     108 
     109'''Important: naming convention for actions an their wiki page'''[[BR]] 
     110The name of an action must follow the convention: "STREAM"_"NUMBER"_"login of PI"_"keyword" , to be used both to name its wiki page and its ticket.[[BR]] 
     111Following this convention, '''the name of the wiki page must be:  forge.ipsl.jussieu.fr/nemo/wiki/2020WP/"STREAM"_"NUMBER"_"login of PI"_"keyword"''' 
    112112 
    113113=== 1/ Create the wiki page  
    114114 
    115 * After logging in with your trac login,  type the name of the wiki page to create in your web browser, following the naming convention above[[BR]] 
     115* After logging in with your trac login,  type in your web browser the name of the wiki page you want to create, following the naming convention above[[BR]] 
    116116* The NEMO wiki will answer : the page xxxx does not exist , you can create it here.[[BR]] 
    117 * '''Choose the template '!Workplan/Action' (mandatory)'''[[BR]] 
    118 * and create the wiki page. 
    119  
    120 === 2/ Complete description of action in the wiki page 
    121 '''It is mandatory to complete the informations of the first part of the ticket :''' 
    122 * Abstract 
    123 Including a statement on the objective by end 2020: feasible meaning it is scheduled with associated resources, desirable meaning is is hoped to be completed 
    124 * Context 
     117* '''Choose the template '!Workplan/Action' (mandatory) and create the wiki page.''' This will open the new page in edit mode, allowing you to move to step 2: 
     118 
     119=== 2/ Complete the mandatory fields in the wiki page 
     120* In the Summary section following fields (= those in bold) must be completed:  
     121     * '''Action''' = Name and subject of the action   
     122     * '''PI(S) Names'''                                                  
     123     * '''Digest'''  = one sentence stating motivations and main tasks 
     124     * '''Dependencies''' = taksks needing to be completed before this action can start, if any 
     125     * Branch = name of development branch following naming convention (source:/NEMO/branches/{YEAR}/dev_r{REV}_{ACTION_NAME}, to add once preview is completed, e.g. not at this stage 
     126     * '''Previewer(s)Names'''                                                   
     127     * '''Reviewer(s)  Names'''  
     128     * '''Ticket''' = number of associated ticket (, to be added once ticket is created, e.g. '''only for IMMERSE actions for now''')   
     129 
     130 
     131* '''Description section (mandatory)''': 
     132Please complete this section in plain English, readable by all. 
     133Description should include:  
     134    * '''goal of development and the methodology''' 
     135    * '''reference documents''' or publications if relevant 
     136    * '''precise statement of the objective by end 2020''' 
     137    * If the action is expected to continue after 2020, some elements on the context 
     138    * '''a statement on the priority''' : the action will be qualified as '''feasible''' if it is listed with associated commitment of the PI, or '''desirable''' meaning if is is hoped to be completed 
     139 
     140The other sections of wiki page (implementation, documentation update, preview, tests etc... are expected to be completed as the action work is going on. [[BR]][[BR]] 
    125141 
    126142=== 3/ For IMMERSE 2020 actions only: create also the ticket for the action  
     
    133149    * Component 
    1341503. Save the ticket and check it appears in the 2020 work plan page (second table). 
     1514. Add the ticket number in the wiki page you've created at step 1 
    135152 
    136153{{{#!rbox important