GLIMMER, Version Control and Build Systems

Size: px

Start display at page:

Download "GLIMMER, Version Control and Build Systems"

Lesley Chase
6 years ago
Views:

1 Outlines GLIMMER, Version Control and Build Systems Magnus Hagdorn School of GeoSciences University of Edinburgh December 5, 2005

2 Outlines Outline of Part I Unix Directory Structure Installing GLIMMER from CVS Version Control Introduction Short Detour: ssh CVS subversion NeSCForge Release Management

3 Outlines Outline of Part II Makefiles GNU autotools autoconf automake GLIMMER Specifics Configuration File Parser Python Code Generator

4 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Unix Directory Structure $PREFIX The parent directory of the directory tree. Typically something like /usr or /usr/local bin directory where binaries live lib directory where libraries live include directory where header files and module files live share directory where machine independent files live src where source code lives

5 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Why use this structure? easy to use more than one tree, e.g. a development tree and a stable tree easy to get rid of an entire lot easy to use more than one architecture

6 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Downloading GLIMMER from CVS Have a look at id=26 Log into the cvs server cvs -d:pserver:anonymous@forge.nesc.ac.uk:/cvsroot/glimmer login Checkout the sources for GLIMMER cvs -z3 -d:pserver:anonymous@forge.nesc.ac.uk:/cvsroot/glimmer co glimmer and optionally its friends glimmer-test glimmer-example PyCF PyGMT

7 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Building GLIMMER Preparing the build system./bootstrap Configuring GLIMMER./configure [options] --help help --prefix where to install it to --with-netcdf where netcdf is installed Build and install it make && make install and various others check help or README

8 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Introduction Why Version Control? you get a history of what has been done allows you to colaborate with other manage different versions it stops you from making terrible mistakes it stops you from making terrible mistakes 2 different systems CVS Concurrent Versions System subversion

9 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Introduction revision number a unique number specifying a particular revision, usually have a life of their own tag a name for a particular set of revision numbers branch a new line of development branching off at a particular revision HEAD the main branch/trunk

10 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Short Detour: ssh Setting up ssh keys little howto, e.g. pkeck/ssh/ ssh-keygen -t dsa and also for rsa and rsa1 append the.pub keys to your.ssh/authorized keys file run ssh-add and enter passphrase works because ssh-agent is started during session init add public keys to your NeSCForge account

11 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management CVS commands I cvs update without any options update to latest version -d build directories, -P prune empty dirs -r revision update to specific revision -j revision merge in changes between current and revision cvs commit commit changes to CVS, will fire up editor -m "message" commit message

12 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management CVS commands II cvs add/remove add/remove a file or directory cvs tag tag or branch project cvs diff create a diff between current version and head -j specify which revision you want -up produce more readable diffs if you want changes added to GLIMMER send someone a patch produced using cvs diff -up

13 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Creating and populating a repository svnadmin create /path/to/repos create a repository various methods of accessing repository, will use ssh sort out permissions I: chmod -R a+r /path/to/repos sort out permissions II: find /path/to/repos -perm + u=x -exec chmod a+x svn import /tmp/project svn+ssh://host/path/to/repos start a new project (with name project) should have subdirectories trunk, branches and tags

14 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management subversion commands are essentially like CVS commands svn checkout check out a particular version svn update update to current revision svn commit commit changes to repository svn add/remove add/remove file svn diff produce a diff svn copy copies a file or directory, used for tagging and branching

15 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management NeSCForge GLIMMER home page: CVS front end: id=26 Feature Requests and Bug Tracker: id=26 Documentation: id=26 Use It!

16 Unix Directory Structure Installing GLIMMER from CVS Version Control Release Management Release Management Current <major-version>.<minor-version>.<micro-version> major: not used, still heavy development minor: currently 5, gives some indication of major features micro: odd development version, even stable version Future? <major-version>.<minor-version>.<micro-version> major: major features are working as expected minor: odd development version, even stable version micro: minor changes, bug fixes for stable versions

17 Makefiles GNU autotools GLIMMER Specifics Build System Are good for automating repetative tasks putting things together making it work on a whole bunch of systems the more automatic the better

18 Makefiles GNU autotools GLIMMER Specifics Makefiles Transform one file into another given a rule Check if the target is older than the source Example F90 = f95 FCFLAGS = -C -g example.o: example.f90 f95 -o example.o -c example.f90.f90.o: f95 -o $@ -c $< $(F95) $(FCFLA %.o: %.f90 f95 -o $@ -c $< $(F95) $(FCFLA

19 Makefiles GNU autotools GLIMMER Specifics GNU autotools The Problem lots of special cases to take care of different architectures different compilers different software/versions installed want to handle different compile time options want to enable/disable certain features need to handle usual tasks such as building/installing/distributing software

20 Makefiles GNU autotools GLIMMER Specifics GNU autotools The Solution GNU autotools autoconf automake libtool for building share libraries Also worth checking out

21 Makefiles GNU autotools GLIMMER Specifics configure.in autoconf dnl a comment dnl another comment AC_INIT([NAME],[version],[bugreports@some.where]) AM_INIT_AUTOMAKE AC_PROG_RANLIB AC_PROG_FC AC_CONFIG_FILES([Makefile]) AC_OUTPUT

22 Makefiles GNU autotools GLIMMER Specifics automake Makefile.am bin_programs = hello_world lib_libraries = libhello.a libhello_a_sources = hello1.f90 hello2.f90 hello_world_sources = hello_world.f90 hello_world_ldadd = libhello.a

23 Makefiles GNU autotools GLIMMER Specifics Configuration File Parser Fortran code to read configuration files File Format # a comment [a_section] key1 = -20 key2 = 2.41 [section2] key3 = 1 2 3

24 Makefiles GNU autotools GLIMMER Specifics Configuration File Parser How does it work? file is read into memory each section is stored as an element in a linked list each key-value pair is stored as an element in a linked list attached to section element API to search for sections API to extract value given section and keyword

25 Makefiles GNU autotools GLIMMER Specifics Example Configuration File Parser type(configsection), pointer :: config type(configsection), pointer :: section integer :: val1 = 1 real :: val2 3.14! read configuration call ConfigRead(fname,config)! find section call GetSection(config,section, a_section ) if (associated(section)) then call GetValue(section, key1,val1) call GetValue(section, key2,val2) end if

26 Makefiles GNU autotools GLIMMER Specifics Python Code Generator What does it do? generates f95 code for handling netcdf output generates L A TEX code listing available variable names in documentation Why? it s incredibly tedious and error prone otherwise turns 788 lines of code into 4080 it s easy to add more variables for output

27 Makefiles GNU autotools GLIMMER Specifics Python Code Generator How? have a look at src/fortran/glide vars.def for the variable definition src/fortran/ncdf template.f90.in for the f95 template src/python/generate ncvars.py for the code generator

Version Control. Kyungbaek Kim. Chonnam National University School of Electronics and Computer Engineering. Original slides from James Brucker

Version Control. Kyungbaek Kim. Chonnam National University School of Electronics and Computer Engineering. Original slides from James Brucker Version Control Chonnam National University School of Electronics and Computer Engineering Kyungbaek Kim Original slides from James Brucker What is version control Manage documents over time Keep a history