/[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.16 by cnh, Thu Apr 6 20:34:06 2006 UTC revision 1.33 by cnh, Tue Jun 27 15:22:03 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    
30    
31  Rebuild and set to do cron build - DONE on hugo  Rebuild and set to do cron build - DONE on hugo
32    
33  To do  To do
# Line 8  To do Line 38  To do
38      Add an "Under development, chapter" - shortish description of what      Add an "Under development, chapter" - shortish description of what
39      is available (last chapter)      is available (last chapter)
40    
41      - add in example latex for formatting author names in different pieces.
42        this aknowledges peoples contributions and gives ref for who
43        to talk to.
44    
45    
46  o HTML, scripts and front content  o HTML, scripts and front content
47    
# Line 25  o HTML, scripts and front content Line 59  o HTML, scripts and front content
59        Tutorials (broken)        Tutorials (broken)
60        Browse Code        Browse Code
61    
     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?  
   
62      o words on http://mitgcm.org/r2_web_testing/latest      o words on http://mitgcm.org/r2_web_testing/latest
63        change to        change to
64         "access on-line Auser manual/A and Atable of contents/A         "access on-line Auser manual/A and Atable of contents/A
# Line 339  in content: Horizontal Dissipation: 2 ti Line 363  in content: Horizontal Dissipation: 2 ti
363    
364  2.16 & 2.17 & 2.18 :  2.16 & 2.17 & 2.18 :
365   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options
366     - fix equations 2.202 & 2.203 (thanks to Martin)
367    
368  2.20.2 mercator, non-dimensional Equations:  2.20.2 mercator, non-dimensional Equations:
369  - does not use std notation  - does not use std notation
# Line 358  Chapter 3 Line 383  Chapter 3
383    
384  Almost all of the 'math mode' text is dropped down as subscripts  Almost all of the 'math mode' text is dropped down as subscripts
385    
 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]  
   
386  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)
387      - link to htdig is broken      - link to htdig is broken
388    
# Line 408  divide chapter 3 more clearly into 2 sec Line 428  divide chapter 3 more clearly into 2 sec
428          are written.          are written.
429  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
430    
 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  
   
431  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
432  the verification directory  the verification directory
433    
# Line 448  the verification directory Line 465  the verification directory
465                 other offline. JM thinks these need tidying up.                 other offline. JM thinks these need tidying up.
466    
467  Which of the following are which tutorial?  Which of the following are which tutorial?
468  ! 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  
469  adjustment.cs-32x32x1  adjustment.cs-32x32x1
470    advect_cs
471    advect_xy
472  advect_xz  advect_xz
473  rotating_tank  aim.5l_cs
474  ideal_2D_oce  aim.5l_Equatorial_Channel
 global_ocean.90x40x15  
 front_relax  
475  aim.5l_LatLon  aim.5l_LatLon
476  lab_sea  biogeo
477  hs94.cs-32x32x5  bottom_ctrl_5x5
478  global_with_exf  cfc_example
479    cpl_aim+ocn
480    dome
481  exp2  exp2
482  tidal_basin_2d  exp4
 fizhi-cs-32x32x10  
483  exp5  exp5
484    fizhi-cs-32x32x10
485    fizhi-cs-aqualev20
486    fizhi-gridalt-hs
487    flt_example
488    front_relax
489    global1x1_tot
490    global2x2_tot
491    global_ocean.90x40x15
492  global_ocean.cs32x15  global_ocean.cs32x15
493  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  
494  global_ocean_ebm  global_ocean_ebm
495    global_with_exf
496    hs94.128x64x5
497    hs94.1x64x5
498    hs94.cs-32x32x5
499    ideal_2D_oce
500  internal_wave  internal_wave
501  advect_xy  inverted_barometer
502    lab_sea
503    matrix_example
504    MLAdjust
505  natl_box  natl_box
506  adjustment.128x64x1  natl_box_adjoint
507    OpenAD
508    rotating_tank
509    solid-body.cs-32x32x1
510    tidal_basin_2d
511    tutorial_baroclinic_gyre
512    tutorial_barotropic_gyre
513    tutorial_cfc_offline
514    tutorial_deep_convection
515    tutorial_global_oce_biogeo
516    tutorial_global_oce_in_p
517    tutorial_global_oce_latlon
518    tutorial_global_oce_optim
519    tutorial_held_suarez_cs
520    tutorial_offline
521    tutorial_plume_on_slope
522    tutorial_tracer_adjsens
523    vermix
524    
525  >>>> From Ed  >>>> From Ed
526    
# Line 538  Chapter 6 Line 546  Chapter 6
546    
547     the master package diagram does not appear in the document     the master package diagram does not appear in the document
548    
    pkg/ptracers doesn't seem to have any documentation (see packages list below)  
                 martin volunteered - get martin to ask steph  
   
   
549  Master list of packages (add this to beginning of chap 6)  Master list of packages (add this to beginning of chap 6)
550    
551  admtlm/               - autodiff (chapter 5)  admtlm/               - autodiff (chapter 5)
# Line 566  dic/                  - 6.7.2 Line 570  dic/                  - 6.7.2
570  ebm/                  - (check with PH)  ebm/                  - (check with PH)
571  ecco/                 - chapter 8  ecco/                 - chapter 8
572  embed_files/          - add something to chapter 7  embed_files/          - add something to chapter 7
 ex3/                  - move to contrib (EH)  
573  exch2/                - 6.2.2  exch2/                - 6.2.2
574  exf/                  - 6.3.4  exf/                  - 6.3.4
575  fizhi/                - 6.4.3  fizhi/                - 6.4.3
576  flt/                  - in chapter 2 (JM check)  flt/                  - (PH check)
577  gchem/                - 6.7.1  gchem/                - 6.7.1
578  generic_advdiff/      - in chapter 2 (JM check)  generic_advdiff/      - in chapter 2 (JM check)
579  ggl90/                - nothing, (Martin?)  ggl90/                - nothing, (Martin?)
580  gmredi/               - in chapter 2 (JM check). also need  gmredi/               - in chapter 2 (JM check). also need
581                          Ferrari & Mc tapering                          Ferrari & Mc transition zone stuff (Samar doing this)
582                            get dfer to read this
583  grdchk/               - grdchk (chapter 5 - check with PH)  grdchk/               - grdchk (chapter 5 - check with PH)
584  gridalt/              - 6.2.4  gridalt/              - 6.2.4
585  kpp/                  - 6.3.2  kpp/                  - 6.3.2
586  land/                 - 6.4.2 (not connected to code - JM to fix)  land/                 - 6.4.2 (not connected to code Rong's notes - JM to fix)
587  matrix/               - Samar  matrix/               - Samar
588  mdsio/                - 7.3.1  mdsio/                - 7.3.1
589  mnc/                  - 7.2.1  mnc/                  - 7.2.1
# Line 588  mom_fluxform/         - in chapter 2 (JM Line 592  mom_fluxform/         - in chapter 2 (JM
592  mom_vecinv/           - in chapter 2 (JM check)  mom_vecinv/           - in chapter 2 (JM check)
593  monitor/              - 7.4  monitor/              - 7.4
594  my82/                 - nothing, (martin?)  my82/                 - nothing, (martin?)
595  obcs/                 - 6.3 (needs a check)  obcs/                 - 6.3 (needs a check - ask PH to read)
596  ocn_compon_interf/    - 6.6 (no content yet)  ocn_compon_interf/    - 6.6 (no content yet)
597  offline/              - nothing, tutorials that need work but no package   section entry  offline/              - nothing, tutorials that need work but no package   section entry
598                            trivial to document (CNH to do)
599  opps/                 - nothing, (martin?)  opps/                 - nothing, (martin?)
600  pp81/                 - nothing, (martin?)  pp81/                 - nothing, (martin?)
601  profiles/             - GAEL  profiles/             - GAEL
602  ptracers/             - JM + SD to write something  ptracers/             - JM + SD + Martin to write something (nothing for this
603  rbcs/                 - talk to steph                            at the moment)
604  runclock/             - runclock                          AM has diagnostics table for this.
605  rw/                   - not sure  rbcs/                 - CNH to talk to steph
606    runclock/             - runclock - CNH
607    rw/                   - not sure - going to stay says JMC. quick IO calls
608                            JMC to write a quick note for that.
609  sbo/                  - text in sbo_descruption.tex but not linked into  sbo/                  - text in sbo_descruption.tex but not linked into
610                          part6                          part6 - CNH
611  seaice/               - 6.5.2 - no equations, dimitris has promised some  seaice/               - 6.5.2 - no equations, dimitris has promised some
612  shap_filt/            - chapter 2, JM to check  shap_filt/            - chapter 2, JM to check
613  shelfice/             - nothing yet (martin?)  shelfice/             - nothing yet (martin?)
614  solver/               - empty  solver/               - empty (go away?)
615  sphere/               - chapter 5 or 8 (PH to check)  sphere/               - chapter 5 or 8 (PH to check)
616  therm_seaice/         - empty  therm_seaice/         - empty (go away?)
617  thsice/               - 6.5.1 (JM to update?)  thsice/               - 6.5.1 (JM to update?)
618  timeave/              - retiring......  timeave/              - retiring......
619  zonal_filt/           - chapter 2 (JM to check)  zonal_filt/           - chapter 2 (JM to check)
620    
621  Possible for chap 7 - Daniels grafix/ stuff  list an expeiment which uses package? CNH
   
 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  
622    
623  6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997  6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997
624   Figure 6.8 is missing   Figure 6.8 is missing
625    
626    
627  >>>> From Andrea  =====  Chapter 7  =====  [EH3 editing] :
   
 to do list for chap 7:  
   
628    
629  7.1.1 - links to section 7.1.4: the text of the first one should read "see MITgcm Kernel Diagnostics Menu"  7.1.1 - links to section 7.1.4: the text of the first
630            one should read "see MITgcm Kernel Diagnostics Menu"
631          the links are pointing to the proper place          the links are pointing to the proper place
632    
633  7.5.1 - add Graphix to the list of stuff in utils/matlab  7.5.1 - add Graphix to the list of stuff in utils/matlab (Daniel)
634  7.5.2 - empty  
635    7.5.2 - get bathymetry pre-processing stuff from Patrick
636            and then describe it
637    
638    
639  andrea  andrea
640    
641    
642  9. Model uses  9. Publications using MITgcm --> "Previous Applications of MITgcm"
643     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
644     (check in support for more names)     (check in support for more names)
645    
646    10. Under development
647    
648    
649    Bibliography
650    
651     tidy up from misc - .tex
Legend:
Removed from v.1.16  
changed lines
  Added in v.1.33
  ViewVC Help
Powered by ViewVC 1.1.22