Changeset 771 in lmdz_wrf for trunk

Timestamp:

May 24, 2016, 11:04:16 AM (9 years ago)

Author:

lfita

Message:

Adding description of all functions

File:

• trunk/tools/nc_var_tools.py (modified) (1 diff)

trunk/tools/nc_var_tools.py

@@ -6 +6 @@
 # Importing generic tools file 'generic_tools.py'
 import generic_tools as gen
+
+####### Contents:
+# add_dims: Function to add dimensions from a given netCDF object to another one
+# add_globattrs: Function to add global attributes from a given netCDF object to another one
+# addvals: Function to add values to a given variable at a given dimension
+# add_vars: Function to add variables from a given netCDF object to another one
+# attrinvar: Check existence of an attribute in a netCDF variable object
+# basicvardef: Function to give the basic attributes to a variable (std_name, long_name, units)
+# changevartype: Function to change the type of a variable (when possible)
+# chdimname: Changing the name of the dimension
+# checkAllValues: Function to check for variables with along all their dimensions with the same value in a file
+# checkallvars: Function to check all variables of a file
+# checkNaNs: Function to check for NaN values over all variables in a file
+# check_times_file: Function to check time-steps of a given file
+# chgtimestep: Function to change the values of a given time-step of a variable inside a netCDF for values from a nother file
+# chvarname: Changing the name of the variable
+# cls_time_information: Classs to provide information about variable time
+# compute_deaccum: Function to compute deaccum: deaccumulation of a variable (VAR[t+1]-VAR[t])
+# compute_opersvarsfiles: Function to compute opersvarfiles: operation of variables from different files (OPER1.FILE1_VAR1 OPER2.FILE2_VAR2), operations are going to be secuentially made
+# compute_opervaralltime: Function to compute opervaralltime: operation of variable successible allover the time-steps
+# compute_opervartimes: Function to compute opervartimes: operation of variable for a given sub-set of time-steps
+# compute_tevolboxtraj: Function to compute tevolboxtraj: temporal evolution at a given point along a box following a trajectory
+# compute_tevolboxtraj_radialsec: Function to compute tevolboxtraj_radialsec: temporal evolution at a given point along a number of radii at a given frequency following a trajectory
+# DataSetSection: Function to get a section (values along a dimension) of a given data-set
+# DataSetSection_multidims: Function to get a section (values along multiple dimensions) of a given data-set
+# DataSetSection_multivars: Function to get a section (values along multiple variables) of a given data-set
+# DatesFiles: Function to find different time values on a series of WRF files in a folder
+# DimsLoop: Function to provide the shape of the dimensions which are not selected
+# dimToUnlimited: Operation to create an unlimited dimension from an existing one
+# dimVar_creation: Function to add a 1D variable with the size of a given dimension in a file
+# fattradd: Adding attributes from a reference file
+# fgaddattr: Adding global attributes from a reference file
+# fdimadd: Adding dimension from another reference file
+# field_stats: Function to retrieve statistics from a field
+# file_creation: Operation to create a file with one variable with a given set of dimensions
+# file_oper_alongdims: Function to operate a file along different dimensions of a variable
+# fill_ncvariable_lastdims: Function to fill the last [Nlastdims] dimensions of a variable [varn] from a netCDF object at the other dimensions at [prevdims]
+# filter_2dim: Function to filter along 2 dimensions (moving grid-box means of a given size) values of the netCDF file
+# flipdim: flips the value following one dimension [Nflipdim]
+# fvaradd: Adding variable (and all its attributes and dimensions) from a reference file to a file
+# gaddattr: Add a global attribute to a netCDF. Removes previous attribute if it exist
+# gaddattrk: Add a global attribute to a netCDF caring about the type. Removes previous attribute if it exist
+# get_1str_nc: Function to get 1 string value in a netCDF variable as a chain of 1char values
+# get_attribute: Function to get an attribute from a netCDF file
+# get_namelist_vars: Function to get namelist-like  values ([varname] = [value])
+# get_str_nc: Function to get string values in a netCDF variable as a chains of 1char values
+# getvalues_lonlat: Function to retrieve the values from the closest grid point to a set of longitude, latitude values
+# grattr: Function to read a global atribute
+# grmattr: Removing a global attribute
+# igattrs: Give all the global attributes of a file
+# increaseDimvar: Function to increase with 1 dimension an existing variable within a netcdf file. Values of the variable will be repeated along the new dimension
+# insert_variable: Function to insert a variable in an existing file
+# isgattrs: Give a single global attribute of a file and its type
+# isvattrs: Give a single attribute of a variable
+# ivars: Give all the variable names of a file
+# ivattrs: Give all the attributes of a variable and its type
+# load_ncvariable_lastdims: Function to load the last [Nlastdims] dimensions of a variable [varn] from a netCDF object at the other dimensions at [prevdims]
+# lonlatProj: Function to compute longitudes and latitudes for a given projection following subroutine calc_resolution_in from ORCHIDEE/src_global/module_InterpWeight
+# maskvar: Function to mask a variable using a mask. It is assumed that mask[...,dimM,dimJ,dimK] and var[...,dimM,dimJ,dimK] share the last dimensions
+# ncreplace: Function to replace something from a netCDF file
+# ncstepdiff: Function to compute differencies between time-steps (deacumulate) a netCDF file
+# nctype: Function to provide the string for the variable creation in a netCDF file
+# netcdf_concatenation: Function to concatenate netCDF files for a given set of variable
+# netcdf_fold_concatenation: Function to concatenate netCDF files in a given folder for a given set of variables
+# operation_alongdims: Function to operate along different dimensions of a variable
+# ovar_onc: Function to copy an object variable to a nother netcdf object
+# Partialmap_Entiremap: Function to transform from a partial global map (e.g.: only land points) to an entire one Coincidence of points is done throughout a first guess from fractions of the total domain of search
+# Partialmap_EntiremapFor: Function to transform from a partial global map (e.g.: only land points) to an entire one usinf Fortran code
+# Partialmap_EntiremapForExact: Function to transform from a partial global map (e.g.: only land points) to an entire one using Fortran code with exact location
+# put_variable_slice: Function to add a variable from a netcdf object to a new one following a slice
+# remapnn: Function to remap to the nearest neightbor a variable using projection from another file
+# remapnn_old: Function to remap to the nearest neightbor a variable using projection from another fil
+# seasmean: Function to compute the seasonal mean of a variable
+# sellonlatbox: Function to select a lotlan box from a data-set
+# sellonlatboxold: Function to select a lotlan box from a data-set
+# sellonlatlevbox: Function to select a lotlan box and a given level from a data-set
+# selvar: Function to select a series of variables from a netcdf file. Variables with the values of the associated dimensions will be also retrieved
+# set_attribute: Sets a value of an attribute of a netCDF variable. Removes previous attribute value if exists
+# set_attributek: Sets a value of an attribute of a netCDF variable with a kind. Removes previous attribute value if exists
+# setvar_asciivalues: Function to set de values of a variable with an ASCII file (common Fortran-like format)
+# SliceVar: Function to slice a given variable throughout a given list of dimensions
+# slice_variable: Function to return a slice of a given variable according to values to its dimensions
+# sorttimesmat: Function to sort the time values of a given file
+# spacemean: Function to retrieve a space mean series from a multidimensional variable of a file
+# SpatialWeightedMean: Function to compute the spatial mean using weights from a netCDF file
+# statcompare_files: Python script to statistically compare two different files
+# submns: Function to retrieve a series of months from a file
+# subyrs: Function to retrieve a series of years from a file
+# testvarinfile: Check existence of a variable inside a netCDF file
+# TimeInf: Function to print all the information from the variable time
+# time_information: Function to provide information about variable time
+# timemean: Function to retrieve a time mean series from a multidimensional variable of a file
+# timeshiftvar: Function to temporaly shift a number of time-steps a given variable inside a netCDF file
+# TimeSplitmat: Function to transform a file with CFtimes to a matrix [Nyear,Nmonth,Nday,Nhour,Nminute,Nsecond]
+# uploading_timestep: Function to upload a given time-step of a variable inside a netCDF
+# valmod: Function to modify the value of a variable
+# valmod_dim: Function to modify the value of a variable at a given dimension and value
+# var_3desc: Function to provide std_name, long_name and units from an object variable
+# varaddattr: Add an attribute to a variable. Removes previous attribute if it exists
+# varaddattrk: Add an attribute to a variable caring about the type
+# varaddref: Function to add a variable in an existing file copying characteristics from an existing one
+# var_creation: Operation to create a new variable in a file with a given set of dimensions
+# variable_inf: Class to provide the information from a given variable
+# varinfile: Check existence of a variable inside a netCDF file
+# varrmattr: Removing an attribute from a variable
+# VarVal_FillValue: Function to transform a given value from a given variable to _FillValue in a netCDF file
+# var_dim_dimv: Function to bring back which variables with the values should be use for a given variable
+# varDimension: Function to find the variable with the values of a dimension. It is assumed, that given variable
+# varout: Function when we want to output variable values
+# varoutold: Function when we want to output variable values
+# varrm: Removing a variable from a file
+# vrattr: Function to remove an atribute from a variable
+# writing_1str_nc: Function to write 1 string value in a netCDF variable as a chain of 1char values
+# writing_str_nc: Function to write string values in a netCDF variable as a chain of 1char values
+# WRF_CFlonlat_creation: Function to add a CF-convention longitude/latitude variables in a WRF file
+# WRF_CFtime_creation: Function to add a CF-convention time unit in a WRF file
+# WRF_CFxtime_creation: Function to add a CF-convention time unit in a WRF file using variable 'XTIME'
+# WRF_d0Nref: Function for the generation of an extra WRF domain from a given one
 
 main = 'nc_var_tools.py'