--- manual/manual_todo.txt 2006/04/06 20:13:23 1.13 +++ manual/manual_todo.txt 2006/04/06 20:54:14 1.23 @@ -14,11 +14,6 @@ - pick a URL TBD - - 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 - - mitgcm.org/r2_web_testing/latest o add another short-cut for quick download @@ -325,6 +320,7 @@ 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) + - need to reference the smag/leith section. 2.13.6 Vertical dissipation - mention the implicit vertical viscosity option and ref to section 2.5 @@ -365,6 +361,7 @@ 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] 3.1 - don't need a link to the outside of the document (remove it) - link to htdig is broken @@ -449,15 +446,78 @@ offline - duplicate inputs, what is it, tidy up cfc v. other offline. JM thinks these need tidying up. + +Which of the following are which tutorial? +! MLAdjust +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 +adjustment.cs-32x32x1 +advect_xz +rotating_tank +ideal_2D_oce +global_ocean.90x40x15 +front_relax +aim.5l_LatLon +lab_sea +hs94.cs-32x32x5 +global_with_exf +exp2 +tidal_basin_2d +fizhi-cs-32x32x10 +exp5 +global_ocean.cs32x15 +OpenAD +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 +global_ocean_ebm +internal_wave +advect_xy +natl_box +adjustment.128x64x1 + >>>> 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} @@ -478,46 +538,44 @@ 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_compon_interf/ - 6.6 (no content yet)(Daniel + JM) 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) +atm_common/ - nothing in this package (6.4.1 related) 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) +cd_code/ - chapter 2 (JM check add a reference to paper, + mention parameter in data) +cfc/ - not sure (CNH to talk to Steph and Helen) +chronos/ - AM to check (not being used - Andrea to kill it) +compon_communic/ - 6.6 (no content yet)(Daniel + JM) 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 +ebm/ - (check with PH) 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) +flt/ - (PH 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 + Ferrari & Mc transition zone stuff (Samar doing this) + get dfer to read this 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) +land/ - 6.4.2 (not connected to code Rong's notes - JM to fix) matrix/ - Samar mdsio/ - 7.3.1 mnc/ - 7.2.1 @@ -526,33 +584,35 @@ mom_vecinv/ - in chapter 2 (JM check) monitor/ - 7.4 my82/ - nothing, (martin?) -obcs/ - 6.3 (needs a check) +obcs/ - 6.3 (needs a check - ask PH to read) ocn_compon_interf/ - 6.6 (no content yet) offline/ - nothing, tutorials that need work but no package section entry + trivial to document (CNH to do) opps/ - nothing, (martin?) pp81/ - nothing, (martin?) profiles/ - GAEL -ptracers/ - JM + SD to write something -rbcs/ - talk to steph -runclock/ - runclock -rw/ - not sure +ptracers/ - JM + SD + Martin to write something (nothing for this + at the moment) + AM has diagnostics table for this. +rbcs/ - CNH to talk to steph +runclock/ - runclock - CNH +rw/ - not sure - going to stay says JMC. quick IO calls + JMC to write a quick note for that. sbo/ - text in sbo_descruption.tex but not linked into - part6 + part6 - CNH seaice/ - 6.5.2 - no equations, dimitris has promised some shap_filt/ - chapter 2, JM to check shelfice/ - nothing yet (martin?) -solver/ - empty +solver/ - empty (go away?) sphere/ - chapter 5 or 8 (PH to check) -therm_seaice/ - empty +therm_seaice/ - empty (go away?) 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. +list an expeiment which uses package? CNH -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. 6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997 Figure 6.8 is missing