/[MITgcm]/manual/manual_todo.txt

Diff of /manual/manual_todo.txt

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

-revision 1.3 by edhill,
Thu Apr  6 18:16:41 2006 UTC
+revision 1.9 by cnh,
Thu Apr  6 19:54:06 2006 UTC
 Line 1
- Rebuild and set to do cron build
+ Rebuild and set to do cron build - DONE on hugo
  To do
    - where to put under development links?
+     JMC would like to have some mention of unfinished things (checked in
+      but not that tested e.g. AB3)
+     Add an "Under development, chapter" - shortish description of what
+     is available (last chapter)
+ o HTML, scripts and front content
+   - pick a URL
+     TBD
    - mitgcm.org very front page.
      o too many clicks to get to model manual.
-Line 19 
 To do
+Line 29 
 To do
        Overview
        Tutorials (broken)
        Browse Code
+     o mitgcm.org (front content) [DONE]
        Get Code (where does this go to?)
+       get rid of * CVS current bullet
+       make HTML-enabled CVS code browser leap to MITgcm/MITgcm
      o authors
        John, Alistair, Jean-Michel, Patrick, Andrea, Steph, Helen,
        Martin, Baylor, Dimitris, David, Ed, Mick, Chris, Constantinos,
        Gael - others?
-     o Tutorials side bar link is broken
+     o words on http://mitgcm.org/r2_web_testing/latest
+       change to
-     o words
+        "access on-line Auser manual/A and Atable of contents/A
-       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"
      o finite-volume doesn't leap to FV figure
-     o date is 2002
+     o have another go at pnmcrop et al.
-     o the src and equation links don't come through to
+     o Need an empty package as part of distribution. Check out atm_common
-       the html when they are in figures - see chapter 2 for some
-       examples.
-     o degree symbols keep getting "dropped down" - problem with
+ o Latex
-       pnmcrop et al.
+     Chapter 1                 - CNH
- Contents
-     Intro                  - CNH
        o single kernel diagram -
            add reference to MWR paper
-Line 111 
 Contents
+Line 118 
 Contents
        o Kinematic boundary conditions
-       o Hydrostatic, Quasi-hydrostatic, Quasi-nonhydrostatic and Non-hydrostatic forms
+       o Hydrostatic, Quasi-hydrostatic, Quasi-nonhydrostatic and
-         need to tidy up discussion of shallow-atmosphere to be
+         Non-hydrostatic forms
-         consistent with the code or change code to be consistent
+          need to tidy up discussion of shallow-atmosphere to be
-         with the discussion!
+          consistent with the code or change code to be consistent
-         make references hyperlinks
+          with the discussion!
-         add stuff too
+          make references hyperlinks
+          add stuff too
+          JMC remove QNH atmosphere
+          need to sort out calc_gw for deep atmosphere
        o Finding the pressure field
-         make references hyperlinks
+          make references hyperlinks
-         add forward references to manual algorithm section
+          add forward references to manual algorithm section
-         change Elliptic to "elliptic"
+          change Elliptic to "elliptic"
        o Forcing and dissipation
-         make "physics packages" refer to chapter 6.
+          make "physics packages" refer to chapter 6.
-         should we move "external forcing" et. al to a
+          should we move "external forcing" et. al to a
-         generic_forcing_driver package?
+          generic_forcing_driver package?
          viscosities
-         update to mention Smag/Leith (Ah and A4 not constant)
+          update to mention Smag/Leith (Ah and A4 not constant)
-         and to have forward references to numerical section
+          and to have forward references to numerical section
-         tracers
+          tracers
-         forward references to numerical section, reddy, GM etc...
+          forward references to numerical section, reddy, GM etc...
-         add references to literature
+          add references to literature
        o 1.3.8 Vector invariant form
          forward references to numerical section
-Line 159 
 Contents
+Line 169 
 Contents
          PH to do something
-     Discretization and alg - JMC+CNH
-     Tutorials              - AM
-.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
-. Introduction
-. Discretization and Algorithm
-.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)
-.13.6 Vertical dissipation
-     o update to have reference to Baylors section
-       reference to implicit discussion in time-stepping part of manual
-. Tutorials
-    reorg'd into
-    intro part
-    individual experiments
-. Software Architecture
-. Automatic Differentiation
-. Physical Parameterization and Packages
-. Diagnostics and tools
-. Interface with ECCO
-. 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
      Change hydrodynamical to "dynamical"
      Examples
-Line 273 
 Chapter 1
+Line 206 
 Chapter 1
            o Gas giant?
- 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)
-.10.5 Horizontal grid
-    need to do a better job of relating model variables to this diagram
  Master list of packages
-Line 385 
 and thats about it for Chap 4.
+Line 306 
 and thats about it for Chap 4.
  Add more to quick links on front page
+ 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)
  >>>> From Andrea
-Line 492 
 the verification directory
+Line 419 
 the verification directory
 .20.1 - link to doc at end of section points to this section
 .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.
  >>>> from JM
-Line 585 
 in content: Horizontal Dissipation: 2 ti
+Line 515 
 in content: Horizontal Dissipation: 2 ti
    Eastward, Northward direction.
    + mention horizGridFile= in file "data" (PARM04)
  - add cylindrical grid description
+    need to do a better job of relating model variables to this diagram
 .11 Continuity & Horizontal Pressure gradient terms
   - mention that d.Phi/dr|s =g if using z coordinate
-Line 606 
 in content: Horizontal Dissipation: 2 ti
+Line 538 
 in content: Horizontal Dissipation: 2 ti
 .13.5 Lateral dissipation
   - add description of how to use cosFactor & cosPower
   - add the parameter correspondence: Ah <-> viscAh ; A4 <-> viscA4
+     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)
 .13.6 Vertical dissipation
   - mention the implicit vertical viscosity option and ref to section 2.5
-Line 633 
 in content: Horizontal Dissipation: 2 ti
+Line 568 
 in content: Horizontal Dissipation: 2 ti
  JM
+. Model uses
+    Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
+    (check in support for more names)

 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.9
 Legend:



Removed from v.1.3
 


changed lines


 
Added in v.1.9
-Removed from v.1.3
+Added in v.1.9

	ViewVC Help
Powered by ViewVC 1.1.22