Skip to content

Commit 65ac097

Browse files
koldunovnkoldunovn
authored
Update README.md
1 parent 51cb292 commit 65ac097

File tree

1 file changed

+33
-38
lines changed

1 file changed

+33
-38
lines changed

‎README.md‎

Lines changed: 33 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ python fint.py ${FILE} ${MESH} ${INFL}
6161
Currently it's just a list of help from `fint`. Later will expand each of the options with explination.
6262

6363
```shell
64-
usage: pfinterp [-h] [--depths DEPTHS] [--timesteps TIMESTEPS] [--box BOX]
65-
[--res N_POINTS_LON N_POINTS_LAT] [--influence INFLUENCE]
66-
[--map_projection MAP_PROJECTION] [--interp {nn,mtri_linear,linear_scipy}]
67-
[--mask MASK] [--ofile OFILE] [--odir ODIR] [--target TARGET] [--no_shape_mask]
68-
[--rotate] [--no_mask_zero] [--timedelta TIMEDELTA]
64+
usage: fint [-h] [--depths DEPTHS] [--timesteps TIMESTEPS] [--box BOX] [--res N_POINTS_LON N_POINTS_LAT] [--influence INFLUENCE]
65+
[--map_projection MAP_PROJECTION]
66+
[--interp {nn,mtri_linear,linear_scipy,cdo_remapcon,cdo_remaplaf,cdo_remapnn,cdo_remapdis,smm_con,smm_laf,smm_nn,smm_dis}]
67+
[--mask MASK] [--ofile OFILE] [--odir ODIR] [--target TARGET] [--no_shape_mask] [--rotate] [--no_mask_zero] [--timedelta TIMEDELTA]
68+
[--oneout] [--missing_value MISSING_VALUE]
6969
data meshpath
7070

7171
Interpolates FESOM2 data to regular grid.
@@ -77,49 +77,44 @@ positional arguments:
7777
optional arguments:
7878
-h, --help show this help message and exit
7979
--depths DEPTHS, -d DEPTHS
80-
Depths in meters. Closest values from model levels will be taken. Several
81-
options available: number - e.g. '100', coma separated list - e.g.
82-
'0,10,100,200', slice 0:100 -1 - all levels will be selected.
80+
Depths in meters. Closest values from model levels will be taken. Several options available: number - e.g. '100', coma
81+
separated list - e.g. '0,10,100,200', slice 0:100 -1 - all levels will be selected.
8382
--timesteps TIMESTEPS, -t TIMESTEPS
84-
Explicitly define timesteps of the input fields. There are several options:
85-
'-1' - all time steps, number - one time step (e.g. '5'), numbers - coma
86-
separated (e.g. '0, 3, 8, 10'), slice - e.g. '5:10', slice with steps - e.g.
87-
'8:120:12'. slice untill the end of the time series - e.g. '8:end:12'.
88-
--box BOX, -b BOX Several options are available: - Map boundaries in -180 180 -90 90 format that
89-
will be used for interpolation. - Use one of the predefined regions. Available:
90-
gs (Golf Stream), trop (Atlantic Tropics), arctic, gulf (also Golf Stream, but
91-
based on Mercator projection.)\))
83+
Explicitly define timesteps of the input fields. There are several options: '-1' - all time steps, number - one time step (e.g.
84+
'5'), numbers - coma separated (e.g. '0, 3, 8, 10'), slice - e.g. '5:10', slice with steps - e.g. '8:120:12'. slice untill the
85+
end of the time series - e.g. '8:end:12'.
86+
--box BOX, -b BOX Several options are available: - Map boundaries in -180 180 -90 90 format that will be used for interpolation. - Use one of the
87+
predefined regions. Available: gs (Golf Stream), trop (Atlantic Tropics), arctic, gulf (also Golf Stream, but based on Mercator
88+
projection.)))
9289
--res N_POINTS_LON N_POINTS_LAT, -r N_POINTS_LON N_POINTS_LAT
93-
Number of points along each axis that will be used for interpolation (for lon
94-
and lat).
90+
Number of points along each axis that will be used for interpolation (for lon and lat).
9591
--influence INFLUENCE, -i INFLUENCE
96-
Radius of influence for interpolation, in meters. Used for nearest neighbor
97-
interpolation.
92+
Radius of influence for interpolation, in meters. Used for nearest neighbor interpolation.
9893
--map_projection MAP_PROJECTION, -m MAP_PROJECTION
9994
Map projection. Available: mer, np
100-
--interp {nn,mtri_linear,linear_scipy}
101-
Interpolation method. Options are nn - nearest neighbor (KDTree implementation,
102-
fast), mtri_linear - linear, based on triangulation information (slow, but more
103-
precise)
104-
--mask MASK File with mask for interpolation. Mask should have the same coordinates as
105-
interpolated data. Usuall usecase is to use mtri_linear slow interpolation to
106-
create the mask, and then use this mask for faster (nn) interpolation.
95+
--interp {nn,mtri_linear,linear_scipy,cdo_remapcon,cdo_remaplaf,cdo_remapnn,cdo_remapdis,smm_con,smm_laf,smm_nn,smm_dis}
96+
Interpolation method. Options are nn - nearest neighbor (KDTree implementation, fast), mtri_linear - linear, based on
97+
triangulation information (slow, but more precise)
98+
--mask MASK File with mask for interpolation. Mask should have the same coordinates as interpolated data. Usuall usecase is to use
99+
mtri_linear slow interpolation to create the mask, and then use this mask for faster (nn) interpolation.
107100
--ofile OFILE, -o OFILE
108101
Path to the output file. Default is out.nc.
109102
--odir ODIR Path to the output directory. Default is ./
110-
--target TARGET Path to the target file, that contains coordinates of the target grid (as lon
111-
lat variables)
103+
--target TARGET Path to the target file, that contains coordinates of the target grid (as lon lat variables)
112104
--no_shape_mask Do not apply shapely mask for coastlines. Useful for paleo applications.
113-
--rotate Rotate vector variables to geographic coordinates. Use standard FESOM2 angles
114-
(this should be fine in 99.99 percent of cases:)).
115-
--no_mask_zero FESOM2 use 0 as mask value, which is terrible for some variables. Solution is
116-
to create a mask using temperature or salinity, and then use this mask for
117-
interpolation, applying this option.
105+
--rotate Rotate vector variables to geographic coordinates. Use standard FESOM2 angles (this should be fine in 99.99 percent of
106+
cases:)).
107+
--no_mask_zero FESOM2 use 0 as mask value, which is terrible for some variables. Solution is to create a mask using temperature or salinity,
108+
and then use this mask for interpolation, applying this option.
118109
--timedelta TIMEDELTA
119-
Add timedelta to the time axis. The format is number followed by unit. E.g.
120-
'1D' or '10h'. Valid units are 'D' (days), 'h' (hours), 'm' (minutes), 's'
121-
(seconds). To substract timedelta, put argument in quotes, and prepend ' -', so
122-
SPACE and then -, e.g. ' -10D'.
110+
Add timedelta to the time axis. The format is number followed by unit. E.g. '1D' or '10h'. Valid units are 'D' (days), 'h'
111+
(hours), 'm' (minutes), 's' (seconds). To substract timedelta, put argument in quotes, and prepend ' -', so SPACE and then -,
112+
e.g. ' -10D'.
113+
--oneout Add timedelta to the time axis. The format is number followed by unit. E.g. '1D' or '10h'. Valid units are 'D' (days), 'h'
114+
(hours), 'm' (minutes), 's' (seconds). To substract timedelta, put argument in quotes, and prepend ' -', so SPACE and then -,
115+
e.g. ' -10D'.
116+
--missing_value MISSING_VALUE
117+
Missing value for the output file. Default is None.
123118
```
124119
# Containerized Usage
125120

0 commit comments

Comments
 (0)