Changes between Version 3 and Version 4 of doc/app/palm_iofiles


Ignore:
Timestamp:
Aug 28, 2018 6:25:11 AM (6 years ago)
Author:
raasch
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/palm_iofiles

    v3 v4  
    1 = The PALM file configuration file
     1= The PALM file connection file
    22
    3 PALM expects all input files to be in the temporary working directory from where it is executed. Also, it writes all output data to this directory. The file configuration file tells {{{palmrun}}}, where the user has stored his input files, and where the user likes to have the output files copied after a PALM run has finished. You can find the default file configuration file that is used by {{{palmrun}}} under [source:palm/trunk/SCRIPTS/.palm.iofiles]. In general, the file configuration file does not need to be touched by the user at all.
     3PALM expects all input files to be in the temporary working directory from where it is executed. Also, it writes all output data to this directory. The file connnection file tells {{{palmrun}}}, where the user has stored his input files, and where the user likes to have the output files copied after a PALM run has finished. You can find the default file connnection file that is used by {{{palmrun}}} under [source:palm/trunk/SCRIPTS/.palm.iofiles]. In general, the file connection file does not need to be touched by the user at all.
    44
    55\\
    6 == Format of the file configuration file
     6== Format of the file connection file
    77
    88The file is given in ASCII format and it generally contains one line per input/output file, which is called ''file connection statement''.
     
    3838
    3939* {{{lnpe}}} \\
    40   Same as {{{pe}}}, but {{{palmrun}}} tries to move the files using {{{ln}}} instead of {{{cp}}}, which reduces the time to copy the file drastically, but only if both folders (the local temporary folder and the user's folder) reside on the same file system. This attribute is given for restart files in the default file configuration file, because they may have huge sizes.
     40  Same as {{{pe}}}, but {{{palmrun}}} tries to move the files using {{{ln}}} instead of {{{cp}}}, which reduces the time to copy the file drastically, but only if both folders (the local temporary folder and the user's folder) reside on the same file system. This attribute is given for restart files in the default file connection file, because they may have huge sizes.
    4141
    4242* {{{trpe}}} \\
     
    4545The '''third column''' gives the so-called activation strings. Two or more strings need to be separated by colons (":"). Activation strings are those given in the {{{palmrun}}} option {{{-a}}}. The respective file connection statement is only processed (i.e. the file is copied), if at least one of its activation strings is set with option {{{-a}}}. In case of the above example, {{{-d "d3#"}}} causes {{{palmrun}}} to provide the input files {{{PARIN}}} and {{{TOPOGRAPHY_DATA}}}. Option {{{-d "d3# restart"}}} additional copies/saves the output file {{{BINOUT}}}. Note that activation strings need to be separated by blanks when given with the option {{{-d}}} and that they need to be embraced by {{{"}}}, even if only one string is given (otherwise, a {{{#}}} would cause the shell to interpret the remaining part of the command as a comment). For output files, a wildcard may be given in the third column. Respective local files will then always be copied, in case they exist, independently from the activation strings given with option {{{-d}}}. Wildcards in the third column are not allowed for input files.
    4646
    47 The path to the user's permanent file is given in the '''fourth column'''. It may contain environment variables that have been defined in the configuration file. {{{$jobname}}} will be replaced with the argument of {{{palmrun}}} option {{{-d}}}.
     47The path to the user's permanent file is given in the '''fourth column'''. It may contain environment variables that have been defined in the file connection file. {{{$jobname}}} will be replaced with the argument of {{{palmrun}}} option {{{-d}}}.
    4848
    4949The '''fifth column''' gives the appendix of the user's permanent file.
     
    6666%base_data         ~/palm/current_version/JOBS
    6767}}}
    68 in the configuration file, plus the call {{{palmrun -d example_test ...}}} will create the output file
     68in the file connection file, plus the call {{{palmrun -d example_test ...}}} will create the output file
    6969{{{
    7070  ~/palm/current_version/JOBS/example_test/OUTPUT/example_test_3d.nc
     
    7474== Using wildcards in filenames
    7575
    76 In case of nested runs, masked 3d-output and wind turbine model output, PALM expects or creates multiple input/output files with additional suffixes. As an example, a nested run with a parent and one child requires two parameter files for steering the simulation, where the second file is expected to have the suffix {{{_N02}}}. Each additional nest would require another parameter file with suffixes {{{_N03}}}, {{{_N04}}}, etc.  In order to simplify the file configuration file, only one file connection statement
     76In case of nested runs, masked 3d-output and wind turbine model output, PALM expects or creates multiple input/output files with additional suffixes. As an example, a nested run with a parent and one child requires two parameter files for steering the simulation, where the second file is expected to have the suffix {{{_N02}}}. Each additional nest would require another parameter file with suffixes {{{_N03}}}, {{{_N04}}}, etc.  In order to simplify the file connection file, only one file connection statement
    7777{{{
    7878PARIN     in:tr   d3#    $base_data/$jobname/INPUT     _p3d*