Difference between revisions of "Dynlib"

(Removed references and placed them in dynlib.diag detailed function description page)
Line 5: Line 5:
 
== Obtaining dynlib ==
 
== Obtaining dynlib ==
  
 +
# Create a new folder for the project that'll use dynlib, and go into that directory.
 +
#:<code>mkdir <project-name>
 +
#:<code>cd <project-name>
 
# Copying the source code repository
 
# Copying the source code repository
 
#:<code>git clone /Data/gfi/users/tsp065/lib/dynlib.git</code>
 
#:<code>git clone /Data/gfi/users/tsp065/lib/dynlib.git</code>
Line 11: Line 14:
 
# Compile the library
 
# Compile the library
 
#:<code>./compile</code>
 
#:<code>./compile</code>
 +
# Make sure everything works as expected
 +
#:<code>./test</code>
 +
# You can now go back to your main project folder and use dynib from there. Dynlib automatically installed a <code>settings.py</code> where you can override the default settings and some examples scripts in that project folder.
 +
#:<code>cd ..</code>
 +
#:<code>ls -l</code>
 +
Happy developing!
  
 
== Quick start to developing with dynlib ==
 
== Quick start to developing with dynlib ==
Line 16: Line 25:
 
=== Editing the Fortran code ===
 
=== Editing the Fortran code ===
  
The fortran code lives in the main source code directory. At the moment there are six source code files
+
The fortran code lives in <code>src</code> directory. At the moment there are six source code files
:<code>$ ls *.f95
+
:<code>$ ls src/*.f95
:dynlib_config.f95 dynlib_const.f95 dynlib_conv.f95 dynlib_diag.f95 dynlib_kind.f95 dynlib_stat.f95</code>
+
:config.f95 const.f95 conv.f95 derivatives.f95 diag.f95 diag_contour_rwb.f95 kind.f95 stat.f95 utils.f95</code>
The most important are <code>dynlib_diag.f95</code> which contains subroutines that calculate various diagnostics, and <code>dynlib_stat.f95</code> which contains statistical functions. Changed Fortran sources need to be recompiled, again using  
+
The most important are <code>diag.f95</code> which contains subroutines that calculate various diagnostics, and <code>stat.f95</code> which contains statistical functions. Changed Fortran sources need to be recompiled, again using  
 
:<code>./compile</code>
 
:<code>./compile</code>
  
Line 39: Line 48:
 
=== Using the Fortran functions ===
 
=== Using the Fortran functions ===
  
An example python script which calculates deformation using the Fortran function is provided with <code>deformation.py</code>.
+
An example python script which calculates deformation using the Fortran function is provided with <code>example_diag.f95</code>.
  
 
== Dynlib functions ==
 
== Dynlib functions ==

Revision as of 19:10, 29 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. Create a new folder for the project that'll use dynlib, and go into that directory.
    mkdir <project-name>
    cd <project-name>
  2. Copying the source code repository
    git clone /Data/gfi/users/tsp065/lib/dynlib.git
  3. Change into the dynlib folder
    cd dynlib
  4. Compile the library
    ./compile
  5. Make sure everything works as expected
    ./test
  6. You can now go back to your main project folder and use dynib from there. Dynlib automatically installed a settings.py where you can override the default settings and some examples scripts in that project folder.
    cd ..
    ls -l

Happy developing!

Quick start to developing with dynlib

Editing the Fortran code

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

$ ls src/*.f95
config.f95 const.f95 conv.f95 derivatives.f95 diag.f95 diag_contour_rwb.f95 kind.f95 stat.f95 utils.f95

The most important are diag.f95 which contains subroutines that calculate various diagnostics, and 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 example_diag.f95.

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