Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 3.89 KB

readme.md

File metadata and controls

96 lines (70 loc) · 3.89 KB

Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows. DOI GitHub top language GitHub commit activity (branch) GitHub contributors

This repository contains the source files (LaTeX) and the figures necessary to generate the User Guide of the Diva (Data Interpolating Variational Analysis) tool.

Diva logo

For the readers

Directly download the main documentation in pdf format.
The source files (.tex) in the source directory and the figures necessary to build the pdf.

Directory organisation

.
├── DivaWorkshop
│   ├── figures
│   ├── SlidesDivaLecce2016
│   └── SlidesDivaWorkshop2015
├── src
│   ├── figures
│   │   ├── advection
│   │   ├── analysis
│   │   ├── divaonweb
│   │   ├── errors
│   │   ├── examples
│   │   ├── gallery
│   │   ├── GUI
│   │   ├── icones
│   │   ├── images
│   │   ├── papers
│   │   ├── postprocessing
│   │   ├── preprocessing
│   │   └── test_cases
│   └── old
└── tags
    └── DivaUserGuide_March2013
        └── figures

For the editors

If you plan to edit the User Guide, here are some instructions.

Requirements

The manual requires several LaTeX packages to be compiled; the header file contains the list package to be installed along with the commands for the layout.

Compilation

You need to have LaTeX and BibTex installed on your machine in order to compile the sources.

cd src/
latex DivaUserGuide.tex
bibtex bibtex DivaUserGuide.aux
mkindex DivaUserGuide.tex
latex DivaUserGuide.tex
latex DivaUserGuide.tex
  • The 3rd line creates a list of references for the bibliography.
  • The 4th line prepares the index.
  • The last 2 lines are identical but necessary to obtain the correct references to the bibliography.
  1. Try to use the commands
\file{}
\command{}
\directory{}

in order to evidence the file, command and directory names.

Example:

"Execute \command{divafit}, and you get file \file{param.par.fit} in \directory{output}"
  1. Progressively add commands such as \index{key-word} to build a consistent index.

  2. English: try to stick to British English.

Related projects

DIVAnd.jl Julia

DIVAndnd.jl performs n-dimensional variational analysis of arbitrarily located observations.

divand.py Python

divand.py is the Python interface to the previous code (not maintained anymore).

DivaPythonTools Python

DivaPythonTools is a set of utilies to read, write and plot the content of input or output files used in DIVA.