Difference between revisions of "Dynlib"

m (References)
(Removed references and placed them in dynlib.diag detailed function description page)
Line 46: Line 46:
  
 
[[Dynlib diag functions|Dynlib diagnostic functions]]
 
[[Dynlib diag functions|Dynlib diagnostic functions]]
 
==References==
 
<bibtex>
 
@article{KeyReeRee1988,
 
author = {Keyser, D. and Reeder, M. J. and Reed, R. J.},
 
title = {A Generalization of Petterssen Frontogenesis Function and Its Relation to the Forcing of Vertical Motion},
 
journal = {Monthly Weather Review},
 
volume = {116},
 
number = {3},
 
pages = {762-780},
 
year = {1988},
 
url = {<Go to ISI>://A1988N255100017},
 
}
 
</bibtex>
 
<bibtex>
 
@article{LapKleHua1999,
 
  author = {Lapeyre, G. and Klein, P. and Hua, B. L.},
 
  title = {Does the tracer gradient vector align with the strain eigenvectors in 2D turbulence?},
 
  journal = {Physics of Fluids},
 
  volume = {11},
 
  number = {12},
 
  pages = {3729-3737},
 
  year = {1999},
 
  url = {<Go to ISI>://000083495900013
 
http://scitation.aip.org/getpdf/servlet/GetPDFServlet?filetype=pdf&id=PHFLE6000011000012003729000001&idtype=cvips&doi=10.1063/1.870234&prog=normal},
 
}
 
</bibtex>
 
<bibtex>
 
@book{Mar2010,
 
  author = {Markowski, Paul},
 
  title = {Mesoscale meteorology in midlatitudes},
 
  publisher = {Chichester, West Sussex, UK ;Hoboken, NJ : Wiley-Blackwell, 2010},
 
  url = {http://books.scholarsportal.info/viewdoc.html?id=/ebooks/ebooks2/wiley/2011-12-13/2/9780470682104},
 
  year = {2010},
 
}
 
</bibtex>
 
<bibtex>
 
@article{Oku1969,
 
  author = {Okubo, A.},
 
  title = {Horizontal Dispersion of Foreign Particles in Vicinity of Velocity Singularities Such as Convergences},
 
  journal = {Transactions-American Geophysical Union},
 
  volume = {50},
 
  number = {4},
 
  pages = {182-&},
 
  year = {1969},
 
  url = {<Go to ISI>://A1969C982700332},
 
}
 
</bibtex>
 
<bibtex>
 
#riv2009 bibtex=@article{Riv2009,
 
  author = {Riviere, G.},
 
  title = {Effect of Latitudinal Variations in Low-Level Baroclinicity on Eddy Life Cycles and Upper-Tropospheric Wave-Breaking Processes},
 
  journal = {Journal of the Atmospheric Sciences},
 
  volume = {66},
 
  number = {6},
 
  pages = {1569-1592},
 
  year = {2009},
 
  url = {<Go to ISI>://000267263300006},
 
}
 
</bibtex>
 
  
 
[[Category:Dynlib]]
 
[[Category:Dynlib]]
 
[[Category:Libraries]]
 
[[Category:Libraries]]
 
 
[[Category:Dynlib]]
 
[[Category:Dynlib]]
 
[[Category:Libraries]]
 
[[Category:Libraries]]

Revision as of 13:31, 25 January 2013

Documentation

The steps necessary to obtain dynlib are described below. A more thorough documentation is compiled in the main documentation page.

Obtaining dynlib

  1. Copying the source code repository
    git clone /Data/gfi/users/tsp065/lib/dynlib.git
  2. Change into the dynlib folder
    cd dynlib
  3. Compile the library
    ./compile

Quick start to developing with dynlib

Editing the Fortran code

The fortran code lives in the main source code directory. At the moment there are six source code files

$ ls *.f95
dynlib_config.f95 dynlib_const.f95 dynlib_conv.f95 dynlib_diag.f95 dynlib_kind.f95 dynlib_stat.f95

The most important are dynlib_diag.f95 which contains subroutines that calculate various diagnostics, and dynlib_stat.f95 which contains statistical functions. Changed Fortran sources need to be recompiled, again using

./compile

Version control

The changes you made to the source code files can be listed by

git status

or viewed in detailed diff-comparisons by

git diff

or for one file only

git diff [filename]

Commit your changes from time to time and give a sensible and brief description of your changes in the editor that is opened (automatically)

git commit -a

The commit is then stored in your copy of the source code repository, but not yet available for others, which allows you to also commit work-in-progress.

A more thorough introduction to the version control system is given here or on the official documentation.

Using the Fortran functions

An example python script which calculates deformation using the Fortran function is provided with deformation.py.

Dynlib functions

The functions generally operate on real arrays with dimension (nz,ny,nx) where nz is number of times or levels, and ny and nx are the number of latitudes and longitudes, respectively. The function descriptions below contain detailed descriptions of arguments and returns where there is any deviation from this pattern; otherwise they may be assumed to be of the form:

Dynlib diagnostic functions