/[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.26 by cnh, Thu Apr 6 20:57:41 2006 UTC revision 1.39 by jmc, Wed Jun 28 16:27:02 2006 UTC
# Line 1  Line 1 
1    Editors
2    
3     Overall       - JM, AM, PH, CNH, EH3
4    
5     Front content - EH3
6    
7     Chapter 1     - CNH
8    
9     Chapter 2     - JMC
10    
11     Chapter 3     -  AM
12    
13     Chapter 4     - CNH
14    
15     Chapter 5     -  PH
16    
17     Chapter 6     -  AM
18    
19     Chapter 7     - EH3
20    
21     Chapter 8     -  PH
22    
23     Chapter 9     - CNH (Applications)
24    
25     Chapter 10    - JMC (Under development chapter)
26    
27     Biblio        - EH3
28    
29  Rebuild and set to do cron build - DONE on hugo  Rebuild and set to do cron build - DONE on hugo
30    
31  To do  To do
# Line 8  To do Line 36  To do
36      Add an "Under development, chapter" - shortish description of what      Add an "Under development, chapter" - shortish description of what
37      is available (last chapter)      is available (last chapter)
38    
39      - add in example latex for formatting author names in different pieces.
40        this aknowledges peoples contributions and gives ref for who
41        to talk to.
42    
43  o HTML, scripts and front content  o HTML, scripts and front content
44    
# Line 25  o HTML, scripts and front content Line 56  o HTML, scripts and front content
56        Tutorials (broken)        Tutorials (broken)
57        Browse Code        Browse Code
58    
     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?  
   
59      o words on http://mitgcm.org/r2_web_testing/latest      o words on http://mitgcm.org/r2_web_testing/latest
60        change to        change to
61         "access on-line Auser manual/A and Atable of contents/A         "access on-line Auser manual/A and Atable of contents/A
# Line 67  o Latex Line 88  o Latex
88    
89        o List of key papers needs to be updated and reformatted        o List of key papers needs to be updated and reformatted
90    
   
91        o Global atmosphere: `Held Suarez',        o Global atmosphere: `Held Suarez',
92          update Adcroft reference          update Adcroft reference
93          fix up ingrid link and frame (ingrid movies seem to be broken?)          fix up ingrid link and frame (ingrid movies seem to be broken?)
# Line 185  o Latex Line 205  o Latex
205            o coupled aqua, ridge world etc...            o coupled aqua, ridge world etc...
206              - links to ingrid output              - links to ingrid output
207                get stuff from Daniel                get stuff from Daniel
208                  Davids donut movie
209    
210            o constrained lab simulation            o constrained lab simulation
211              - links to ingrid output for model and lab              - links to ingrid output for model and lab
# Line 212  In general: Line 233  In general:
233  - would be nice to have an active link to the fortran-file  - would be nice to have an active link to the fortran-file
234    for all the S/R & eq.Number in the "calling-tree" boxes    for all the S/R & eq.Number in the "calling-tree" boxes
235  - search for CALC_MOM_RHS and replace it by the appropriate S/R  - search for CALC_MOM_RHS and replace it by the appropriate S/R
236    (mom_flux_form, mom_vecinv, dynamics)    (mom_flux_form, mom_vecinv, dynamics) <- DONE
237  - Problem with notation: in section.1 \vec{\bf v_h} (or \vec{\mathbf{v}}_{h})  - Problem with notation: in section.1 \vec{\bf v_h} (or \vec{\mathbf{v}}_{h})
238  was used for the horizontal velocity vector, and the 3.D vector was \vec{\mathbf{v}}  was used for the horizontal velocity vector, and the 3.D vector was \vec{\mathbf{v}}
239  in section.2, \vec{\bf v} is used instead and 3.D velocity vector is  in section.2, \vec{\bf v} is used instead and 3.D velocity vector is
# Line 223  at the beginning of section.2 and to men Line 244  at the beginning of section.2 and to men
244  the 2 sections.  the 2 sections.
245    
246  in content: Horizontal Dissipation: 2 times in vector-invariant section  in content: Horizontal Dissipation: 2 times in vector-invariant section
247    <- DONE
248    
249  2.1 time-stepping (part2/time_stepping.tex)  2.1 time-stepping (part2/time_stepping.tex)
250    
# Line 231  in content: Horizontal Dissipation: 2 ti Line 253  in content: Horizontal Dissipation: 2 ti
253  >> In all the above configurations it is also possible to substitute the  >> In all the above configurations it is also possible to substitute the
254  >> Adams-Bashforth with an alternative time-stepping scheme for terms  >> Adams-Bashforth with an alternative time-stepping scheme for terms
255  >> evaluated explicitly in time  >> evaluated explicitly in time
256    <- Leave it general.
257    
258    
259  2.2 rigid-lid:  2.2 rigid-lid:
# Line 264  in content: Horizontal Dissipation: 2 ti Line 287  in content: Horizontal Dissipation: 2 ti
287  - add link & S/R names: CALC_GW, SOLVE_FOR_PRESSURE, CG3D  - add link & S/R names: CALC_GW, SOLVE_FOR_PRESSURE, CG3D
288    
289  2.9 Variants on Free-Surface  2.9 Variants on Free-Surface
290  - Delta.t mis-written (eq.2.73)  - Delta.t mis-written (eq.2.73) <- DONE
291  - Eq.Num missing (has been fixed since)  - Eq.Num missing <- DONE
292  - u* is stored in gU (and not in gUnm1)  - u* is stored in gU (and not in gUnm1) <- DONE
293  - Phi_nh in NH_VARS.h  - Phi_nh in NH_VARS.h <- DONE
294  - add link to S/R file: SOLVE_FOR_PRESSURE, CALC_DIV_GHAT, CG2D, CG3D,  - add link to S/R file: SOLVE_FOR_PRESSURE, CALC_DIV_GHAT, CG2D, CG3D,
295    INI_CG2D, INI_CG3D    INI_CG2D, INI_CG3D
296    
# Line 277  in content: Horizontal Dissipation: 2 ti Line 300  in content: Horizontal Dissipation: 2 ti
300  2.9.2 NLFS  2.9.2 NLFS
301  - eq.Nb are wrong in html  - eq.Nb are wrong in html
302  - 2.9.2.4 : set of eq. appears wrong in html (but right in .dvi)  - 2.9.2.4 : set of eq. appears wrong in html (but right in .dvi)
303     <- DONE
304    
305  2.10.1 Notation  2.10.1 Notation
306  - Area definition is not really used like this  - Area definition is not really used like this
# Line 285  in content: Horizontal Dissipation: 2 ti Line 309  in content: Horizontal Dissipation: 2 ti
309    
310    Instead, in the following section, Ac,Aw,As,A_zeta (= corresponding to    Instead, in the following section, Ac,Aw,As,A_zeta (= corresponding to
311    the model variables) are used (e.g., see section 2.10.5)    the model variables) are used (e.g., see section 2.10.5)
312    <- DONE
313    
314  2.10.5 Horizontal grid:  2.10.5 Horizontal grid:
315  - fig.2.8 : should use Aw,As consistently in this figure description,  - fig.2.8 : should use Aw,As consistently in this figure description,
316    in the figure itself, as it is in the text.    in the figure itself, as it is in the text. <- DONE
317  - curvilinear:  - curvilinear:
318    to add: mention the angle of the grid direction relative to    to add: mention the angle of the grid direction relative to
319    Eastward, Northward direction.    Eastward, Northward direction.
# Line 339  in content: Horizontal Dissipation: 2 ti Line 364  in content: Horizontal Dissipation: 2 ti
364    
365  2.16 & 2.17 & 2.18 :  2.16 & 2.17 & 2.18 :
366   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options
367     - fix equations 2.202 & 2.203 (thanks to Martin) <- DONE
368    
369  2.20.2 mercator, non-dimensional Equations:  2.20.2 mercator, non-dimensional Equations:
370  - does not use std notation  - does not use std notation
# Line 346  in content: Horizontal Dissipation: 2 ti Line 372  in content: Horizontal Dissipation: 2 ti
372  (e.g changing the tile to:  (e.g changing the tile to:
373  - talk to Baylor  - talk to Baylor
374   Appendix: non-dimensional Equations on Spherical-Polar grid.)   Appendix: non-dimensional Equations on Spherical-Polar grid.)
375     <- No (Chris said)
376    
377    
378    Diagrams of grid locations etc.... and what variables and output files
379    and/or netcdf variable names are not very easy to figure out and follow.
380    It would be good to redo and extend these diagrams and align with GRID.h
381    content.
382    
383    
384  JM  JM
# Line 358  Chapter 3 Line 391  Chapter 3
391    
392  Almost all of the 'math mode' text is dropped down as subscripts  Almost all of the 'math mode' text is dropped down as subscripts
393    
 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?)  
 [DONE]  
   
394  3.1 - don't need a link to the outside of the document (remove it)  3.1 - don't need a link to the outside of the document (remove it)
395      - link to htdig is broken      - link to htdig is broken
396    
# Line 408  divide chapter 3 more clearly into 2 sec Line 436  divide chapter 3 more clearly into 2 sec
436          are written.          are written.
437  3.6.1.2 - needs to be moved to inside section 3.6.2  3.6.1.2 - needs to be moved to inside section 3.6.2
438    
 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  
   
439  All the 'overview' sections need some reference to the name of the experiment in  All the 'overview' sections need some reference to the name of the experiment in
440  the verification directory  the verification directory
441    
# Line 448  the verification directory Line 473  the verification directory
473                 other offline. JM thinks these need tidying up.                 other offline. JM thinks these need tidying up.
474    
475  Which of the following are which tutorial?  Which of the following are which tutorial?
476  ! MLAdjust  adjustment.128x64x1
 adjust_nlfs.cs-32x32x1  
 aim.5l_XZ_Equatorial_Slice  
 biogeo  
 aim.5l_zon-ave  
 coupled_ucla  
 cfc_offline  
 exp3  
 global2x2_tot  
 global1x1_tot  
 global_ocean.cubed_wEXF  
 global_with_CFC11  
 goz  
 gop  
 natl_box_obcs  
 natl_box_forward  
 spinup_optim  
 tutorial_held_suarez_cs  
 vero  
 inverted_barometer  
 global_ocean.cubed32x32x30  
 exp1  
 advect_cs  
 dic_example  
 fizhi-gridalt-hs  
 global_ocean_pressure  
 matrix_example  
 exp4  
 solid-body.cs-32x32x1  
 cfc_example  
 flt_example  
477  adjustment.cs-32x32x1  adjustment.cs-32x32x1
478    advect_cs
479    advect_xy
480  advect_xz  advect_xz
481  rotating_tank  aim.5l_cs
482  ideal_2D_oce  aim.5l_Equatorial_Channel
 global_ocean.90x40x15  
 front_relax  
483  aim.5l_LatLon  aim.5l_LatLon
484  lab_sea  biogeo
485  hs94.cs-32x32x5  bottom_ctrl_5x5
486  global_with_exf  cfc_example
487    cpl_aim+ocn
488    dome
489  exp2  exp2
490  tidal_basin_2d  exp4
 fizhi-cs-32x32x10  
491  exp5  exp5
492    fizhi-cs-32x32x10
493    fizhi-cs-aqualev20
494    fizhi-gridalt-hs
495    flt_example
496    front_relax
497    global1x1_tot
498    global2x2_tot
499    global_ocean.90x40x15
500  global_ocean.cs32x15  global_ocean.cs32x15
501  OpenAD  global_ocean.cubed32x32x30
 hs94.1x64x5  
 fizhi-cs-aqualev10  
 exp0  
 dome  
 aim.5l_Equatorial_Channel  
 aim.5l_cs  
 hs94.128x64x5  
 prm  
 carbon  
 plume_on_slope  
 natl_box_adjoint  
 vermix  
 cpl_aim+ocn  
502  global_ocean_ebm  global_ocean_ebm
503    global_with_exf
504    hs94.128x64x5
505    hs94.1x64x5
506    hs94.cs-32x32x5
507    ideal_2D_oce
508  internal_wave  internal_wave
509  advect_xy  inverted_barometer
510    lab_sea
511    matrix_example
512    MLAdjust
513  natl_box  natl_box
514  adjustment.128x64x1  natl_box_adjoint
515    OpenAD
516    rotating_tank
517    solid-body.cs-32x32x1
518    tidal_basin_2d
519    tutorial_baroclinic_gyre
520    tutorial_barotropic_gyre
521    tutorial_cfc_offline
522    tutorial_deep_convection
523    tutorial_global_oce_biogeo
524    tutorial_global_oce_in_p
525    tutorial_global_oce_latlon
526    tutorial_global_oce_optim
527    tutorial_held_suarez_cs
528    tutorial_offline
529    tutorial_plume_on_slope
530    tutorial_tracer_adjsens
531    vermix
532    
533  >>>> From Ed  >>>> From Ed
534    
# Line 612  zonal_filt/           - chapter 2 (JM to Line 628  zonal_filt/           - chapter 2 (JM to
628    
629  list an expeiment which uses package? CNH  list an expeiment which uses package? CNH
630    
 [DONE]Need to get packages to contain their available diagnostics (i.e. calls to DIAGNOSTICS_ADD). these are listed in stdout when pacakages are started.  
   
631  6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997  6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997
632   Figure 6.8 is missing   Figure 6.8 is missing
633    
634    
635  >>>> From Andrea  =====  Chapter 7  =====  [EH3 editing] :
636    
637  to do list for chap 7:  7.1.x - JMC: please add description of:
638            - diagstat
639            - new temporal averaging feature
640    
641    7.5.1 - add Graphix to the list of stuff in utils/matlab (Daniel)
642    
643  7.1.1 - links to section 7.1.4: the text of the first one should read "see MITgcm Kernel Diagnostics Menu"  7.5.2 - get bathymetry pre-processing stuff from Patrick
644          the links are pointing to the proper place          and then describe it
645    
646  7.5.1 - add Graphix to the list of stuff in utils/matlab  add something on spgrid mesh generator (maybe)?
 7.5.2 - empty  
647    
648    
649  andrea  andrea
650    
651    
652  9. Publications using MITgcm  9. Publications using MITgcm --> "Previous Applications of MITgcm"
653     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
654     (check in support for more names)     (check in support for more names)
655    
656  10. Under development  10. Under development
657    
658    Constantinos LCML
659    
660    
661  Bibliography  Bibliography
662    
663     tidy up from misc - .tex

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.39

  ViewVC Help
Powered by ViewVC 1.1.22