/[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.32 by edhill, Tue Jun 27 15:13:26 2006 UTC
# Line 14  o HTML, scripts and front content Line 14  o HTML, scripts and front content
14    - pick a URL    - pick a URL
15      TBD      TBD
16    
   - mitgcm.org very front page.  
     o too many clicks to get to model manual.  
       make doc link go to mitgcm.org/r2_web_testing/latest  
       and add "HowTo" reference etc... to /latest page  
   
17    - mitgcm.org/r2_web_testing/latest    - mitgcm.org/r2_web_testing/latest
18      o add another short-cut for quick download      o add another short-cut for quick download
19    
# Line 30  o HTML, scripts and front content Line 25  o HTML, scripts and front content
25        Tutorials (broken)        Tutorials (broken)
26        Browse Code        Browse Code
27    
     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?  
   
28      o words on http://mitgcm.org/r2_web_testing/latest      o words on http://mitgcm.org/r2_web_testing/latest
29        change to        change to
30         "access on-line Auser manual/A and Atable of contents/A         "access on-line Auser manual/A and Atable of contents/A
# Line 298  in content: Horizontal Dissipation: 2 ti Line 283  in content: Horizontal Dissipation: 2 ti
283    to add: mention the angle of the grid direction relative to    to add: mention the angle of the grid direction relative to
284    Eastward, Northward direction.    Eastward, Northward direction.
285    + mention horizGridFile= in file "data" (PARM04)    + mention horizGridFile= in file "data" (PARM04)
286  - add cylindrical grid description  - add cylindrical polar grid description
287     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
288    
289    
# Line 325  in content: Horizontal Dissipation: 2 ti Line 310  in content: Horizontal Dissipation: 2 ti
310      o need to relate c11, c12 etc.. to COSFAC, USE_COS etc... flags      o need to relate c11, c12 etc.. to COSFAC, USE_COS etc... flags
311        in code need to explain why cos()3/2 turns out to be        in code need to explain why cos()3/2 turns out to be
312        scaling (not cos()2)        scaling (not cos()2)
313     - need to reference the smag/leith section.
314    
315  2.13.6 Vertical dissipation  2.13.6 Vertical dissipation
316   - 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 343  in content: Horizontal Dissipation: 2 ti Line 329  in content: Horizontal Dissipation: 2 ti
329    
330  2.16 & 2.17 & 2.18 :  2.16 & 2.17 & 2.18 :
331   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options
332     - fix equations 2.202 & 2.203 (thanks to Martin)
333    
334  2.20.2 mercator, non-dimensional Equations:  2.20.2 mercator, non-dimensional Equations:
335  - does not use std notation  - does not use std notation
336  - would be better as an appendix of section 2.20:  - would be better as an appendix of section 2.20:
337  (e.g changing the tile to:  (e.g changing the tile to:
338    - talk to Baylor
339   Appendix: non-dimensional Equations on Spherical-Polar grid.)   Appendix: non-dimensional Equations on Spherical-Polar grid.)
340    
341    
342  JM  JM
343    
 >>>> From Ed  
   
 Here are the remaining bits for Chap 4 :  
   
  - The grammar/flow could still use some work.  Boo was an English  
    major and has experience editing/proofing technical papers.  I  
    could print out a copy and ask her to read it and suggest  
    improvements.  
   
  - missing references (if you point me towards URLs, I'll add them  
    to the bibliography):  
      \ref{ref hoe and hill, ecmwf}  
      \ref{magicgarden}  
      \ref{IBMLAPI}  
      \ref{Memorychannel}  
      \ref{hoe-hill:99}  
   
  - There are a few empty sub-sections at the end of Chap 4 that  
    should either be commented out or fleshed out.  
   
 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)  
   
   
 Master list of packages (add this to beginning of chap 6)  
   
 admtlm/               - autodiff (chapter 5)  
 aim/                  - retired  
 aim_compon_interf/    - 6.6 (no content yet)  
 aim_ocn_coupler/      - 6.6 (no content yet)  
 aim_v23/              - 6.4.1 (content needs fixing - JM to do)  
 atm_common/           - 6.6 (no content yet)  
 autodiff/             - autodiff (chapter 5)  
 bulk_force/           - 6.3.3  
 cal/                  - 6.3.5  
 cd_code/              - chapter 2 (JM check)  
 cfc/                  - not sure  
 chronos/              - AM to check  
 compon_communic/      - 6.6 (no content yet)  
 cost/                 - not sure, check with PH  
 ctrl/                 - not sure, check with PH  
 debug/                - JM may do something in chapter 7 (utilities)  
 diagnostics/          - 7.1  
 dic/                  - 6.7.2  
 ebm/                  - not sure  
 ecco/                 - chapter 8  
 embed_files/          - add something to chapter 7  
 ex3/                  - rename to exch3  
 exch2/                - 6.2.2  
 exf/                  - 6.3.4  
 fizhi/                - 6.4.3  
 flt/                  - in chapter 2 (JM check)  
 gchem/                - 6.7.1  
 generic_advdiff/      - in chapter 2 (JM check)  
 ggl90/                - nothing, (Martin?)  
 gmredi/               - in chapter 2 (JM check). also need  
                         Ferrari & Mc tapering  
 grdchk/               - grdchk (chapter 5 - check with PH)  
 gridalt/              - 6.2.4  
 kpp/                  - 6.3.2  
 land/                 - 6.4.2 (not connected to code - JM to fix)  
 matrix/               - Samar  
 mdsio/                - 7.3.1  
 mnc/                  - 7.2.1  
 mom_common/           - in chapter 2 (JM check)  
 mom_fluxform/         - in chapter 2 (JM check)  
 mom_vecinv/           - in chapter 2 (JM check)  
 monitor/              - 7.4  
 my82/                 - nothing, (martin?)  
 obcs/                 - 6.3 (needs a check)  
 ocn_compon_interf/    - 6.6 (no content yet)  
 offline/              - nothing, tutorials that need work but no package   section entry  
 opps/                 - nothing, (martin?)  
 pp81/                 - nothing, (martin?)  
 profiles/             - GAEL  
 ptracers/             - JM + SD to write something  
 rbcs/                 - talk to steph  
 runclock/             - runclock  
 rw/                   - not sure  
 sbo/                  - text in sbo_descruption.tex but not linked into  
                         part6  
 seaice/               - 6.5.2 - no equations, dimitris has promised some  
 shap_filt/            - chapter 2, JM to check  
 shelfice/             - nothing yet (martin?)  
 solver/               - empty  
 sphere/               - chapter 5 or 8 (PH to check)  
 therm_seaice/         - empty  
 thsice/               - 6.5.1 (JM to update?)  
 timeave/              - retiring......  
 zonal_filt/           - chapter 2 (JM to check)  
   
 Possible for chap 7 - Daniels grafix/ stuff  
   
 Need to get packages to contain their available diagnostics (i.e. calls to DIAGNOSTICS_ADD). these are listed in stdout when pacakages are started.  
   
 Figure 6.8 is missing  
   
 6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997  
  Figure 6.8 is missing  
   
   
 >>>> From Andrea  
   
 to do list for chap 7:  
   
   
 7.1.1 - links to section 7.1.4: the text of the first one should read "see MITgcm Kernel Diagnostics Menu"  
         the links are pointing to the proper place  
   
 7.5.1 - add Graphix to the list of stuff in utils/matlab  
 7.5.2 - empty  
   
   
 andrea  
344    
345  >>>> From Andrea  >>>> From Andrea
346    
# Line 482  Chapter 3 Line 349  Chapter 3
349    
350  Almost all of the 'math mode' text is dropped down as subscripts  Almost all of the 'math mode' text is dropped down as subscripts
351    
 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?)  
   
352  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)
353      - link to htdig is broken      - link to htdig is broken
354    
# Line 531  divide chapter 3 more clearly into 2 sec Line 394  divide chapter 3 more clearly into 2 sec
394          are written.          are written.
395  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
396    
 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  
   
397  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
398  the verification directory  the verification directory
399    
# Line 570  the verification directory Line 430  the verification directory
430       offline - duplicate inputs, what is it, tidy up cfc v.       offline - duplicate inputs, what is it, tidy up cfc v.
431                 other offline. JM thinks these need tidying up.                 other offline. JM thinks these need tidying up.
432    
433    Which of the following are which tutorial?
434    adjustment.128x64x1
435    adjustment.cs-32x32x1
436    advect_cs
437    advect_xy
438    advect_xz
439    aim.5l_cs
440    aim.5l_Equatorial_Channel
441    aim.5l_LatLon
442    biogeo
443    bottom_ctrl_5x5
444    cfc_example
445    cpl_aim+ocn
446    dome
447    exp2
448    exp4
449    exp5
450    fizhi-cs-32x32x10
451    fizhi-cs-aqualev20
452    fizhi-gridalt-hs
453    flt_example
454    front_relax
455    global1x1_tot
456    global2x2_tot
457    global_ocean.90x40x15
458    global_ocean.cs32x15
459    global_ocean.cubed32x32x30
460    global_ocean_ebm
461    global_with_exf
462    hs94.128x64x5
463    hs94.1x64x5
464    hs94.cs-32x32x5
465    ideal_2D_oce
466    internal_wave
467    inverted_barometer
468    lab_sea
469    matrix_example
470    MLAdjust
471    natl_box
472    natl_box_adjoint
473    OpenAD
474    rotating_tank
475    solid-body.cs-32x32x1
476    tidal_basin_2d
477    tutorial_baroclinic_gyre
478    tutorial_barotropic_gyre
479    tutorial_cfc_offline
480    tutorial_deep_convection
481    tutorial_global_oce_biogeo
482    tutorial_global_oce_in_p
483    tutorial_global_oce_latlon
484    tutorial_global_oce_optim
485    tutorial_held_suarez_cs
486    tutorial_offline
487    tutorial_plume_on_slope
488    tutorial_tracer_adjsens
489    vermix
490    
491    >>>> From Ed
492    
493    Here are the remaining bits for Chap 4 :
494    
495     - missing references (if you point me towards URLs, I'll add them
496       to the bibliography):
497         \ref{ref hoe and hill, ecmwf}
498         \ref{magicgarden}
499         \ref{IBMLAPI}
500         \ref{Memorychannel}
501         \ref{hoe-hill:99}
502    
503     - There are a few empty sub-sections at the end of Chap 4 that
504       should either be commented out or fleshed out.
505    
506    and thats about it for Chap 4.
507    
508    
509  9. Model uses  Add more to quick links on front page
510    
511    Chapter 6
512    
513       the master package diagram does not appear in the document
514    
515    Master list of packages (add this to beginning of chap 6)
516    
517    admtlm/               - autodiff (chapter 5)
518    aim/                  - retired
519    aim_compon_interf/    - 6.6 (no content yet)(Daniel + JM)
520    aim_ocn_coupler/      - 6.6 (no content yet)
521    aim_v23/              - 6.4.1 (content needs fixing - JM to do)
522    atm_common/           - nothing in this package (6.4.1 related)
523    autodiff/             - autodiff (chapter 5)
524    bulk_force/           - 6.3.3
525    cal/                  - 6.3.5
526    cd_code/              - chapter 2 (JM check add a reference to paper,
527                              mention parameter in data)
528    cfc/                  - not sure  (CNH to talk to Steph and Helen)
529    chronos/              - AM to check (not being used - Andrea to kill it)
530    compon_communic/      - 6.6 (no content yet)(Daniel + JM)
531    cost/                 - not sure, check with PH
532    ctrl/                 - not sure, check with PH
533    debug/                - JM may do something in chapter 7 (utilities)
534    diagnostics/          - 7.1
535    dic/                  - 6.7.2
536    ebm/                  - (check with PH)
537    ecco/                 - chapter 8
538    embed_files/          - add something to chapter 7
539    exch2/                - 6.2.2
540    exf/                  - 6.3.4
541    fizhi/                - 6.4.3
542    flt/                  - (PH check)
543    gchem/                - 6.7.1
544    generic_advdiff/      - in chapter 2 (JM check)
545    ggl90/                - nothing, (Martin?)
546    gmredi/               - in chapter 2 (JM check). also need
547                            Ferrari & Mc transition zone stuff (Samar doing this)
548                            get dfer to read this
549    grdchk/               - grdchk (chapter 5 - check with PH)
550    gridalt/              - 6.2.4
551    kpp/                  - 6.3.2
552    land/                 - 6.4.2 (not connected to code Rong's notes - JM to fix)
553    matrix/               - Samar
554    mdsio/                - 7.3.1
555    mnc/                  - 7.2.1
556    mom_common/           - in chapter 2 (JM check)
557    mom_fluxform/         - in chapter 2 (JM check)
558    mom_vecinv/           - in chapter 2 (JM check)
559    monitor/              - 7.4
560    my82/                 - nothing, (martin?)
561    obcs/                 - 6.3 (needs a check - ask PH to read)
562    ocn_compon_interf/    - 6.6 (no content yet)
563    offline/              - nothing, tutorials that need work but no package   section entry
564                            trivial to document (CNH to do)
565    opps/                 - nothing, (martin?)
566    pp81/                 - nothing, (martin?)
567    profiles/             - GAEL
568    ptracers/             - JM + SD + Martin to write something (nothing for this
569                              at the moment)
570                            AM has diagnostics table for this.
571    rbcs/                 - CNH to talk to steph
572    runclock/             - runclock - CNH
573    rw/                   - not sure - going to stay says JMC. quick IO calls
574                            JMC to write a quick note for that.
575    sbo/                  - text in sbo_descruption.tex but not linked into
576                            part6 - CNH
577    seaice/               - 6.5.2 - no equations, dimitris has promised some
578    shap_filt/            - chapter 2, JM to check
579    shelfice/             - nothing yet (martin?)
580    solver/               - empty (go away?)
581    sphere/               - chapter 5 or 8 (PH to check)
582    therm_seaice/         - empty (go away?)
583    thsice/               - 6.5.1 (JM to update?)
584    timeave/              - retiring......
585    zonal_filt/           - chapter 2 (JM to check)
586    
587    list an expeiment which uses package? CNH
588    
589    6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997
590     Figure 6.8 is missing
591    
592    
593    =====  Chapter 7  =====  [EH3 editing] :
594    
595    7.1.1 - links to section 7.1.4: the text of the first
596            one should read "see MITgcm Kernel Diagnostics Menu"
597            the links are pointing to the proper place
598    
599    7.5.1 - add Graphix to the list of stuff in utils/matlab (Daniel)
600    
601    7.5.2 - get bathymetry pre-processing stuff from Patrick
602            and then describe it
603    
604    
605    andrea
606    
607    
608    9. Publications using MITgcm --> "Previous Applications of MITgcm"
609     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
610     (check in support for more names)     (check in support for more names)
611    
612    10. Under development
613    
614    
615    Bibliography
616    
617     tidy up from misc - .tex
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.32
  ViewVC Help
Powered by ViewVC 1.1.22