[MITgcm-devel] manual dir structure

[Jean-Michel Campin]

Hi,

The present document structure is:
 1) Overview of MITgcm
 2) Discretization and Algorithm
 3) Getting started with MITgcm
  3.8 Example experiments
  3.9 -> 3.21 : verification exp. doc
 4) Software Architecture
 5) Automatic Differentiation
 6) Physical Parameterization - Packages I
 7) Diagnostics and I/O - Packages II, and Post-Processing Utilities
 8) Interface with ECCO
 9) Under development
10) Previous applications of MITgcm
  Bibliography
And this will not change.

But I propose to change the manual cvs repository (gcmpack/manual):
(manual/        -- tmp dir used  to build the manual)
 tools/         -- tools to build the manual
 texinputs/     -- style files for latex
 on-line-figs/  -- contains plenty of dirs with figs
 part1/         change to: overview
 part2/         change to: algorithm
 part3/         change to: getstarted
 part3/case_studies ch to: examples
 part4/         change to: software
 part5/         change to: autodiff
 part6/         change to: phys_pkgs
 part7/         change to: outp_pkgs
 part8/         change to: ecco
 under_dvlp/    -- keep it
 pdfs/          empty, to remove
And inside each section dir, a sub-dir "text" (with *.tex files)
and a sub-dir "figs" (with other files used in latex documents).

questions:
1) are the new dir-names ok ? better names, especially 
phys_pkgs & outp_pkgs to replace part6 & 7 ? (or: physics_pkgs & 
output_pkgs ?)
2) is it better to have a common suffix for all sections:
 e.g.: with suffix "s_": s_overview, s_algorithm, ...
3) seems also logical to rename the head of section latex file
e.g.: part1/part1.tex -> overview/text/overview.tex

I also disabled this morning the cron job that build the manual and 
started to do some copy within gcmpack/manual (to check permission). 
So better not to check-in stuff into the manual.

Cheers,
Jean-Michel

On Mon, Aug 23, 2010 at 03:48:54PM -0400, Jean-Michel Campin wrote:
> Hi,
> 
> I would like to change the directory structure of the MITgcm
> manual (to have all the tex files in manual/*/*/*.tex ;
> change also all partN dir to section name). 
> Thinking of doing this later this week.
> So, if you have things ready to check-in in the manual dir,
> better to do it before.
> 
> Cheers,
> Jean-Michel
> 
> _______________________________________________
> MITgcm-devel mailing list
> MITgcm-devel at mitgcm.org
> http://mitgcm.org/mailman/listinfo/mitgcm-devel