Skip to content

Commit

Permalink
updated dosctring
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Sampson committed Feb 7, 2022
1 parent b814583 commit 1d7a15c
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions improver/cli/spot_extract.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@
@cli.with_output
def process(
*cubes: cli.inputcube,
#lapse_rate: cli.inputcube = None,
#neighbour_cube: cli.inputcube,
apply_lapse_rate_correction=False,
land_constraint=False,
similar_altitude=False,
Expand All @@ -57,15 +55,15 @@ def process(
and that of the grid point from which the temperature data is extracted.
Args:
neighbour_cube (iris.cube.Cube):
Cube of spot-data neighbours and the spot site information.
cube (iris.cube.Cube):
Cube containing the diagnostic data to be extracted.
lapse_rate (iris.cube.Cube):
Optional cube containing temperature lapse rates. If this cube is
cubes (iris.cube.Cube):
A list of cubes containing the diagnostic data to be extracted,
the lapse rate (optional) and the neighbour cube. Where the lapse
rate cube contains temperature lapse rates. If this cube is
provided and a screen temperature cube is being processed, the
lapse rates will be used to adjust the temperature to better
represent each spot's site-altitude.
And the neighbour cube is a cube of spot-data neighbours and
the spot site information.
apply_lapse_rate_correction (bool):
Use to apply a lapse-rate correction to screen temperature data so
that the data are a better match the altitude of the spot site for
Expand Down

0 comments on commit 1d7a15c

Please sign in to comment.