Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Commit

Permalink
Update index operations documentation
Browse files Browse the repository at this point in the history 
Note that a reference dataset can be created using long_term_average in
operation descriptions of index operations.

Closes #496
  • Loading branch information
Jānis Gailis committed Mar 5, 2018
1 parent e5e11bc commit 636eb45
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions cate/ops/index.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ def enso_nino34(ds: xr.Dataset,
lat_min=-5 lon_max=-120 lat_max=5.
:param ds: A monthly SST dataset
:param file: Path to the reference data file
:param file: Path to the reference data file. A suitable reference dataset can be generated using the
long_term_average operation
:param var: Dataset variable (geophysial quantity) to use for index
calculation.
:param threshold: If given, boolean El Nino/La Nina timeseries will be
Expand Down Expand Up @@ -90,7 +91,8 @@ def enso(ds: xr.Dataset,
anomalies of monthly means of SST data in the given region.
:param ds: A monthly SST dataset
:param file: Path to the reference data file
:param file: Path to the reference data file. A suitable reference dataset can be generated using the
long_term_average operation
:param var: Dataset variable to use for index calculation
:param region: Region for index calculation, the default is Nino3.4
:param custom_region: If 'custom' is chosen as the 'region', this parameter
Expand Down Expand Up @@ -132,7 +134,8 @@ def oni(ds: xr.Dataset,
anomalies of monthly means of SST data in the Nino3.4 region.
:param ds: A monthly SST dataset
:param file: Path to the reference data file
:param file: Path to the reference data file. A suitable reference dataset can be generated using the
long_term_average operation
:param var: Dataset variable to use for index calculation
:param threshold: If given, boolean El Nino/La Nina timeseries will be
calculated and added to the output dataset, according to the given
Expand Down

3 comments on commit 636eb45

@kjpearson
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding "to create a climatology" to the end of this sentence would help clarify what is meant by reference data here.

@JanisGailis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there was a discussion at some point that the meaning of 'climatology' is narrow as it can mean a dataset aggregated over a certain well defined time period, hence we should use 'reference' here, as that wording also allows for, say, a reference aggregated over last three years or something.

The description of long_term_average itself does use 'climatological dataset' though.

So what do you think what would be the best wording here to be explanatory, but also precise in terminology?

@kjpearson
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I remember that conversation now. Chris had a strict definition of what constituted a climatology. We could put "e.g. a climatology" at the end of the first sentence and leave the second sentence alone. That would be accurate and also give the user a clue as to what was being asked for in practice.

Please sign in to comment.