Changeset 2520


Ignore:
Timestamp:
2010-12-27T15:43:36+01:00 (10 years ago)
Author:
rblod
Message:

Add in core documentation for compilation scripts

Location:
branches/nemo_v3_3_beta
Files:
14 edited
1 moved

Legend:

Unmodified
Added
Removed
  • branches/nemo_v3_3_beta/ADM/DOC_SCRIPTS/makefile_compile

    r2519 r2520  
    55# ======== 
    66# 
    7 # --------------------------------------- 
    8 # generation of documentation of superbib 
    9 # --------------------------------------- 
     7# ----------------------------------------------- 
     8# generation of documentation of NEMO compilation 
     9# ----------------------------------------------- 
    1010# 
    1111# TODO 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fadd_keys.sh

    r2359 r2520  
    1313#+ 
    1414# 
    15 # ================ 
     15# ============ 
    1616# Fadd_keys.sh 
    17 # ================ 
     17# ============ 
    1818# 
    19 # -------------------------- 
     19# -------------------- 
    2020# Add compilation keys 
    21 # -------------------------- 
     21# -------------------- 
    2222# 
    2323# SYNOPSIS 
     
    3333# 
    3434# 
    35 # Add keys 
     35# Script to add a set off key when compiling a configuration. 
     36# The list off key to be added has to be enclosed with " ".  
     37# A 'sed' is performed to modify the CONFIG_NAME/cpp.fcm file to     
     38# add the new key(s).  
    3639# 
    3740# 
     
    4144# :: 
    4245# 
    43 #  $ ./Fadd_keys.sh CONFIG_NAME add_key "LIST_KEYS" 
     46#  $ ./Fadd_keys.sh ORCA2_LIM add_key "key_mpp_mpi key_nproci=1 key_nprocj=10" 
    4447# 
    4548# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fcheck_archfile.sh

    r2359 r2520  
    2828# Check the choice of the compiler. 
    2929# Three cases :   
    30  
     30# 
    3131# - There was a previous choice 
    32 # - A new one has be specified 
    33 # - No information, exit  
     32# - A new one has be specified, we use this one 
     33# - No information, exit 
     34# 
     35# We use TOOLS/COMPILE/arch.fcm to see if something was chosen.  
    3436# 
    3537# EXAMPLES 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fcheck_config.sh

    r2359 r2520  
    3434# 
    3535# Check the choice of the configuration: 
    36  
     36# 
    3737# - Two cases 
    3838# - One is explicitely set 
    3939# - Nothing set, use the previous in use  
     40# 
     41# We use TOOLS/COMPILE/cfg.txt to check if the onfiguration exists. 
    4042# 
    4143# EXAMPLES 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fcheck_script.sh

    r2143 r2520  
    2626# 
    2727# 
    28 # Check if utilities are in the path 
     28# Check if utilities are in the path, typically fcm. 
    2929# 
    3030# EXAMPLES 
     
    3333# :: 
    3434# 
    35 #  $ ./Fcheck_script.sh scriptname 
     35#  $ ./Fcheck_script.sh fcm 
    3636# 
    3737# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fclean_config.sh

    r2359 r2520  
    1717# ================ 
    1818# 
    19 # -------------------------- 
     19# ------------------------ 
    2020# Remove the configuration 
    21 # -------------------------- 
     21# ------------------------ 
    2222# 
    2323# SYNOPSIS 
     
    3434# 
    3535# Remove the configuration: 
    36  
    3736# 
     37# - remove CONFIG_NAME/WORK 
     38# - remove CONFIG_NAME/BLD 
     39# - remove CONFIG_NAME from TOOLS/TOOLS/COMPILE/cfg.txt  
     40#  
    3841# EXAMPLES 
    3942# ======== 
     
    4144# :: 
    4245# 
    43 #  $ ./Fclean_config.sh 
     46#  $ ./Fclean_config.sh ORCA2_LIM 
    4447# 
    4548# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fcopy_dir.sh

    r2143 r2520  
    2727# 
    2828# When a refenrence configuration is set,  
    29 # Copy NEMO sub-directories needed 
     29# Copy NEMO sub-directories needed (OPA_SRC, TOP_SRC ...) 
    3030# 
    3131# EXAMPLES 
     
    3434# :: 
    3535# 
    36 #  $ ./Fcopy_dir.sh REF_DIR 
     36#  $ ./Fcopy_dir.sh ORCA2_LIM 
    3737# 
    3838# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fdel_keys.sh

    r2359 r2520  
    3333# 
    3434# 
    35 # Add keys 
    36 # 
     35# Add cpp keys when compiling a configuration, key list has to be enclosed with " ". 
     36# We perform a 'sed' on the CONFIG_NAME/CPP.fcm file, contianing the list of keys.  
    3737# 
    3838# EXAMPLES 
     
    4141# :: 
    4242# 
    43 #  $ ./Fdel_keys.sh CONFIG_NAME del_key "LIST_KEYS" 
     43#  $ ./Fdel_keys.sh CONFIG_NAME del_key "key_agrif" 
    4444# 
    4545# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Flist_archfile.sh

    r2143 r2520  
    2626# 
    2727# 
    28 # Check the choice of the compiler. 
    29 # Three cases :   
    30  
    31 # - There was a previous choice 
    32 # - A new one has be specified 
    33 # - No information, exit  
     28# List arch file available. 
     29# The first line of each file in NEMO/ARCH directory is echoed.   
     30# 
    3431# 
    3532# EXAMPLES 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fmake_WORK.sh

    r2359 r2520  
    1717# ============= 
    1818# 
    19 # -------------------------- 
     19# ----------------------- 
    2020# Make the WORK directory 
    21 # -------------------------- 
     21# ----------------------- 
    2222# 
    2323# SYNOPSIS 
     
    3939# - OPA has to be done first !!! 
    4040# 
     41# 
    4142# EXAMPLES 
    4243# ======== 
     
    4445# :: 
    4546# 
    46 #  $ ./Fmake_WORK.sh 
     47#  $ ./Fmake_WORK.sh ORCA2_LIM OPA_SRC LIM_SRC_2 
    4748# 
    4849# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fmake_bld.sh

    r2143 r2520  
    1010# ============ 
    1111# 
    12 # -------------------------- 
     12# -------------------- 
    1313# Make build directory 
    14 # -------------------------- 
     14# -------------------- 
    1515# 
    1616# SYNOPSIS 
     
    2626# 
    2727# 
     28# Under CONFIG_NAME : 
    2829# - Make the build directory  
    2930# - Create repositories needed : 
    30  
    31 #  - BLD for compilation  
     31# - BLD for compilation  
     32# 
     33# A tmpdir can be specified for memory issues. 
     34# 
    3235# 
    3336# EXAMPLES 
     
    3639# :: 
    3740# 
    38 #  $ ./Fmake_bld.sh CONFIG_DIR CONFIG_NAME  TMP_DIR 
     41#  $ ./Fmake_bld.sh NEMOGCM/CONFIG GYRE  /usr/tmp 
    3942# 
    4043# 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fmake_config.sh

    r2316 r2520  
    1010# =============== 
    1111# 
    12 # -------------------------- 
     12# --------------- 
    1313# Make the config  
    14 # -------------------------- 
     14# --------------- 
    1515# 
    1616# SYNOPSIS 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fprep_agrif.sh

    r2437 r2520  
    1010# ============== 
    1111# 
    12 # -------------------------- 
     12# --------------------- 
    1313# Preparation for AGRIF 
    14 # -------------------------- 
     14# --------------------- 
    1515# 
    1616# SYNOPSIS 
     
    2626# 
    2727# 
    28 # Prepare directories for AGRIF 
     28# Prepare directories for AGRIF and copy files needed 
    2929# 
    3030# Compile the conv 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/Fread_dir.sh

    r2143 r2520  
    1010# ============ 
    1111# 
    12 # -------------------------- 
     12# --------------------- 
    1313# Read user directories 
    14 # -------------------------- 
     14# --------------------- 
    1515# 
    1616# SYNOPSIS 
  • branches/nemo_v3_3_beta/NEMOGCM/TOOLS/COMPILE/agrifpp.sh

    r2447 r2520  
    66#+ 
    77# 
    8  
    98# ========== 
    109# agrifpp.sh 
     
    2726# 
    2827# 
    29 # Look after key agrif 
     28# Look after key agrif, if yes the conv is used, otherwise standard pre-processing is performed. 
    3029# 
    3130# EXAMPLES 
Note: See TracChangeset for help on using the changeset viewer.