Difference between revisions of "Dynlib"

(Update for dynlib-0.11)
Line 10: Line 10:
 
# 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>
 +
#:To clone the repository to your laptop or any machine outside the UiB network, use
 +
#:<code>$ git clone <username>@login.uib.no/Data/gfi/users/tsp065/lib/dynlib.git</code>
 
# Change into the dynlib folder
 
# Change into the dynlib folder
 
#:<code>$ cd dynlib</code>
 
#:<code>$ cd dynlib</code>
Line 26: Line 28:
 
=== Editing the Fortran code ===
 
=== Editing the Fortran code ===
  
The fortran code lives in <code>src</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 12 source code files
 
:<code>$ ls src/*.f95
 
:<code>$ ls src/*.f95
:config.f95 const.f95 conv.f95 derivatives.f95 diag.f95 diag_contour_rwb.f95 kind.f95 stat.f95 utils.f95</code>
+
:src/config.f95 src/derivatives.f95  src/detect_fronts.f95      src/diag.f95     src/humidity.f95 src/stat.f95
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  
+
:src/const.f95   src/detect.f95       src/detect_rwb_contour.f95 src/ellipse.f95 src/kind.f95     src/utils.f95</code>
 +
: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 42:
 
:<code>$ git diff</code>
 
:<code>$ git diff</code>
 
or for one file only
 
or for one file only
:<code>$ git diff [filename]</code>
+
:<code>$ git diff <filename></code>
 +
 
 +
In case you want to undo your changes, you can revert any file to the last committed version by
 +
:<code>git checkout <filename></code>
  
 
Commit your changes from time to time and give a sensible and brief description of your changes in the editor that is opened (automatically)
 
Commit your changes from time to time and give a sensible and brief description of your changes in the editor that is opened (automatically)

Revision as of 16:14, 19 August 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
    To clone the repository to your laptop or any machine outside the UiB network, use
    $ git clone <username>@login.uib.no/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
    example_ani.py example_diag.py example_netcdf_write.py example_stat.py settings.py

Happy developing!

Quick start to developing with dynlib

Editing the Fortran code

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

$ ls src/*.f95
src/config.f95 src/derivatives.f95 src/detect_fronts.f95 src/diag.f95 src/humidity.f95 src/stat.f95
src/const.f95 src/detect.f95 src/detect_rwb_contour.f95 src/ellipse.f95 src/kind.f95 src/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>

In case you want to undo your changes, you can revert any file to the last committed version by

git checkout <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.py.

Dynlib functions

The functions are classified into different categories.