/[MITgcm]/manual/manual_todo.txt
ViewVC logotype

Contents of /manual/manual_todo.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.28 - (show annotations) (download)
Fri Apr 7 02:35:23 2006 UTC (18 years ago) by edhill
Branch: MAIN
Changes since 1.27: +1 -11 lines
File MIME type: text/plain
change "model uses" to "Previous Applications of MITgcm"

1 Rebuild and set to do cron build - DONE on hugo
2
3 To do
4
5 - where to put under development links?
6 JMC would like to have some mention of unfinished things (checked in
7 but not that tested e.g. AB3)
8 Add an "Under development, chapter" - shortish description of what
9 is available (last chapter)
10
11
12 o HTML, scripts and front content
13
14 - pick a URL
15 TBD
16
17 - mitgcm.org/r2_web_testing/latest
18 o add another short-cut for quick download
19
20 o add another short-cut
21 About
22 Installation
23 Contents
24 Overview
25 Tutorials (broken)
26 Browse Code
27
28 o words on http://mitgcm.org/r2_web_testing/latest
29 change to
30 "access on-line Auser manual/A and Atable of contents/A
31 and browse the Aoverview section/A"
32
33 o finite-volume doesn't leap to FV figure
34
35 o have another go at pnmcrop et al.
36
37 o Need an empty package as part of distribution. Check out atm_common
38
39 o Latex
40
41 Chapter 1 - CNH
42 o single kernel diagram -
43 add reference to MWR paper
44
45 o non-hydro
46 add reference to 1995 and 1999 papers
47 pdf of 1995 paper
48
49 o FV
50 add references to 1997 papers.
51
52 o Tangent linear/adjoint add reference to
53 Heimbach papers, Marotzke, 1998 ECMWF, Bugi etc...
54
55 o platforms
56 Add reference to SC article and Scientific Programming article
57
58 o List of key papers needs to be updated and reformatted
59
60
61 o Global atmosphere: `Held Suarez',
62 update Adcroft reference
63 fix up ingrid link and frame (ingrid movies seem to be broken?)
64 Held and Suarez reference is not a link.
65
66 o Ocean Gyres
67 fix up frame link
68 make "lopped cell" a link to referenced paper.
69 add references (ask Steph/Mick)
70 online/offline paper
71
72 o Convection and mixing over topography
73 add in Legg references for convection and mixing over topography
74 and external link to CPT-GCE etc...
75
76 o Boundary forced internal waves
77 add in Legg references, obc's reference
78
79 o Parameter sensitivity
80 add in Bugnion references, Boyin references, Steph references
81
82 o State estimation
83 add in references from Patrick/Carl/Ichiro/Detlef etc...
84 update links to point to latest ECCO results
85 ECCO ingrid results have been moved
86 add forward links to "ECCO state estimation" chapter in manual
87
88 o Ocean biogeochemical cycles
89 add in references from Mick/Galen etc...
90 fix ingrid link ( date to date thing does not appear to work)
91 figure url does not have a "target=idontexist" entry
92
93 o Simulations of laboratory experiments
94 reference Wardle and Karsten papers
95 update links to include DDDAS "PIAB" page
96 cylindrical polar coordinates
97
98 o Continuos equations in ''r'' coordinates
99 add references to iso paper
100 no mention of z* and p* - forward reference to z*/p* in 2.
101 add that coupling also manifests through F, Q
102 add tracer transport
103
104 o Kinematic boundary conditions
105
106 o Hydrostatic, Quasi-hydrostatic, Quasi-nonhydrostatic and
107 Non-hydrostatic forms
108 need to tidy up discussion of shallow-atmosphere to be
109 consistent with the code or change code to be consistent
110 with the discussion!
111 make references hyperlinks
112 add stuff too
113 JMC remove QNH atmosphere
114 need to sort out calc_gw for deep atmosphere
115
116 o Finding the pressure field
117 make references hyperlinks
118 add forward references to manual algorithm section
119 change Elliptic to "elliptic"
120
121 o Forcing and dissipation
122 make "physics packages" refer to chapter 6.
123 should we move "external forcing" et. al to a
124 generic_forcing_driver package?
125
126 viscosities
127 update to mention Smag/Leith (Ah and A4 not constant)
128 and to have forward references to numerical section
129 tracers
130 forward references to numerical section, reddy, GM etc...
131 add references to literature
132
133 o 1.3.8 Vector invariant form
134 forward references to numerical section
135
136 o 1.3.9 Adjoint
137 add a little more here + some hyperlink to chapter 5.
138
139 o 1.4 Appendix ATMOSPHERE
140
141 add some introductory words
142
143 o 1.6 Coordinate systems
144 o only has some words on spherical polar. add some brief words
145 to cover all of
146 - cartesian
147 - spherical
148 - cylindrical
149 - general orthogonal curvilinear (vector invariant)
150
151 o Equation of state options
152 add some discussion
153 can't remember what we said we were going to do here
154 PH to do something
155
156
157 Change hydrodynamical to "dynamical"
158
159 Examples
160
161 - extra "in action" cases
162
163 o high res ocean with diurnal atmospheric state forcing
164 - links to ingrid output
165 CNH/Dimitris
166
167 o realistic FIZHI from Andrea
168 - links to ingrid output
169 from AM
170
171 o with seaice on high res cube
172 - links to ingrid output
173 CNH/Dimitris
174
175 o coupled aqua, ridge world etc...
176 - links to ingrid output
177 get stuff from Daniel
178
179 o constrained lab simulation
180 - links to ingrid output for model and lab
181 fields
182 get stuff from Sai/Andrew
183
184 o sensitivity wrt to iron
185
186 o optimization
187 - update to link to latest ECCO sites and GF
188 related material
189
190 o eddy diffusivity transport application
191
192 o Gas giant?
193
194
195 >>>> from JM
196
197
198 manual, section.2 :
199
200 In general:
201 - add more refences/links to S/R & variable name
202 - would be nice to have an active link to the fortran-file
203 for all the S/R & eq.Number in the "calling-tree" boxes
204 - search for CALC_MOM_RHS and replace it by the appropriate S/R
205 (mom_flux_form, mom_vecinv, dynamics)
206 - Problem with notation: in section.1 \vec{\bf v_h} (or \vec{\mathbf{v}}_{h})
207 was used for the horizontal velocity vector, and the 3.D vector was \vec{\mathbf{v}}
208 in section.2, \vec{\bf v} is used instead and 3.D velocity vector is
209 simply written \vec{v}.
210 I would suggest to keep the notation as they are (since they are consistent
211 inside each section) but may be to move the "notation.tex" piece
212 at the beginning of section.2 and to mention clearly the changes between
213 the 2 sections.
214
215 in content: Horizontal Dissipation: 2 times in vector-invariant section
216
217 2.1 time-stepping (part2/time_stepping.tex)
218
219 - this is not clear to me:
220
221 >> In all the above configurations it is also possible to substitute the
222 >> Adams-Bashforth with an alternative time-stepping scheme for terms
223 >> evaluated explicitly in time
224
225
226 2.2 rigid-lid:
227
228 - At some point, would be better to replace "g \eta" with "\Phi_s (cg2d_x)"
229 to stay closer to the code.
230 - mention section 2.5 implicit-Time-stepping (for vertical viscosity)
231
232 2.3 linear free-surface:
233 - add ref(+link) to S/R names:
234 - add ref(+link) to Crank-Nickelson section 2.9.1
235
236 2.4 Adams-Bashforth
237 - add stability diagrams (I have some figures that I can put)
238 - add link for var. forcing_In_AB
239 - add S/R link for S/R ADAMS_BASHFORTH2
240
241 2.5 Implicit time-stepping
242 - add name of S/R: IMPLDIFF, GAD_IMPLICIT_R, MOM_U_IMPLICIT_R
243 SOLVE_TRIDIAGONAL, SOLVE_PENTADIAGONAL
244 - update: also used for vertical advection
245
246 2.6 Synchronous time-stepping:
247 - add link for S/R THERMODYNAMICS, DYNAMCIS, SOLVE_FOR_PRESSURE,
248 MOMENTUM_CORRECTION_STEP.
249
250 2.7 Stagger baroclinic time-stepping
251 - mention AB(T,S) instead of AB(Gt,Gs) (in development) at the end
252
253 2.8 NH
254 - add link & S/R names: CALC_GW, SOLVE_FOR_PRESSURE, CG3D
255
256 2.9 Variants on Free-Surface
257 - Delta.t mis-written (eq.2.73)
258 - Eq.Num missing (has been fixed since)
259 - u* is stored in gU (and not in gUnm1)
260 - Phi_nh in NH_VARS.h
261 - add link to S/R file: SOLVE_FOR_PRESSURE, CALC_DIV_GHAT, CG2D, CG3D,
262 INI_CG2D, INI_CG3D
263
264 2.9.1 Crank-Nickelson
265 - link for variable: implicSurfPress, implicDiv2DFlow, useRealFreshWater
266
267 2.9.2 NLFS
268 - eq.Nb are wrong in html
269 - 2.9.2.4 : set of eq. appears wrong in html (but right in .dvi)
270
271 2.10.1 Notation
272 - Area definition is not really used like this
273
274 >> Ao : Area of the face orthogonal to "o" direction (o=u,v,w)
275
276 Instead, in the following section, Ac,Aw,As,A_zeta (= corresponding to
277 the model variables) are used (e.g., see section 2.10.5)
278
279 2.10.5 Horizontal grid:
280 - fig.2.8 : should use Aw,As consistently in this figure description,
281 in the figure itself, as it is in the text.
282 - curvilinear:
283 to add: mention the angle of the grid direction relative to
284 Eastward, Northward direction.
285 + mention horizGridFile= in file "data" (PARM04)
286 - add cylindrical polar grid description
287 need to do a better job of relating model variables to this diagram
288
289
290 2.11 Continuity & Horizontal Pressure gradient terms
291 - mention that d.Phi/dr|s =g if using z coordinate
292 - eq. 2.90 not clear regarding \delta_k(P-E)
293 better to add the free surface eq: d.eta/dt = w_s + P-E
294
295 2.12 Hydrostatic balance
296 - add ref to Atmosphere Appendix section (1.4) since Adcroft 2002
297 is hard to find
298 - add ref to section 1.3.4 (Hydrostatic, Quasi-Hydrostatic & Non-H)
299 and in section 1.3.4: remove the 1.3.4.3.2 subsection:
300 Quasi-nonhydrostatic Atmosphere
301
302 2.13.2 Coriolis terms
303 - note: the discretization used when useEnergyConservingCoriolis=T
304 has no hFac and no Area and is still different from the form
305 described here (with Area & hFac);
306
307 2.13.5 Lateral dissipation
308 - add description of how to use cosFactor & cosPower
309 - add the parameter correspondence: Ah <-> viscAh ; A4 <-> viscA4
310 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
312 scaling (not cos()2)
313 - need to reference the smag/leith section.
314
315 2.13.6 Vertical dissipation
316 - mention the implicit vertical viscosity option and ref to section 2.5
317 - add the parameter correspondence: Av <-> viscAr (and might change also
318 the notation to Ar)
319
320 2.14 Vector invariant momentum equations
321 - indicate that the NH pieces (vertical momentum eq) are not yet coded
322 and that the NH code uses the flux form.
323
324 2.14.6 Horizontal dissipation -> Horizontal Divergence
325
326 2.14.7 Horizontal dissipation
327 - add the parameter correspondence: A_D,A_z <-> viscAhD,viscAhZ
328 and A_D4,A_z4 <-> viscA4D,viscA4Z
329
330 2.16 & 2.17 & 2.18 :
331 - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options
332
333 2.20.2 mercator, non-dimensional Equations:
334 - does not use std notation
335 - would be better as an appendix of section 2.20:
336 (e.g changing the tile to:
337 - talk to Baylor
338 Appendix: non-dimensional Equations on Spherical-Polar grid.)
339
340
341 JM
342
343
344 >>>> From Andrea
345
346 Chapter 3
347 --------
348
349 Almost all of the 'math mode' text is dropped down as subscripts
350
351 divide chapter 3 more clearly into 2 sections?
352 (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?)
354 [DONE]
355
356 3.1 - don't need a link to the outside of the document (remove it)
357 - link to htdig is broken
358
359 3.2.1 - link at bottom to source code points to section 3.2.1
360 (ie, to itself) - link should point to cvs code archive
361
362 3.2.2.1 - ('upgrading from an earlier version') belongs under
363 the cvs part, ie, should be 3.2.1.1
364
365 3.3 - remove reference to 'diags' section under MITgcm
366 - remove reference to 'exe' and 'bin' sections also
367 (remove the .cvsignore file under these directories in cvs)
368 - add a 'jobs' section, and a description as examples of run scripts
369 - add 'lsopt', 'optim' and 'tutorial examples' with brief descriptions
370 - under 'tools' add a reference to 'build_options'. refer to the 'optfiles'
371 - under 'tools' the adjoint points to section 5 - this is now section 8
372 (but should be a floating reference)
373 - under 'utils' add a reference to exch2 - stuff for different resolutions
374 - the description of the pkg section refers directly to
375 section 3. should be section 6 (actually should be a floating reference)
376
377 3.4 - refer to sections 3.8 - 3.18 (now says 3.8 - 3.10)
378 3.4.1 - links to the following experiments don't exist or are broken:
379 exp2 - should link to section 3.9
380 hs94.cs-32x32x5 - link to section 3.12
381 add 'convection' to the list, link to section 3.13
382 add 'plume on slope` to the list, link to section 3.14
383 add '??' link to section 3.15
384 add 'dic_example on slope` to the list, link to section 3.16
385 add '??' link to section 3.17
386 add 'offline' and link to section 3.18
387 clean up others and make links where they are needed
388 3.4.2 - text suggests to see section 2 for details about what is in the 'code'
389 and 'input' directories - should refer to the examples in this section
390 - add 'build' bullet - this is where the model is compiled and exectuable lives
391
392 3.5 - add some little text when talking about 'optfiles' to refer to the tools/build_options
393 as the place where they live (add a link?)
394
395 3.6.1 - Add some general 'approach' text - ie, output is controlled either by the
396 'data' file in the input directory or by the data.[pkg name] file for any
397 package running. And there is some default behavior when the 'state' dumps
398 are written.
399 3.6.1.2 - needs to be moved to inside section 3.6.2
400
401 3.7 - this section is superfluous - remove it -OR- put the tutorial sections (3.8-3.18)
402 underneath this one and leave the text for 3.7 in place
403
404 All the 'overview' sections need some reference to the name of the experiment in
405 the verification directory
406
407 3.10 - in title, 4 degrees - degree symbol is a subscript, not a superscript
408 - is this experiment in the list from section 3.4???
409 3.10.3.1 - refers to figures and equations, links are broken
410
411 3.11.3.2 - line 43: link to equation is broken
412 - line 51-53: link to equation is broken
413 - there is some mess of text hanging around the end of this section. remove? reformat?
414
415 3.12.4.1 - line 34 - link to equation is broken
416 - lines 60,61 - 1st (take out the 'r' in the superscript)
417
418 3.13.2 - link to theta-equation is broken
419 3.13.5.4 -- ALL of the bold links to variable names are broken
420 line 34: link to equation is broken
421
422 3.15.1 - reference to 'fourth experiment' should be removed
423
424 3.16.4 - strange formatting, presence of '>' symbols - remove them
425
426 3.17.3 - unknown verification directory pointed to - also: no link from list in sec 3.4
427 3.17.3.1 - nothing filled in under file input/data - needs description
428
429 3.18.2 - point to section 2 for details - need hyperlink
430
431 3.19.1 - text (2 places) says that section 3.5 called for compile in 'input' directory - not true!
432 section 3.5 has the 'build' directory in the example
433
434 3.20.1 - link to doc at end of section points to this section
435 3.20.2 - link to doc at end of section points to this section
436
437 offline - duplicate inputs, what is it, tidy up cfc v.
438 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
508
509 Here are the remaining bits for Chap 4 :
510
511 - missing references (if you point me towards URLs, I'll add them
512 to the bibliography):
513 \ref{ref hoe and hill, ecmwf}
514 \ref{magicgarden}
515 \ref{IBMLAPI}
516 \ref{Memorychannel}
517 \ref{hoe-hill:99}
518
519 - There are a few empty sub-sections at the end of Chap 4 that
520 should either be commented out or fleshed out.
521
522 and thats about it for Chap 4.
523
524
525 Add more to quick links on front page
526
527 Chapter 6
528
529 the master package diagram does not appear in the document
530
531 Master list of packages (add this to beginning of chap 6)
532
533 admtlm/ - autodiff (chapter 5)
534 aim/ - retired
535 aim_compon_interf/ - 6.6 (no content yet)(Daniel + JM)
536 aim_ocn_coupler/ - 6.6 (no content yet)
537 aim_v23/ - 6.4.1 (content needs fixing - JM to do)
538 atm_common/ - nothing in this package (6.4.1 related)
539 autodiff/ - autodiff (chapter 5)
540 bulk_force/ - 6.3.3
541 cal/ - 6.3.5
542 cd_code/ - chapter 2 (JM check add a reference to paper,
543 mention parameter in data)
544 cfc/ - not sure (CNH to talk to Steph and Helen)
545 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
548 ctrl/ - not sure, check with PH
549 debug/ - JM may do something in chapter 7 (utilities)
550 diagnostics/ - 7.1
551 dic/ - 6.7.2
552 ebm/ - (check with PH)
553 ecco/ - chapter 8
554 embed_files/ - add something to chapter 7
555 exch2/ - 6.2.2
556 exf/ - 6.3.4
557 fizhi/ - 6.4.3
558 flt/ - (PH check)
559 gchem/ - 6.7.1
560 generic_advdiff/ - in chapter 2 (JM check)
561 ggl90/ - nothing, (Martin?)
562 gmredi/ - in chapter 2 (JM check). also need
563 Ferrari & Mc transition zone stuff (Samar doing this)
564 get dfer to read this
565 grdchk/ - grdchk (chapter 5 - check with PH)
566 gridalt/ - 6.2.4
567 kpp/ - 6.3.2
568 land/ - 6.4.2 (not connected to code Rong's notes - JM to fix)
569 matrix/ - Samar
570 mdsio/ - 7.3.1
571 mnc/ - 7.2.1
572 mom_common/ - in chapter 2 (JM check)
573 mom_fluxform/ - in chapter 2 (JM check)
574 mom_vecinv/ - in chapter 2 (JM check)
575 monitor/ - 7.4
576 my82/ - nothing, (martin?)
577 obcs/ - 6.3 (needs a check - ask PH to read)
578 ocn_compon_interf/ - 6.6 (no content yet)
579 offline/ - nothing, tutorials that need work but no package section entry
580 trivial to document (CNH to do)
581 opps/ - nothing, (martin?)
582 pp81/ - nothing, (martin?)
583 profiles/ - GAEL
584 ptracers/ - JM + SD + Martin to write something (nothing for this
585 at the moment)
586 AM has diagnostics table for this.
587 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
592 part6 - CNH
593 seaice/ - 6.5.2 - no equations, dimitris has promised some
594 shap_filt/ - chapter 2, JM to check
595 shelfice/ - nothing yet (martin?)
596 solver/ - empty (go away?)
597 sphere/ - chapter 5 or 8 (PH to check)
598 therm_seaice/ - empty (go away?)
599 thsice/ - 6.5.1 (JM to update?)
600 timeave/ - retiring......
601 zonal_filt/ - chapter 2 (JM to check)
602
603 list an expeiment which uses package? CNH
604
605 [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
608 Figure 6.8 is missing
609
610
611 >>>> From Andrea
612
613 to do list for chap 7:
614
615
616 7.1.1 - links to section 7.1.4: the text of the first one should read "see MITgcm Kernel Diagnostics Menu"
617 the links are pointing to the proper place
618
619 7.5.1 - add Graphix to the list of stuff in utils/matlab
620 7.5.2 - empty
621
622
623 andrea
624
625
626 9. Publications using MITgcm --> "Previous Applications of MITgcm"
627 Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
628 (check in support for more names)
629
630 10. Under development
631
632
633 Bibliography
634
635 tidy up from misc - .tex

  ViewVC Help
Powered by ViewVC 1.1.22