tscripts.rst - pism - [fork] customized build of PISM, the parallel ice sheet model (tillflux branch)
 (HTM) git clone git://src.adamsgaard.dk/pism
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) LICENSE
       ---
       tscripts.rst (2399B)
       ---
            1 .. include:: ../../global.txt
            2 
            3 .. _sec-scripts:
            4 
            5 Utility and test scripts
            6 ------------------------
            7 
            8 In the ``test/`` and ``util/`` subdirectories of the PISM directory the user will find
            9 some python scripts and one Matlab script, listed in :numref:`tab-scripts-overview`. The
           10 python scripts are all documented at the *Packages* tab on the `PISM Source Code
           11 Browser <pism-browser_>`_. The Python scripts all take option ``--help``.
           12 
           13 .. list-table:: Some scripts which help in using PISM
           14    :name: tab-scripts-overview
           15    :header-rows: 1
           16    :widths: 1,1
           17 
           18    * - Script
           19      - Function
           20    * - ``test/vfnow.py``
           21      - Organizes the process of verifying PISM. Specifies standard refinement paths for
           22        each of the tests (section :ref:`sec-verif`).
           23    * - ``test/vnreport.py``
           24      - Automates the creation of convergence graphs like figures :numref:`fig-thickerrsB`
           25        -- :numref:`fig-velerrsI`.
           26    * - ``util/fill_missing.py``
           27      - Uses an approximation to Laplace's equation :math:`\nabla^2 u = 0` to smoothly
           28        replace missing values in a two-dimensional NetCDF variable. The "hole" is filled
           29        with an average of the boundary non-missing values. Depends on ``netcdf4-python``
           30        and ``scipy`` Python packages.
           31    * - ``util/flowline.py``
           32      - See section :ref:`sec-flowline-modeling`.
           33    * - ``util/flowlineslab.py``
           34      - See section :ref:`sec-flowline-modeling`.
           35    * - ``util/check_stationarity.py``
           36      - Evaluate stationarity of a variable in a PISM ``-ts_file`` output.
           37    * - ``util/nc2cdo.py``
           38      - Makes a netCDF file ready for Climate Data Operators (CDO).
           39    * - ``util/nc2mat.py``
           40      - Reads specified variables from a NetCDF file and writes them to an output file in
           41        the MATLAB binary data file format ``.mat``, supported by MATLAB version 5 and
           42        later. Depends on ``netcdf4-python`` and ``scipy`` Python packages.
           43    * - ``util/nccmp.py``
           44      - A script comparing variables in a given pair of NetCDF files; used by PISM software
           45        tests.
           46    * - ``util/pism_config_editor.py``
           47      - Makes modifying or creating PISM configuration files easier.
           48    * - ``util/pism_matlab.m``
           49      - An example MATLAB script showing how to create a simple NetCDF file PISM can
           50        bootstrap from.
           51    * - ``util/PISMNC.py``
           52      - Used by many Python example scripts to generate a PISM-compatible file with the
           53        right dimensions and time-axis.