/[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.13 by cnh, Thu Apr 6 20:13:23 2006 UTC revision 1.28 by edhill, Fri Apr 7 02:35:23 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 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 365  Almost all of the 'math mode' text is dr Line 351  Almost all of the 'math mode' text is dr
351  divide chapter 3 more clearly into 2 sections?  divide chapter 3 more clearly into 2 sections?
352     (ie, 3.1-3.6 are more informational, 3.8- 3.18 are examples, and     (ie, 3.1-3.6 are more informational, 3.8- 3.18 are examples, and
353      then 3.19 and 3.20 are informational again - rearrange subsections?)      then 3.19 and 3.20 are informational again - rearrange subsections?)
354    [DONE]
355    
356  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)
357      - link to htdig is broken      - link to htdig is broken
# Line 449  the verification directory Line 436  the verification directory
436    
437       offline - duplicate inputs, what is it, tidy up cfc v.       offline - duplicate inputs, what is it, tidy up cfc v.
438                 other offline. JM thinks these need tidying up.                 other offline. JM thinks these need tidying up.
439    
440    Which of the following are which tutorial?
441    ! MLAdjust
442    adjust_nlfs.cs-32x32x1
443    aim.5l_XZ_Equatorial_Slice
444    biogeo
445    aim.5l_zon-ave
446    coupled_ucla
447    cfc_offline
448    exp3
449    global2x2_tot
450    global1x1_tot
451    global_ocean.cubed_wEXF
452    global_with_CFC11
453    goz
454    gop
455    natl_box_obcs
456    natl_box_forward
457    spinup_optim
458    tutorial_held_suarez_cs
459    vero
460    inverted_barometer
461    global_ocean.cubed32x32x30
462    exp1
463    advect_cs
464    dic_example
465    fizhi-gridalt-hs
466    global_ocean_pressure
467    matrix_example
468    exp4
469    solid-body.cs-32x32x1
470    cfc_example
471    flt_example
472    adjustment.cs-32x32x1
473    advect_xz
474    rotating_tank
475    ideal_2D_oce
476    global_ocean.90x40x15
477    front_relax
478    aim.5l_LatLon
479    lab_sea
480    hs94.cs-32x32x5
481    global_with_exf
482    exp2
483    tidal_basin_2d
484    fizhi-cs-32x32x10
485    exp5
486    global_ocean.cs32x15
487    OpenAD
488    hs94.1x64x5
489    fizhi-cs-aqualev10
490    exp0
491    dome
492    aim.5l_Equatorial_Channel
493    aim.5l_cs
494    hs94.128x64x5
495    prm
496    carbon
497    plume_on_slope
498    natl_box_adjoint
499    vermix
500    cpl_aim+ocn
501    global_ocean_ebm
502    internal_wave
503    advect_xy
504    natl_box
505    adjustment.128x64x1
506    
507  >>>> From Ed  >>>> From Ed
508    
509  Here are the remaining bits for Chap 4 :  Here are the remaining bits for Chap 4 :
510    
  - 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.  
   
511   - missing references (if you point me towards URLs, I'll add them   - missing references (if you point me towards URLs, I'll add them
512     to the bibliography):     to the bibliography):
513       \ref{ref hoe and hill, ecmwf}       \ref{ref hoe and hill, ecmwf}
# Line 478  Chapter 6 Line 528  Chapter 6
528    
529     the master package diagram does not appear in the document     the master package diagram does not appear in the document
530    
    pkg/ptracers doesn't seem to have any documentation (see packages list below)  
   
   
531  Master list of packages (add this to beginning of chap 6)  Master list of packages (add this to beginning of chap 6)
532    
533  admtlm/               - autodiff (chapter 5)  admtlm/               - autodiff (chapter 5)
534  aim/                  - retired  aim/                  - retired
535  aim_compon_interf/    - 6.6 (no content yet)  aim_compon_interf/    - 6.6 (no content yet)(Daniel + JM)
536  aim_ocn_coupler/      - 6.6 (no content yet)  aim_ocn_coupler/      - 6.6 (no content yet)
537  aim_v23/              - 6.4.1 (content needs fixing - JM to do)  aim_v23/              - 6.4.1 (content needs fixing - JM to do)
538  atm_common/           - 6.6 (no content yet)  atm_common/           - nothing in this package (6.4.1 related)
539  autodiff/             - autodiff (chapter 5)  autodiff/             - autodiff (chapter 5)
540  bulk_force/           - 6.3.3  bulk_force/           - 6.3.3
541  cal/                  - 6.3.5  cal/                  - 6.3.5
542  cd_code/              - chapter 2 (JM check)  cd_code/              - chapter 2 (JM check add a reference to paper,
543  cfc/                  - not sure                            mention parameter in data)
544  chronos/              - AM to check  cfc/                  - not sure  (CNH to talk to Steph and Helen)
545  compon_communic/      - 6.6 (no content yet)  chronos/              - AM to check (not being used - Andrea to kill it)
546    compon_communic/      - 6.6 (no content yet)(Daniel + JM)
547  cost/                 - not sure, check with PH  cost/                 - not sure, check with PH
548  ctrl/                 - not sure, check with PH  ctrl/                 - not sure, check with PH
549  debug/                - JM may do something in chapter 7 (utilities)  debug/                - JM may do something in chapter 7 (utilities)
550  diagnostics/          - 7.1  diagnostics/          - 7.1
551  dic/                  - 6.7.2  dic/                  - 6.7.2
552  ebm/                  - not sure  ebm/                  - (check with PH)
553  ecco/                 - chapter 8  ecco/                 - chapter 8
554  embed_files/          - add something to chapter 7  embed_files/          - add something to chapter 7
 ex3/                  - rename to exch3  
555  exch2/                - 6.2.2  exch2/                - 6.2.2
556  exf/                  - 6.3.4  exf/                  - 6.3.4
557  fizhi/                - 6.4.3  fizhi/                - 6.4.3
558  flt/                  - in chapter 2 (JM check)  flt/                  - (PH check)
559  gchem/                - 6.7.1  gchem/                - 6.7.1
560  generic_advdiff/      - in chapter 2 (JM check)  generic_advdiff/      - in chapter 2 (JM check)
561  ggl90/                - nothing, (Martin?)  ggl90/                - nothing, (Martin?)
562  gmredi/               - in chapter 2 (JM check). also need  gmredi/               - in chapter 2 (JM check). also need
563                          Ferrari & Mc tapering                          Ferrari & Mc transition zone stuff (Samar doing this)
564                            get dfer to read this
565  grdchk/               - grdchk (chapter 5 - check with PH)  grdchk/               - grdchk (chapter 5 - check with PH)
566  gridalt/              - 6.2.4  gridalt/              - 6.2.4
567  kpp/                  - 6.3.2  kpp/                  - 6.3.2
568  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)
569  matrix/               - Samar  matrix/               - Samar
570  mdsio/                - 7.3.1  mdsio/                - 7.3.1
571  mnc/                  - 7.2.1  mnc/                  - 7.2.1
# Line 526  mom_fluxform/         - in chapter 2 (JM Line 574  mom_fluxform/         - in chapter 2 (JM
574  mom_vecinv/           - in chapter 2 (JM check)  mom_vecinv/           - in chapter 2 (JM check)
575  monitor/              - 7.4  monitor/              - 7.4
576  my82/                 - nothing, (martin?)  my82/                 - nothing, (martin?)
577  obcs/                 - 6.3 (needs a check)  obcs/                 - 6.3 (needs a check - ask PH to read)
578  ocn_compon_interf/    - 6.6 (no content yet)  ocn_compon_interf/    - 6.6 (no content yet)
579  offline/              - nothing, tutorials that need work but no package   section entry  offline/              - nothing, tutorials that need work but no package   section entry
580                            trivial to document (CNH to do)
581  opps/                 - nothing, (martin?)  opps/                 - nothing, (martin?)
582  pp81/                 - nothing, (martin?)  pp81/                 - nothing, (martin?)
583  profiles/             - GAEL  profiles/             - GAEL
584  ptracers/             - JM + SD to write something  ptracers/             - JM + SD + Martin to write something (nothing for this
585  rbcs/                 - talk to steph                            at the moment)
586  runclock/             - runclock                          AM has diagnostics table for this.
587  rw/                   - not sure  rbcs/                 - CNH to talk to steph
588    runclock/             - runclock - CNH
589    rw/                   - not sure - going to stay says JMC. quick IO calls
590                            JMC to write a quick note for that.
591  sbo/                  - text in sbo_descruption.tex but not linked into  sbo/                  - text in sbo_descruption.tex but not linked into
592                          part6                          part6 - CNH
593  seaice/               - 6.5.2 - no equations, dimitris has promised some  seaice/               - 6.5.2 - no equations, dimitris has promised some
594  shap_filt/            - chapter 2, JM to check  shap_filt/            - chapter 2, JM to check
595  shelfice/             - nothing yet (martin?)  shelfice/             - nothing yet (martin?)
596  solver/               - empty  solver/               - empty (go away?)
597  sphere/               - chapter 5 or 8 (PH to check)  sphere/               - chapter 5 or 8 (PH to check)
598  therm_seaice/         - empty  therm_seaice/         - empty (go away?)
599  thsice/               - 6.5.1 (JM to update?)  thsice/               - 6.5.1 (JM to update?)
600  timeave/              - retiring......  timeave/              - retiring......
601  zonal_filt/           - chapter 2 (JM to check)  zonal_filt/           - chapter 2 (JM to check)
602    
603  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.  
604    
605  Figure 6.8 is missing  [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.
606    
607  6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997  6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997
608   Figure 6.8 is missing   Figure 6.8 is missing
# Line 573  to do list for chap 7: Line 623  to do list for chap 7:
623  andrea  andrea
624    
625    
626  9. Model uses  9. Publications using MITgcm --> "Previous Applications of MITgcm"
627     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...     Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
628     (check in support for more names)     (check in support for more names)
629    
630    10. Under development
631    
632    
633    Bibliography
634    
635     tidy up from misc - .tex
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.28
  ViewVC Help
Powered by ViewVC 1.1.22