/[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.8 by cnh, Thu Apr 6 19:14:57 2006 UTC revision 1.9 by cnh, Thu Apr 6 19:54:06 2006 UTC
# Line 8  To do Line 8  To do
8      Add an "Under development, chapter" - shortish description of what      Add an "Under development, chapter" - shortish description of what
9      is available (last chapter)      is available (last chapter)
10    
11    
12    o HTML, scripts and front content
13    
14    - pick a URL    - pick a URL
15      TBD      TBD
16    
# Line 26  To do Line 29  To do
29        Overview        Overview
30        Tutorials (broken)        Tutorials (broken)
31        Browse Code        Browse Code
32    
33        o mitgcm.org (front content) [DONE]
34        Get Code (where does this go to?)        Get Code (where does this go to?)
35          get rid of * CVS current bullet
36          make HTML-enabled CVS code browser leap to MITgcm/MITgcm
37    
38      o authors      o authors
39        John, Alistair, Jean-Michel, Patrick, Andrea, Steph, Helen,        John, Alistair, Jean-Michel, Patrick, Andrea, Steph, Helen,
40        Martin, Baylor, Dimitris, David, Ed, Mick, Chris, Constantinos,        Martin, Baylor, Dimitris, David, Ed, Mick, Chris, Constantinos,
41        Gael - others?        Gael - others?
42    
43      o Tutorials side bar link is broken      o words on http://mitgcm.org/r2_web_testing/latest
44          change to
45      o words         "access on-line Auser manual/A and Atable of contents/A
46        change to "access on-line Auser manual/A and Atable of contents/A          and browse the Aoverview section/A"
       and browse the Aoverview section/A"  
47    
48      o finite-volume doesn't leap to FV figure      o finite-volume doesn't leap to FV figure
49    
50      o the src and equation links don't come through to      o have another go at pnmcrop et al.
       the html when they are in figures - see chapter 2 for some  
       examples.  
   
     o degree symbols keep getting "dropped down" - problem with  
       pnmcrop et al.  
51    
52        o Need an empty package as part of distribution. Check out atm_common
53    
54  Contents  o Latex  
55    
56      Intro                  - CNH      Chapter 1                 - CNH
57        o single kernel diagram -        o single kernel diagram -
58            add reference to MWR paper            add reference to MWR paper
59    
# Line 116  Contents Line 118  Contents
118    
119        o Kinematic boundary conditions        o Kinematic boundary conditions
120    
121        o Hydrostatic, Quasi-hydrostatic, Quasi-nonhydrostatic and Non-hydrostatic forms        o Hydrostatic, Quasi-hydrostatic, Quasi-nonhydrostatic and
122          need to tidy up discussion of shallow-atmosphere to be          Non-hydrostatic forms
123          consistent with the code or change code to be consistent           need to tidy up discussion of shallow-atmosphere to be
124          with the discussion!           consistent with the code or change code to be consistent
125          make references hyperlinks           with the discussion!
126          add stuff too           make references hyperlinks
127             add stuff too
128             JMC remove QNH atmosphere
129             need to sort out calc_gw for deep atmosphere
130    
131        o Finding the pressure field        o Finding the pressure field
132          make references hyperlinks           make references hyperlinks
133          add forward references to manual algorithm section           add forward references to manual algorithm section
134          change Elliptic to "elliptic"           change Elliptic to "elliptic"
135    
136        o Forcing and dissipation        o Forcing and dissipation
137          make "physics packages" refer to chapter 6.           make "physics packages" refer to chapter 6.
138          should we move "external forcing" et. al to a           should we move "external forcing" et. al to a
139          generic_forcing_driver package?           generic_forcing_driver package?
140    
141          viscosities          viscosities
142          update to mention Smag/Leith (Ah and A4 not constant)           update to mention Smag/Leith (Ah and A4 not constant)
143          and to have forward references to numerical section           and to have forward references to numerical section
144          tracers           tracers
145          forward references to numerical section, reddy, GM etc...           forward references to numerical section, reddy, GM etc...
146          add references to literature           add references to literature
147    
148        o 1.3.8 Vector invariant form        o 1.3.8 Vector invariant form
149          forward references to numerical section          forward references to numerical section
# Line 164  Contents Line 169  Contents
169          PH to do something          PH to do something
170    
171    
     Discretization and alg - JMC+CNH  
   
     Tutorials              - AM  
      3.1 "Where to find"  
        o link to Pelican not needed  
        o mailman twice (why?)  
        o no htdig (gone? - I liked it)  
   
      intro part  
      individual experiments  
   
      offline - duplicate inputs, what is it, tidy up cfc v.  
                other offline.  
   
     Software               - EH to review  
   
     some to be done on resource estimates at the end - needs sorting.  
   
     Automatic Diff         - CE  
   
     Physical Packages      - ???  
   
     Diags and tools        - ???  
   
     Interface with ECCO    - ???  
   
     Model uses             - ???  
   
     Building document      - ???  
     via cron  
     tweaking latex2html etc..  
   
     Src Code tree (rename  
     examples etc..)        - ???  
   
 Documentation  
   
 1. Introduction  
   
 2. Discretization and Algorithm  
   
    2.13.5 Lateral dissipation  
     o need to relate c11, c12 etc.. to COSFAC, USE_COS etc... flags  
       in code need to explain why cos()3/2 turns out to be  
       scaling (not cos()2)  
   
    2.13.6 Vertical dissipation  
     o update to have reference to Baylors section  
       reference to implicit discussion in time-stepping part of manual  
   
   
   
 3. Tutorials  
    reorg'd into  
    intro part  
    individual experiments  
   
 4. Software Architecture  
   
 5. Automatic Differentiation  
   
 6. Physical Parameterization and Packages  
   
 7. Diagnostics and tools  
   
 8. Interface with ECCO  
   
 9. Model uses  
    Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...  
    (check in support for more names)  
   
  Need an empty package as part of distribution  
   
  latex2html equation formatting is still a bit weird in places. Need to have another go if we have a chance - especially the degree symbol seems to jump around somewhat!  
   
 Chapter 1  
   
172      Change hydrodynamical to "dynamical"      Change hydrodynamical to "dynamical"
173    
174      Examples      Examples
# Line 278  Chapter 1 Line 206  Chapter 1
206    
207            o Gas giant?            o Gas giant?
208    
 Chapter 6  
   
    the master package diagram does not appear in the document  
   
    pkg/ptracers doesn't seem to have any documentation (see packages list below)  
   
   
   
 2.10.5 Horizontal grid  
   
    need to do a better job of relating model variables to this diagram  
   
209    
210  Master list of packages  Master list of packages
211    
# Line 390  and thats about it for Chap 4. Line 306  and thats about it for Chap 4.
306    
307  Add more to quick links on front page  Add more to quick links on front page
308    
309    Chapter 6
310    
311       the master package diagram does not appear in the document
312    
313       pkg/ptracers doesn't seem to have any documentation (see packages list below)
314    
315    
316  >>>> From Andrea  >>>> From Andrea
317    
# Line 497  the verification directory Line 419  the verification directory
419  3.20.1 - link to doc at end of section points to this section  3.20.1 - link to doc at end of section points to this section
420  3.20.2 - 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
421    
422         offline - duplicate inputs, what is it, tidy up cfc v.
423                   other offline. JM thinks these need tidying up.
424    
425  >>>> from JM  >>>> from JM
426    
427    
# Line 590  in content: Horizontal Dissipation: 2 ti Line 515  in content: Horizontal Dissipation: 2 ti
515    Eastward, Northward direction.    Eastward, Northward direction.
516    + mention horizGridFile= in file "data" (PARM04)    + mention horizGridFile= in file "data" (PARM04)
517  - add cylindrical grid description  - add cylindrical grid description
518       need to do a better job of relating model variables to this diagram
519    
520    
521  2.11 Continuity & Horizontal Pressure gradient terms  2.11 Continuity & Horizontal Pressure gradient terms
522   - mention that d.Phi/dr|s =g if using z coordinate   - mention that d.Phi/dr|s =g if using z coordinate
# Line 611  in content: Horizontal Dissipation: 2 ti Line 538  in content: Horizontal Dissipation: 2 ti
538  2.13.5 Lateral dissipation  2.13.5 Lateral dissipation
539   - add description of how to use cosFactor & cosPower   - add description of how to use cosFactor & cosPower
540   - add the parameter correspondence: Ah <-> viscAh ; A4 <-> viscA4   - add the parameter correspondence: Ah <-> viscAh ; A4 <-> viscA4
541        o need to relate c11, c12 etc.. to COSFAC, USE_COS etc... flags
542          in code need to explain why cos()3/2 turns out to be
543          scaling (not cos()2)
544    
545  2.13.6 Vertical dissipation  2.13.6 Vertical dissipation
546   - mention the implicit vertical viscosity option and ref to section 2.5   - mention the implicit vertical viscosity option and ref to section 2.5
# Line 638  in content: Horizontal Dissipation: 2 ti Line 568  in content: Horizontal Dissipation: 2 ti
568    
569  JM  JM
570    
571    
572    9. Model uses
573       Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
574       (check in support for more names)

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.9

  ViewVC Help
Powered by ViewVC 1.1.22