README.devel 2.83 KB
Newer Older
François Fortin's avatar
François Fortin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
                      METRo Developer README file

You are currently reading the Developer README file. For general information
about METRo please read the "README" file.


========================================
== Setting up development environment ==
========================================

init_devel.sh
-------------
You need to run the 'init_devel.sh' script to prepare your working directory. 
If the script complain about the environment variable "PYTHON_INCLUDE": 
you need to set it to a valid value. Usualy, it will be something like:
'export PYTHON_INCLUDE=/usr/include/pythonX.X' where the X's are the 
version numbers. You only need to run the 'init_devel.sh' script one time.

* From now on, we assume the 'init_devel.sh' script has been run.


=======================
== Compiling "model" ==
=======================

Fortran model
-------------
To compile the Fortran model you will need to perform the following action:
1) cd src/model/
2) ../../scripts/do_macadam


======================
== Building package ==
======================

1) Change the METRo version number in the following files:
    README
    scripts/do_macadam
    src/frontend/metro_config.py

2) Change realease date in the following files:
    README
    src/frontend/metro_config.py

46
47
48
49
3) Commit every change
    svn commit

4) Compile model:
François Fortin's avatar
François Fortin committed
50
51
    compile the Fortran model (see == Compiling "model" ==)

François Fortin's avatar
François Fortin committed
52
53
54
55
56
57
58
5) Update package list
    grep -E "^src/frontend/.*\.py" scripts/make_package.py | sort > /tmp/packaged_modules
    find src/frontend -name *.py | sort > /tmp/actual_modules
    diff -y -W 200 /tmp/packaged_modules /tmp/actual_modules
    vi scripts/make_package.py

6) Build Package
François Fortin's avatar
François Fortin committed
59
60
61
    cd scripts/ 
    ./make_package.py
    * You need a valid gpg key to be able to sign your package
62
63
64
65
66

=============
== Release ==
=============

Sasa Zhang's avatar
Sasa Zhang committed
67
68
69
70
1) Make a tag in SVN for the release of that version.
   You will need an access to the metro project on GNA to do that.
   The following is an example of the user Francois Fortin making a tags
   for the 3.2.4 version
71

Sasa Zhang's avatar
Sasa Zhang committed
72
73
   svn copy svn+ssh://francois_fortin@svn.gna.org/svn/metro/metro/trunk \
            svn+ssh://francois_fortin@svn.gna.org/svn/metro/metro/tags/metro-3.2.4
74
75
    
2) Upload package to the GNA web site (http://download.gna.org/metro/)
Sasa Zhang's avatar
Sasa Zhang committed
76
77
   scp metro-3.2.4.tar.bz2  metro-3.2.4.tar.bz2.sig
   francois_fortin@download.gna.org:/upload/metro/
78

Sasa Zhang's avatar
Sasa Zhang committed
79
80
3) Create a new LATEST_RELEASE file with the new version number.
   The content of the file is:
81

Sasa Zhang's avatar
Sasa Zhang committed
82
83
   ------------------------------------- cut here --------------------------------
   Please note:
84

Sasa Zhang's avatar
Sasa Zhang committed
85
86
87
   - The latest stable version of the METRo package is:
     metro-3.2.4
   ------------------------------------- cut here --------------------------------
88

Sasa Zhang's avatar
Sasa Zhang committed
89
90
4) Upload the LATEST_RELEASE file to the GNA web site
   (http://download.gna.org/metro/)
91
92
   scp LATEST_RELEASE francois_fortin@download.gna.org:/upload/metro/