You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@climate.apache.org by jo...@apache.org on 2014/11/19 17:53:33 UTC
[18/21] climate git commit: CLIMATE-558 - Update local module
documentation links
CLIMATE-558 - Update local module documentation links
Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/e9b8ad8c
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/e9b8ad8c
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/e9b8ad8c
Branch: refs/heads/master
Commit: e9b8ad8cebd23cd269dea7aeafda7736fbea37ba
Parents: ff85d6f
Author: Michael Joyce <jo...@apache.org>
Authored: Mon Nov 17 12:50:35 2014 -0800
Committer: Michael Joyce <jo...@apache.org>
Committed: Mon Nov 17 12:50:35 2014 -0800
----------------------------------------------------------------------
ocw/data_source/local.py | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/climate/blob/e9b8ad8c/ocw/data_source/local.py
----------------------------------------------------------------------
diff --git a/ocw/data_source/local.py b/ocw/data_source/local.py
index acd8b7d..ae6c286 100644
--- a/ocw/data_source/local.py
+++ b/ocw/data_source/local.py
@@ -118,29 +118,34 @@ def load_file(file_path,
''' Load a NetCDF file into a Dataset.
:param file_path: Path to the NetCDF file to load.
- :type file_path: String
+ :type file_path: :mod:`string`
+
:param variable_name: The variable name to load from the NetCDF file.
- :type variable_name: String
+ :type variable_name: :mod:`string`
+
:param elevation_index: (Optional) The elevation index for which data should
be returned. Climate data is often times 4 dimensional data. Some
datasets will have readins at different height/elevation levels. OCW
expects 3D data so a single layer needs to be stripped out when loading.
By default, the first elevation layer is used. If desired you may
specify the elevation value to use.
- :type elevation_index: Integer
+ :type elevation_index: :class:`int`
+
:param lat_name: (Optional) The latitude variable name to extract from the
dataset.
- :type lat_name: String
+ :type lat_name: :mod:`string`
+
:param lon_name: (Optional) The longitude variable name to extract from the
dataset.
- :type lon_name: String
+ :type lon_name: :mod:`string`
+
:param time_name: (Optional) The time variable name to extract from the
dataset.
- :type time_name: String
+ :type time_name: :mod:`string`
:returns: An OCW Dataset object with the requested variable's data from
the NetCDF file.
- :rtype: ocw.dataset.Dataset object
+ :rtype: :class:`dataset.Dataset`
:raises ValueError: When the specified file path cannot be loaded by ndfCDF4
or when the lat/lon/time variable name cannot be determined