You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@climate.apache.org by le...@apache.org on 2016/04/13 04:05:21 UTC
[2/2] climate git commit: CLIMATE-760 Address documentation warnings
CLIMATE-760 Address documentation warnings
Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/e9128b78
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/e9128b78
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/e9128b78
Branch: refs/heads/master
Commit: e9128b78d20dccdb8fbcf91f6899e144d89b56c5
Parents: e4df874
Author: Lewis John McGibbney <le...@jpl.nasa.gov>
Authored: Tue Apr 12 19:09:40 2016 -0700
Committer: Lewis John McGibbney <le...@jpl.nasa.gov>
Committed: Tue Apr 12 19:09:40 2016 -0700
----------------------------------------------------------------------
docs/source/conf.py | 4 +-
docs/source/ocw-logo-variant-sm-01-01-new.png | Bin 0 -> 25481 bytes
ocw/data_source/local.py | 90 +++++++++++++++------
3 files changed, 69 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/climate/blob/e9128b78/docs/source/conf.py
----------------------------------------------------------------------
diff --git a/docs/source/conf.py b/docs/source/conf.py
index fc9bd8a..4fec278 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -106,7 +106,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'default'
+html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -125,7 +125,7 @@ html_theme = 'default'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-#html_logo = None
+html_logo = 'ocw-logo-variant-sm-01-01-new.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
http://git-wip-us.apache.org/repos/asf/climate/blob/e9128b78/docs/source/ocw-logo-variant-sm-01-01-new.png
----------------------------------------------------------------------
diff --git a/docs/source/ocw-logo-variant-sm-01-01-new.png b/docs/source/ocw-logo-variant-sm-01-01-new.png
new file mode 100644
index 0000000..c7a3e0b
Binary files /dev/null and b/docs/source/ocw-logo-variant-sm-01-01-new.png differ
http://git-wip-us.apache.org/repos/asf/climate/blob/e9128b78/ocw/data_source/local.py
----------------------------------------------------------------------
diff --git a/ocw/data_source/local.py b/ocw/data_source/local.py
index 893928e..f4844f9 100644
--- a/ocw/data_source/local.py
+++ b/ocw/data_source/local.py
@@ -118,21 +118,29 @@ def load_WRF_2d_files(file_path=None,
filelist=None,
variable_name='T2',
name=''):
- ''' Load multiple WRF (or nuWRF) original output files containing 2D fields such as precipitation and surface variables into a Dataset.
- The dataset can be spatially subset.
+ ''' Load multiple WRF (or nuWRF) original output files containing 2D \
+ fields such as precipitation and surface variables into a Dataset. \
+ The dataset can be spatially subset.
+
:param file_path: Directory to the NetCDF file to load.
:type file_path: :mod:`string`
+
:param filename_pattern: Path to the NetCDF file to load.
- :type filename_pattern: :list:`string`
+ :type filename_pattern: :mod:`string`
+
:param filelist: A list of filenames
- :type filelist: :list:`string`
+ :type filelist: :mod:`string`
+
:param variable_name: The variable name to load from the NetCDF file.
:type variable_name: :mod:`string`
+
:param name: (Optional) A name for the loaded dataset.
:type name: :mod:`string`
- :returns: An OCW Dataset object with the requested variable's data from
+
+ :returns: An OCW Dataset object with the requested variable's data from \
the NetCDF file.
:rtype: :class:`dataset.Dataset`
+
:raises ValueError:
'''
@@ -347,17 +355,23 @@ def load_WRF_2d_files_RAIN(file_path=None,
filename_pattern=None,
filelist=None,
name=''):
- ''' Load multiple WRF (or nuWRF) original output files containing 2D fields such as precipitation and surface variables into a Dataset.
+ ''' Load multiple WRF (or nuWRF) original output files containing 2D \
+ fields such as precipitation and surface variables into a Dataset. \
The dataset can be spatially subset.
+
:param file_path: Directory to the NetCDF file to load.
:type file_path: :mod:`string`
+
:param filename_pattern: Path to the NetCDF file to load.
- :type filename_pattern: :list:`string`
+ :type filename_pattern: :mod:`string`
+
:param name: (Optional) A name for the loaded dataset.
:type name: :mod:`string`
- :returns: An OCW Dataset object with the requested variable's data from
+
+ :returns: An OCW Dataset object with the requested variable's data from \
the NetCDF file.
:rtype: :class:`dataset.Dataset`
+
:raises ValueError:
'''
@@ -411,36 +425,50 @@ def load_dataset_from_multiple_netcdf_files(variable_name,
lat_name=None, lon_name=None, time_name=None,
name='', file_list=None, file_path=None, filename_pattern=None,
mask_file=None, mask_variable=None, mask_value=0):
- ''' Load multiple netCDF files from the same source (an observation or a model) into a Dataset.
+ ''' Load multiple netCDF files from the same source \
+ (an observation or a model) into a Dataset. \
The dataset can be spatially subset.
+
:param filelist: A text file including a list of filenames
:type filelist: :mod:`string`
+
:param variable_name: The variable name to load from the NetCDF file.
:type variable_name: :mod:`string`
- :param lat_name: (Optional) The latitude variable name to extract from the
+
+ :param lat_name: (Optional) The latitude variable name to extract from the \
dataset.
:type lat_name: :mod:`string`
- :param lon_name: (Optional) The longitude variable name to extract from the
+
+ :param lon_name: (Optional) The longitude variable name to extract from the \
dataset.
:type lon_name: :mod:`string`
- :param time_name: (Optional) The time variable name to extract from the
+
+ :param time_name: (Optional) The time variable name to extract from the \
dataset.
:type time_name: :mod:`string`
+
:param name: (Optional) A name for the loaded dataset.
:type name: :mod:`string`
+
:param file_path: Directory to the NetCDF file to load.
:type file_path: :mod:`string`
+
:param filename_pattern: Path to the NetCDF file to load.
- :type filename_pattern: :list:`string`
+ :type filename_pattern: :mod:`string`
+
:param mask_file: A netcdf file with two-dimensional mask indices
:type filelist: :mod:`string`
+
:param mask_variable: The variable name to load from the mask_file.
:type variable_name: :mod:`string`
+
:param mask_value: an index for spatial subsetting a dataset
:type mask_value: :class:`int`
- :returns: An OCW Dataset object with the requested variable's data from
+
+ :returns: An OCW Dataset object with the requested variable's data from \
the NetCDF file.
:rtype: :class:`dataset.Dataset`
+
:raises ValueError:
'''
nc_files = []
@@ -484,21 +512,29 @@ def load_NLDAS_forcingA_files(file_path=None,
filelist=None,
variable_name='APCPsfc_110_SFC_acc1h',
name=''):
- ''' Load multiple NLDAS2 forcingAWRF files containing 2D fields such as precipitation and surface variables into a Dataset.
- The dataset can be spatially subset.
+ ''' Load multiple NLDAS2 forcingAWRF files containing 2D fields such \
+ as precipitation and surface variables into a Dataset. The dataset \
+ can be spatially subset.
+
:param file_path: Directory to the NetCDF file to load.
:type file_path: :mod:`string`
+
:param filename_pattern: Path to the NetCDF file to load.
- :type filename_pattern: :list:`string`
+ :type filename_pattern: :mod:`string`
+
:param filelist: A list of filenames
- :type filelist: :list:`string`
+ :type filelist: :mod:`string`
+
:param variable_name: The variable name to load from the NetCDF file.
:type variable_name: :mod:`string`
+
:param name: (Optional) A name for the loaded dataset.
:type name: :mod:`string`
- :returns: An OCW Dataset object with the requested variable's data from
+
+ :returns: An OCW Dataset object with the requested variable's data from \
the NetCDF file.
:rtype: :class:`dataset.Dataset`
+
:raises ValueError:
'''
@@ -540,20 +576,28 @@ def load_GPM_IMERG_files(file_path=None,
filelist=None,
variable_name='precipitationCal',
name='GPM_IMERG'):
- ''' Load multiple GPM Level 3 IMEGE files containing calibrated precipitation and generate an OCW Dataset obejct.
+ ''' Load multiple GPM Level 3 IMEGE files containing calibrated \
+ precipitation and generate an OCW Dataset obejct.
+
:param file_path: Directory to the HDF files to load.
:type file_path: :mod:`string`
+
:param filename_pattern: Path to the HDF files to load.
- :type filename_pattern: :list:`string`
+ :type filename_pattern: :mod:`string`
+
:param filelist: A list of filenames
- :type filelist: :list:`string`
+ :type filelist: :mod:`string`
+
:param variable_name: The variable name to load from the HDF file.
:type variable_name: :mod:`string`
+
:param name: (Optional) A name for the loaded dataset.
:type name: :mod:`string`
- :returns: An OCW Dataset object with the requested variable's data from
+
+ :returns: An OCW Dataset object with the requested variable's data from \
the HDF file.
:rtype: :class:`dataset.Dataset`
+
:raises ValueError:
'''