/[MITgcm]/manual/manual_todo.txt
ViewVC logotype

Diff of /manual/manual_todo.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.10 by cnh, Thu Apr 6 20:03:45 2006 UTC revision 1.13 by cnh, Thu Apr 6 20:13:23 2006 UTC
# Line 298  in content: Horizontal Dissipation: 2 ti Line 298  in content: Horizontal Dissipation: 2 ti
298    to add: mention the angle of the grid direction relative to    to add: mention the angle of the grid direction relative to
299    Eastward, Northward direction.    Eastward, Northward direction.
300    + mention horizGridFile= in file "data" (PARM04)    + mention horizGridFile= in file "data" (PARM04)
301  - add cylindrical grid description  - add cylindrical polar grid description
302     need to do a better job of relating model variables to this diagram     need to do a better job of relating model variables to this diagram
303    
304    
# Line 348  in content: Horizontal Dissipation: 2 ti Line 348  in content: Horizontal Dissipation: 2 ti
348  - does not use std notation  - does not use std notation
349  - would be better as an appendix of section 2.20:  - would be better as an appendix of section 2.20:
350  (e.g changing the tile to:  (e.g changing the tile to:
351    - talk to Baylor
352   Appendix: non-dimensional Equations on Spherical-Polar grid.)   Appendix: non-dimensional Equations on Spherical-Polar grid.)
353    
354    
355  JM  JM
356    
357    
358    >>>> From Andrea
359    
360    Chapter 3
361    --------
362    
363    Almost all of the 'math mode' text is dropped down as subscripts
364    
365    divide chapter 3 more clearly into 2 sections?
366       (ie, 3.1-3.6 are more informational, 3.8- 3.18 are examples, and
367        then 3.19 and 3.20 are informational again - rearrange subsections?)
368    
369    3.1 - don't need a link to the outside of the document (remove it)
370        - link to htdig is broken
371    
372    3.2.1 - link at bottom to source code points to section 3.2.1
373       (ie, to itself) - link should point to cvs code archive
374    
375    3.2.2.1  - ('upgrading from an earlier version') belongs under
376          the cvs part, ie, should be 3.2.1.1
377    
378    3.3 - remove reference to 'diags' section under MITgcm
379        - remove reference to 'exe' and 'bin' sections also
380          (remove the .cvsignore file under these directories in cvs)
381        - add a 'jobs' section, and a description as examples of run scripts
382        - add 'lsopt', 'optim' and 'tutorial examples' with brief descriptions
383        - under 'tools' add a reference to 'build_options'. refer to the 'optfiles'
384        - under 'tools' the adjoint points to section 5 - this is now section 8
385          (but should be a floating reference)
386        - under 'utils' add a reference to exch2 - stuff for different resolutions
387        - the description of the pkg section refers directly to
388          section 3. should be section 6 (actually should be a floating reference)
389    
390    3.4 - refer to sections 3.8 - 3.18 (now says 3.8 - 3.10)
391    3.4.1 - links to the following experiments don't exist or are broken:
392              exp2 - should link to section 3.9
393              hs94.cs-32x32x5 - link to section 3.12
394              add 'convection' to the list, link to section 3.13
395              add 'plume on slope` to the list, link to section 3.14
396              add '??' link to section 3.15
397              add 'dic_example on slope` to the list, link to section 3.16
398              add '??' link to section 3.17
399              add 'offline' and link to section 3.18
400              clean up others and make links where they are needed
401    3.4.2 - text suggests to see section 2 for details about what is in the 'code'
402            and 'input' directories - should refer to the examples in this section
403          - add 'build' bullet - this is where the model is compiled and exectuable lives
404    
405    3.5 - add some little text when talking about 'optfiles' to refer to the tools/build_options
406          as the place where they live (add a link?)
407    
408    3.6.1 - Add some general 'approach' text - ie, output is controlled either by the
409            'data' file in the input directory or by the data.[pkg name] file for any
410            package running. And there is some default behavior when the 'state' dumps
411            are written.
412    3.6.1.2 - needs to be moved to inside section 3.6.2
413    
414    3.7 - this section is superfluous - remove it -OR- put the tutorial sections (3.8-3.18)
415          underneath this one and leave the text for 3.7 in place
416    
417    All the 'overview' sections need some reference to the name of the experiment in
418    the verification directory
419    
420    3.10 - in title, 4 degrees - degree symbol is a subscript, not a superscript
421         - is this experiment in the list from section 3.4???
422    3.10.3.1 - refers to figures and equations, links are broken
423    
424    3.11.3.2 - line 43: link to equation is broken
425             - line 51-53: link to equation is broken
426             - there is some mess of text hanging around the end of this section. remove? reformat?
427    
428    3.12.4.1 - line 34 - link to equation is broken
429             - lines 60,61 - 1st (take out the 'r' in the superscript)
430    
431    3.13.2 - link to theta-equation is broken
432    3.13.5.4 -- ALL of the bold links to variable names are broken
433                line 34: link to equation is broken
434    
435    3.15.1 - reference to 'fourth experiment' should be removed
436    
437    3.16.4 - strange formatting, presence of '>' symbols - remove them
438    
439    3.17.3 - unknown verification directory pointed to - also: no link from list in sec 3.4
440    3.17.3.1 - nothing filled in under file input/data - needs description
441    
442    3.18.2 - point to section 2 for details - need hyperlink
443    
444    3.19.1 - text (2 places) says that section 3.5 called for compile in 'input' directory - not true!
445             section 3.5 has the 'build' directory in the example
446    
447    3.20.1 - link to doc at end of section points to this section
448    3.20.2 - link to doc at end of section points to this section
449    
450         offline - duplicate inputs, what is it, tidy up cfc v.
451                   other offline. JM thinks these need tidying up.
452  >>>> From Ed  >>>> From Ed
453    
454  Here are the remaining bits for Chap 4 :  Here are the remaining bits for Chap 4 :
# Line 475  to do list for chap 7: Line 572  to do list for chap 7:
572    
573  andrea  andrea
574    
 >>>> From Andrea  
   
 Chapter 3  
 --------  
   
 Almost all of the 'math mode' text is dropped down as subscripts  
   
 divide chapter 3 more clearly into 2 sections?  
    (ie, 3.1-3.6 are more informational, 3.8- 3.18 are examples, and  
     then 3.19 and 3.20 are informational again - rearrange subsections?)  
   
 3.1 - don't need a link to the outside of the document (remove it)  
     - link to htdig is broken  
   
 3.2.1 - link at bottom to source code points to section 3.2.1  
    (ie, to itself) - link should point to cvs code archive  
   
 3.2.2.1  - ('upgrading from an earlier version') belongs under  
       the cvs part, ie, should be 3.2.1.1  
   
 3.3 - remove reference to 'diags' section under MITgcm  
     - remove reference to 'exe' and 'bin' sections also  
       (remove the .cvsignore file under these directories in cvs)  
     - add a 'jobs' section, and a description as examples of run scripts  
     - add 'lsopt', 'optim' and 'tutorial examples' with brief descriptions  
     - under 'tools' add a reference to 'build_options'. refer to the 'optfiles'  
     - under 'tools' the adjoint points to section 5 - this is now section 8  
       (but should be a floating reference)  
     - under 'utils' add a reference to exch2 - stuff for different resolutions  
     - the description of the pkg section refers directly to  
       section 3. should be section 6 (actually should be a floating reference)  
   
 3.4 - refer to sections 3.8 - 3.18 (now says 3.8 - 3.10)  
 3.4.1 - links to the following experiments don't exist or are broken:  
           exp2 - should link to section 3.9  
           hs94.cs-32x32x5 - link to section 3.12  
           add 'convection' to the list, link to section 3.13  
           add 'plume on slope` to the list, link to section 3.14  
           add '??' link to section 3.15  
           add 'dic_example on slope` to the list, link to section 3.16  
           add '??' link to section 3.17  
           add 'offline' and link to section 3.18  
           clean up others and make links where they are needed  
 3.4.2 - text suggests to see section 2 for details about what is in the 'code'  
         and 'input' directories - should refer to the examples in this section  
       - add 'build' bullet - this is where the model is compiled and exectuable lives  
   
 3.5 - add some little text when talking about 'optfiles' to refer to the tools/build_options  
       as the place where they live (add a link?)  
   
 3.6.1 - Add some general 'approach' text - ie, output is controlled either by the  
         'data' file in the input directory or by the data.[pkg name] file for any  
         package running. And there is some default behavior when the 'state' dumps  
         are written.  
 3.6.1.2 - needs to be moved to inside section 3.6.2  
   
 3.7 - this section is superfluous - remove it -OR- put the tutorial sections (3.8-3.18)  
       underneath this one and leave the text for 3.7 in place  
   
 All the 'overview' sections need some reference to the name of the experiment in  
 the verification directory  
   
 3.10 - in title, 4 degrees - degree symbol is a subscript, not a superscript  
      - is this experiment in the list from section 3.4???  
 3.10.3.1 - refers to figures and equations, links are broken  
   
 3.11.3.2 - line 43: link to equation is broken  
          - line 51-53: link to equation is broken  
          - there is some mess of text hanging around the end of this section. remove? reformat?  
   
 3.12.4.1 - line 34 - link to equation is broken  
          - lines 60,61 - 1st (take out the 'r' in the superscript)  
   
 3.13.2 - link to theta-equation is broken  
 3.13.5.4 -- ALL of the bold links to variable names are broken  
             line 34: link to equation is broken  
   
 3.15.1 - reference to 'fourth experiment' should be removed  
   
 3.16.4 - strange formatting, presence of '>' symbols - remove them  
   
 3.17.3 - unknown verification directory pointed to - also: no link from list in sec 3.4  
 3.17.3.1 - nothing filled in under file input/data - needs description  
   
 3.18.2 - point to section 2 for details - need hyperlink  
   
 3.19.1 - text (2 places) says that section 3.5 called for compile in 'input' directory - not true!  
          section 3.5 has the 'build' directory in the example  
   
 3.20.1 - link to doc at end of section points to this section  
 3.20.2 - link to doc at end of section points to this section  
   
      offline - duplicate inputs, what is it, tidy up cfc v.  
                other offline. JM thinks these need tidying up.  
   
575    
576  9. Model uses  9. Model uses
577     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.13

  ViewVC Help
Powered by ViewVC 1.1.22