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/07/01 16:50:17 UTC
[53/56] Add docs to gh-pages
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/genindex.html
----------------------------------------------------------------------
diff --git a/genindex.html b/genindex.html
new file mode 100644
index 0000000..ae3057c
--- /dev/null
+++ b/genindex.html
@@ -0,0 +1,432 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Index — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="#" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
+ | <a href="#D"><strong>D</strong></a>
+ | <a href="#E"><strong>E</strong></a>
+ | <a href="#G"><strong>G</strong></a>
+ | <a href="#L"><strong>L</strong></a>
+ | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
+ | <a href="#P"><strong>P</strong></a>
+ | <a href="#R"><strong>R</strong></a>
+ | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
+ | <a href="#U"><strong>U</strong></a>
+ | <a href="#W"><strong>W</strong></a>
+
+</div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/plotter.html#plotter.TaylorDiagram.add_contours">add_contours() (plotter.TaylorDiagram method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.add_dataset">add_dataset() (evaluation.Evaluation method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.add_datasets">add_datasets() (evaluation.Evaluation method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.add_metric">add_metric() (evaluation.Evaluation method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.add_metrics">add_metrics() (evaluation.Evaluation method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.TaylorDiagram.add_rms_contours">add_rms_contours() (plotter.TaylorDiagram method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.TaylorDiagram.add_sample">add_sample() (plotter.TaylorDiagram method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.TaylorDiagram.add_stddev_contours">add_stddev_contours() (plotter.TaylorDiagram method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/metrics.html#metrics.Bias">Bias (class in metrics)</a>
+ </dt>
+
+
+ <dt><a href="ocw/metrics.html#metrics.BinaryMetric">BinaryMetric (class in metrics)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset.html#dataset.Bounds">Bounds (class in dataset)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="data_source/data_sources.html#module-dap">dap (module)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset.html#dataset.Dataset">Dataset (class in dataset)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset_processor.html#module-dataset_processor">dataset_processor (module)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.draw_contour_map">draw_contour_map() (in module plotter)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/plotter.html#plotter.draw_portrait_diagram">draw_portrait_diagram() (in module plotter)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.draw_subregions">draw_subregions() (in module plotter)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.draw_taylor_diagram">draw_taylor_diagram() (in module plotter)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.draw_time_series">draw_time_series() (in module plotter)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.ensemble">ensemble() (in module dataset_processor)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation">Evaluation (class in evaluation)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="data_source/data_sources.html#rcmed.get_parameters_metadata">get_parameters_metadata() (in module rcmed)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="data_source/data_sources.html#dap.load">load() (in module dap)</a>
+ </dt>
+
+
+ <dt><a href="data_source/data_sources.html#local.load_file">load_file() (in module local)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="data_source/data_sources.html#module-local">local (module)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.metrics">metrics (evaluation.Evaluation attribute)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.normalize_dataset_datetimes">normalize_dataset_datetimes() (in module dataset_processor)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="data_source/data_sources.html#rcmed.parameter_dataset">parameter_dataset() (in module rcmed)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/plotter.html#module-plotter">plotter (module)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="data_source/data_sources.html#module-rcmed">rcmed (module)</a>
+ </dt>
+
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.results">results (evaluation.Evaluation attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.run">run() (evaluation.Evaluation method)</a>
+ </dt>
+
+ <dd><dl>
+
+ <dt><a href="ocw/metrics.html#metrics.Bias.run">(metrics.Bias method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/metrics.html#metrics.BinaryMetric.run">(metrics.BinaryMetric method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/metrics.html#metrics.TemporalStdDev.run">(metrics.TemporalStdDev method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/metrics.html#metrics.UnaryMetric.run">(metrics.UnaryMetric method)</a>
+ </dt>
+
+ </dl></dd>
+ </dl></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.safe_subset">safe_subset() (in module dataset_processor)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.set_cmap">set_cmap() (in module plotter)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset.html#dataset.Dataset.spatial_boundaries">spatial_boundaries() (dataset.Dataset method)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.spatial_regrid">spatial_regrid() (in module dataset_processor)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset.html#dataset.Dataset.spatial_resolution">spatial_resolution() (dataset.Dataset method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.subset">subset() (in module dataset_processor)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.target_datasets">target_datasets (evaluation.Evaluation attribute)</a>
+ </dt>
+
+
+ <dt><a href="ocw/plotter.html#plotter.TaylorDiagram">TaylorDiagram (class in plotter)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.temporal_rebin">temporal_rebin() (in module dataset_processor)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset.html#dataset.Dataset.temporal_resolution">temporal_resolution() (dataset.Dataset method)</a>
+ </dt>
+
+
+ <dt><a href="ocw/metrics.html#metrics.TemporalStdDev">TemporalStdDev (class in metrics)</a>
+ </dt>
+
+
+ <dt><a href="ocw/dataset.html#dataset.Dataset.time_range">time_range() (dataset.Dataset method)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="U">U</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.unary_metrics">unary_metrics (evaluation.Evaluation attribute)</a>
+ </dt>
+
+
+ <dt><a href="ocw/evaluation.html#evaluation.Evaluation.unary_results">unary_results (evaluation.Evaluation attribute)</a>
+ </dt>
+
+ </dl></td>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/metrics.html#metrics.UnaryMetric">UnaryMetric (class in metrics)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+
+ <dt><a href="ocw/dataset_processor.html#dataset_processor.write_netcdf">write_netcdf() (in module dataset_processor)</a>
+ </dt>
+
+ </dl></td>
+</tr></table>
+
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+
+
+
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="#" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/http-routingtable.html
----------------------------------------------------------------------
diff --git a/http-routingtable.html b/http-routingtable.html
new file mode 100644
index 0000000..7202d37
--- /dev/null
+++ b/http-routingtable.html
@@ -0,0 +1,219 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>HTTP Routing Table — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="index.html" />
+
+
+ <script type="text/javascript">
+ DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
+ </script>
+
+
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="#" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+
+ <h1>HTTP Routing Table</h1>
+
+ <div class="modindex-jumpbox">
+ <a href="#cap-/datasets"><strong>/datasets</strong></a> |
+ <a href="#cap-/list"><strong>/list</strong></a> |
+ <a href="#cap-/list_latlon"><strong>/list_latlon</strong></a> |
+ <a href="#cap-/list_time"><strong>/list_time</strong></a> |
+ <a href="#cap-/list_vars"><strong>/list_vars</strong></a> |
+ <a href="#cap-/metrics"><strong>/metrics</strong></a> |
+ <a href="#cap-/parameters"><strong>/parameters</strong></a> |
+ <a href="#cap-/path_leader"><strong>/path_leader</strong></a> |
+ <a href="#cap-/results"><strong>/results</strong></a> |
+ <a href="#cap-/run_evaluation"><strong>/run_evaluation</strong></a>
+ </div>
+
+ <table class="indextable modindextable" cellspacing="0" cellpadding="2">
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/datasets"><td></td><td>
+ <strong>/datasets</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--datasets-"><tt class="xref">GET /datasets/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/list"><td></td><td>
+ <strong>/list</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--list-"><tt class="xref">GET /list/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--list-(dir_path-path)"><tt class="xref">GET /list/(dir_path:path)</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/list_latlon"><td></td><td>
+ <strong>/list_latlon</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--list_latlon-(file_path-path)"><tt class="xref">GET /list_latlon/(file_path:path)</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/list_time"><td></td><td>
+ <strong>/list_time</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--list_time-(file_path-path)"><tt class="xref">GET /list_time/(file_path:path)</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/list_vars"><td></td><td>
+ <strong>/list_vars</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--list_vars-(file_path-path)"><tt class="xref">GET /list_vars/(file_path:path)</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/metrics"><td></td><td>
+ <strong>/metrics</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--metrics-"><tt class="xref">GET /metrics/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/parameters"><td></td><td>
+ <strong>/parameters</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--parameters-"><tt class="xref">GET /parameters/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--parameters-bounds"><tt class="xref">GET /parameters/bounds</tt></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--parameters-bounds-"><tt class="xref">GET /parameters/bounds/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/path_leader"><td></td><td>
+ <strong>/path_leader</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--path_leader-"><tt class="xref">GET /path_leader/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/results"><td></td><td>
+ <strong>/results</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--results-"><tt class="xref">GET /results/</tt></a></td><td>
+ <em></em></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#get--results-(dir_path-path)"><tt class="xref">GET /results/(dir_path:path)</tt></a></td><td>
+ <em></em></td></tr>
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-/run_evaluation"><td></td><td>
+ <strong>/run_evaluation</strong></td><td></td></tr>
+ <tr>
+ <td></td>
+ <td>
+ <a href="ui-backend/backend.html#post--run_evaluation-"><tt class="xref">POST /run_evaluation/</tt></a></td><td>
+ <em></em></td></tr>
+ </table>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="#" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..c0bd80d
--- /dev/null
+++ b/index.html
@@ -0,0 +1,163 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Welcome to Apache Open Climate Workbench’s documentation! — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="#" />
+ <link rel="next" title="Dataset Module" href="ocw/dataset.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="ocw/dataset.html" title="Dataset Module"
+ accesskey="N">next</a> |</li>
+ <li><a href="#">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="welcome-to-apache-open-climate-workbench-s-documentation">
+<h1>Welcome to Apache Open Climate Workbench’s documentation!<a class="headerlink" href="#welcome-to-apache-open-climate-workbench-s-documentation" title="Permalink to this headline">¶</a></h1>
+<p>Contents:</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="ocw/dataset.html">Dataset Module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ocw/dataset.html#bounds">Bounds</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocw/dataset.html#dataset">Dataset</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="ocw/dataset_processor.html">Dataset Processor Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ocw/evaluation.html">Evaluation Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ocw/metrics.html">Metrics Module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ocw/metrics.html#unarymetric">UnaryMetric</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocw/metrics.html#binarymetric">BinaryMetric</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocw/metrics.html#bias">Bias</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocw/metrics.html#temporalstddev">TemporalStdDev</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="ocw/plotter.html">Plotter Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data_source/data_sources.html">Data Sources</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-local">Local Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-rcmed">RCMED Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data_source/data_sources.html#module-dap">DAP Module</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="ui-backend/backend.html">Evaluation UI Webservices</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ui-backend/backend.html#configuration-and-dependencies">Configuration and Dependencies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ui-backend/backend.html#web-service-explanation">Web Service Explanation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ui-backend/backend.html#local-file-metadata-extractors">Local File Metadata Extractors</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ui-backend/backend.html#directory-helpers">Directory Helpers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ui-backend/backend.html#rcmed-helpers">RCMED Helpers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ui-backend/backend.html#processing-endpoints">Processing Endpoints</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="indices-and-tables">
+<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
+<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
+<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
+<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
+</ul>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="#">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Welcome to Apache Open Climate Workbench’s documentation!</a></li>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+
+ <h4>Next topic</h4>
+ <p class="topless"><a href="ocw/dataset.html"
+ title="next chapter">Dataset Module</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/index.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="ocw/dataset.html" title="Dataset Module"
+ >next</a> |</li>
+ <li><a href="#">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/objects.inv
----------------------------------------------------------------------
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 0000000..b566506
Binary files /dev/null and b/objects.inv differ
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/ocw/dataset.html
----------------------------------------------------------------------
diff --git a/ocw/dataset.html b/ocw/dataset.html
new file mode 100644
index 0000000..329ffb7
--- /dev/null
+++ b/ocw/dataset.html
@@ -0,0 +1,275 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Dataset Module — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="../index.html" />
+ <link rel="next" title="Dataset Processor Module" href="dataset_processor.html" />
+ <link rel="prev" title="Welcome to Apache Open Climate Workbench’s documentation!" href="../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="dataset_processor.html" title="Dataset Processor Module"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="../index.html" title="Welcome to Apache Open Climate Workbench’s documentation!"
+ accesskey="P">previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="dataset-module">
+<h1>Dataset Module<a class="headerlink" href="#dataset-module" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="bounds">
+<h2>Bounds<a class="headerlink" href="#bounds" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="dataset.Bounds">
+<em class="property">class </em><tt class="descclassname">dataset.</tt><tt class="descname">Bounds</tt><big>(</big><em>lat_min</em>, <em>lat_max</em>, <em>lon_min</em>, <em>lon_max</em>, <em>start</em>, <em>end</em><big>)</big><a class="headerlink" href="#dataset.Bounds" title="Permalink to this definition">¶</a></dt>
+<dd><p>Container for holding spatial and temporal bounds information.</p>
+<p>Certain operations require valid bounding information to be present for
+correct functioning. Bounds guarantees that a function receives well
+formed information without the need to do the validation manually.</p>
+<p>Spatial and temporal bounds must follow the following guidelines.</p>
+<ul class="simple">
+<li>Latitude values must be in the range [-90, 90]</li>
+<li>Longitude values must be in the range [-180, 180]</li>
+<li>Lat/Lon Min values must be less than the corresponding Lat/Lon Max values.</li>
+<li>Temporal bounds must a valid datetime object</li>
+</ul>
+<p>Default Bounds constructor</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>lat_min</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The minimum latitude bound.</li>
+<li><strong>lat_max</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The maximum latitude bound.</li>
+<li><strong>lon_min</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The minimum longitude bound.</li>
+<li><strong>lon_max</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The maximum longitude bound.</li>
+<li><strong>start</strong> (<a class="reference external" href="http://docs.python.org/library/datetime.html#module-datetime" title="(in Python v2.7)"><em>datetime</em></a>) – The starting datetime bound.</li>
+<li><strong>end</strong> (<a class="reference external" href="http://docs.python.org/library/datetime.html#module-datetime" title="(in Python v2.7)"><em>datetime</em></a>) – The ending datetime bound.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ValueError</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+<div class="section" id="dataset">
+<h2>Dataset<a class="headerlink" href="#dataset" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="dataset.Dataset">
+<em class="property">class </em><tt class="descclassname">dataset.</tt><tt class="descname">Dataset</tt><big>(</big><em>lats</em>, <em>lons</em>, <em>times</em>, <em>values</em>, <em>variable=None</em>, <em>name=''</em><big>)</big><a class="headerlink" href="#dataset.Dataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Container for a dataset’s attributes and data.</p>
+<p>Default Dataset constructor</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>lats</strong> (<em>numpy array</em>) – One dimensional numpy array of unique latitude values.</li>
+<li><strong>lons</strong> (<em>numpy array</em>) – One dimensional numpy array of unique longitude values.</li>
+<li><strong>times</strong> (<em>numpy array</em>) – One dimensional numpy array of unique python datetime
+objects.</li>
+<li><strong>values</strong> (<em>numpy array</em>) – Three dimensional numpy array of parameter values with
+shape [timesLength, latsLength, lonsLength].</li>
+<li><strong>variable</strong> (<a class="reference external" href="http://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) – Name of the value variable.</li>
+<li><strong>name</strong> – An optional string name for the Dataset.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ValueError</p>
+</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="dataset.Dataset.spatial_boundaries">
+<tt class="descname">spatial_boundaries</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.spatial_boundaries" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the spatial boundaries.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The Dataset’s bounding latitude and longitude values as a
+tuple in the form (min_lat, max_lat, min_lon, max_lon)</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(float, float, float, float)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="dataset.Dataset.spatial_resolution">
+<tt class="descname">spatial_resolution</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.spatial_resolution" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the latitudinal and longitudinal spatial resolution.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">This only works with properly gridded data.</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The Dataset’s latitudinal and longitudinal spatial resolution
+as a tuple of the form (lat_resolution, lon_resolution).</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(float, float)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="dataset.Dataset.temporal_resolution">
+<tt class="descname">temporal_resolution</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.temporal_resolution" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the temporal resolution.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-odd field"><td> </td><td class="field-body">If timedelta.days as calculated from the sorted list of times is an unrecognized value a ValueError is raised.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The temporal resolution.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="dataset.Dataset.time_range">
+<tt class="descname">time_range</tt><big>(</big><big>)</big><a class="headerlink" href="#dataset.Dataset.time_range" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the temporal range</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The start and end date of the Dataset’s temporal range as
+a tuple in the form (start_time, end_time).</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(datetime, datetime)</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Dataset Module</a><ul>
+<li><a class="reference internal" href="#bounds">Bounds</a></li>
+<li><a class="reference internal" href="#dataset">Dataset</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="../index.html"
+ title="previous chapter">Welcome to Apache Open Climate Workbench’s documentation!</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="dataset_processor.html"
+ title="next chapter">Dataset Processor Module</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ocw/dataset.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="dataset_processor.html" title="Dataset Processor Module"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="../index.html" title="Welcome to Apache Open Climate Workbench’s documentation!"
+ >previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/ocw/dataset_processor.html
----------------------------------------------------------------------
diff --git a/ocw/dataset_processor.html b/ocw/dataset_processor.html
new file mode 100644
index 0000000..30c90cc
--- /dev/null
+++ b/ocw/dataset_processor.html
@@ -0,0 +1,293 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Dataset Processor Module — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="../index.html" />
+ <link rel="next" title="Evaluation Module" href="evaluation.html" />
+ <link rel="prev" title="Dataset Module" href="dataset.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="evaluation.html" title="Evaluation Module"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="dataset.html" title="Dataset Module"
+ accesskey="P">previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="module-dataset_processor">
+<span id="dataset-processor-module"></span><h1>Dataset Processor Module<a class="headerlink" href="#module-dataset_processor" title="Permalink to this headline">¶</a></h1>
+<dl class="function">
+<dt id="dataset_processor.ensemble">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">ensemble</tt><big>(</big><em>datasets</em><big>)</big><a class="headerlink" href="#dataset_processor.ensemble" title="Permalink to this definition">¶</a></dt>
+<dd><p>Generate a single dataset which is the mean of the input datasets</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datasets</strong> – Datasets to be used to compose the ensemble dataset from.</td>
+</tr>
+</tbody>
+</table>
+<p>Note - All Datasets must be the same shape
+:type datasets: List of OCW Dataset Objects</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">New Dataset with a name of ‘Dataset Ensemble’</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">OCW Dataset Object</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="dataset_processor.normalize_dataset_datetimes">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">normalize_dataset_datetimes</tt><big>(</big><em>dataset</em>, <em>timestep</em><big>)</big><a class="headerlink" href="#dataset_processor.normalize_dataset_datetimes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Normalize Dataset datetime values.</p>
+<p>Force daily to an hour time value of 00:00:00.
+Force monthly data to the first of the month at midnight.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dataset</strong> (<em>Dataset</em>) – The Dataset which will have its’ time value normalized.</li>
+<li><strong>timestep</strong> (<em>String</em>) – The timestep of the Dataset’s values. Either ‘daily’ or
+‘monthly’.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A new Dataset with normalized datetimes.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="dataset_processor.safe_subset">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">safe_subset</tt><big>(</big><em>subregion</em>, <em>target_dataset</em><big>)</big><a class="headerlink" href="#dataset_processor.safe_subset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Safely subset given dataset with subregion information</p>
+<p>A standard subset requires that the provided subregion be entirely contained
+within the datasets bounds. <cite>safe_subset</cite> returns the overlap of the
+subregion and dataset without returning an error.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>subregion</strong> (<em>ocw.dataset.Bounds</em>) – The Bounds with which to subset the target Dataset.</li>
+<li><strong>target_dataset</strong> (<em>ocw.dataset.Dataset</em>) – The Dataset object to subset.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The subset-ed Dataset object</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Dataset</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="dataset_processor.spatial_regrid">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">spatial_regrid</tt><big>(</big><em>target_dataset</em>, <em>new_latitudes</em>, <em>new_longitudes</em><big>)</big><a class="headerlink" href="#dataset_processor.spatial_regrid" title="Permalink to this definition">¶</a></dt>
+<dd><p>Regrid a Dataset using the new latitudes and longitudes</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>target_dataset</strong> (<em>Open Climate Workbench Dataset Object</em>) – Dataset object that needs temporal regridding applied</li>
+<li><strong>new_latitudes</strong> (<em>1d Numpy Array</em>) – Array of latitudes</li>
+<li><strong>new_longitudes</strong> (<em>1d Numpy Array</em>) – Array of longitudes</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A new spatially regridded Dataset</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Open Climate Workbench Dataset Object</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="dataset_processor.subset">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">subset</tt><big>(</big><em>subregion</em>, <em>target_dataset</em><big>)</big><a class="headerlink" href="#dataset_processor.subset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Subset given dataset(s) with subregion information</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>subregion</strong> (<em>Bounds</em>) – The Bounds with which to subset the target Dataset.</li>
+<li><strong>target_dataset</strong> (<em>Dataset</em>) – The Dataset object to subset.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The subset-ed Dataset object</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Dataset</p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ValueError</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="dataset_processor.temporal_rebin">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">temporal_rebin</tt><big>(</big><em>target_dataset</em>, <em>temporal_resolution</em><big>)</big><a class="headerlink" href="#dataset_processor.temporal_rebin" title="Permalink to this definition">¶</a></dt>
+<dd><p>Rebin a Dataset to a new temporal resolution</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>target_dataset</strong> (<em>Open Climate Workbench Dataset Object</em>) – Dataset object that needs temporal regridding</li>
+<li><strong>temporal_resolution</strong> (<em>Python datetime.timedelta object</em>) – The new temporal bin size</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A new temporally rebinned Dataset</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Open Climate Workbench Dataset Object</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="dataset_processor.write_netcdf">
+<tt class="descclassname">dataset_processor.</tt><tt class="descname">write_netcdf</tt><big>(</big><em>dataset</em>, <em>path</em>, <em>compress=True</em><big>)</big><a class="headerlink" href="#dataset_processor.write_netcdf" title="Permalink to this definition">¶</a></dt>
+<dd><p>Write a dataset to a NetCDF file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>dataset</strong> (<em>ocw.dataset.Dataset</em>) – The dataset to write.</li>
+<li><strong>path</strong> (<a class="reference external" href="http://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) – The output file path.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="dataset.html"
+ title="previous chapter">Dataset Module</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="evaluation.html"
+ title="next chapter">Evaluation Module</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ocw/dataset_processor.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="evaluation.html" title="Evaluation Module"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="dataset.html" title="Dataset Module"
+ >previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/ocw/evaluation.html
----------------------------------------------------------------------
diff --git a/ocw/evaluation.html b/ocw/evaluation.html
new file mode 100644
index 0000000..f1a5435
--- /dev/null
+++ b/ocw/evaluation.html
@@ -0,0 +1,293 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Evaluation Module — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="../index.html" />
+ <link rel="next" title="Metrics Module" href="metrics.html" />
+ <link rel="prev" title="Dataset Processor Module" href="dataset_processor.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="metrics.html" title="Metrics Module"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="dataset_processor.html" title="Dataset Processor Module"
+ accesskey="P">previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="evaluation-module">
+<h1>Evaluation Module<a class="headerlink" href="#evaluation-module" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="evaluation.Evaluation">
+<em class="property">class </em><tt class="descclassname">evaluation.</tt><tt class="descname">Evaluation</tt><big>(</big><em>reference</em>, <em>targets</em>, <em>metrics</em>, <em>subregions=None</em><big>)</big><a class="headerlink" href="#evaluation.Evaluation" title="Permalink to this definition">¶</a></dt>
+<dd><p>Container for running an evaluation</p>
+<p>An <em>Evaluation</em> is the running of one or more metrics on one or more
+target datasets and a (possibly optional) reference dataset. Evaluation
+can handle two types of metrics, <tt class="docutils literal"><span class="pre">unary</span></tt> and <tt class="docutils literal"><span class="pre">binary</span></tt>. The validity
+of an Evaluation is dependent upon the number and type of metrics as well
+as the number of datasets.</p>
+<p>A <tt class="docutils literal"><span class="pre">unary</span></tt> metric is a metric that runs over a single dataset. If you add
+a <tt class="docutils literal"><span class="pre">unary</span></tt> metric to the Evaluation you are only required to add a
+reference dataset or a target dataset. If there are multiple datasets
+in the evaluation then the <tt class="docutils literal"><span class="pre">unary</span></tt> metric is run over all of them.</p>
+<p>A <tt class="docutils literal"><span class="pre">binary</span></tt> metric is a metric that runs over a reference dataset and
+target dataset. If you add a <tt class="docutils literal"><span class="pre">binary</span></tt> metric you are required to add a
+reference dataset and at least one target dataset. The <tt class="docutils literal"><span class="pre">binary</span></tt> metrics
+are run over every (reference dataset, target dataset) pair in the
+Evaluation.</p>
+<p>An Evaluation must have at least one metric to be valid.</p>
+<p>Default Evaluation constructor.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>reference</strong> (<em>Dataset</em>) – The reference Dataset for the evaluation.</li>
+<li><strong>targets</strong> (<em>List of Datasets</em>) – A list of one or more target datasets for the
+evaluation.</li>
+<li><strong>metrics</strong> (<em>List of Metrics</em>) – A list of one or more Metric instances to run
+in the evaluation.</li>
+<li><strong>subregions</strong> (<em>List of Bounds objects</em>) – (Optional) Subregion information to use in the
+evaluation. A subregion is specified with a Bounds object.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ValueError</p>
+</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="evaluation.Evaluation.add_dataset">
+<tt class="descname">add_dataset</tt><big>(</big><em>target_dataset</em><big>)</big><a class="headerlink" href="#evaluation.Evaluation.add_dataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a Dataset to the Evaluation.</p>
+<p>A target Dataset is compared against the reference dataset when the
+Evaluation is run with one or more metrics.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<em>Dataset</em>) – The target Dataset to add to the Evaluation.</td>
+</tr>
+<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-even field"><td> </td><td class="field-body">If a dataset to add isn’t an instance of Dataset.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="evaluation.Evaluation.add_datasets">
+<tt class="descname">add_datasets</tt><big>(</big><em>target_datasets</em><big>)</big><a class="headerlink" href="#evaluation.Evaluation.add_datasets" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add multiple Datasets to the Evaluation.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_datasets</strong> (<em>List of Dataset objects</em>) – The list of datasets that should be added to
+the Evaluation.</td>
+</tr>
+<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-even field"><td> </td><td class="field-body">If a dataset to add isn’t an instance of Dataset.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="evaluation.Evaluation.add_metric">
+<tt class="descname">add_metric</tt><big>(</big><em>metric</em><big>)</big><a class="headerlink" href="#evaluation.Evaluation.add_metric" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a metric to the Evaluation.</p>
+<p>A metric is an instance of a class which inherits from metrics.Metric.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metric</strong> (<em>Metric</em>) – The metric instance to add to the Evaluation.</td>
+</tr>
+<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-even field"><td> </td><td class="field-body">If the metric to add isn’t a class that inherits
+from metrics.Metric.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="evaluation.Evaluation.add_metrics">
+<tt class="descname">add_metrics</tt><big>(</big><em>metrics</em><big>)</big><a class="headerlink" href="#evaluation.Evaluation.add_metrics" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add multiple metrics to the Evaluation.</p>
+<p>A metric is an instance of a class which inherits from metrics.Metric.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metrics</strong> (<em>List of Metrics</em>) – The list of metric instances to add to the Evaluation.</td>
+</tr>
+<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
+<tr class="field-even field"><td> </td><td class="field-body">If a metric to add isn’t a class that inherits
+from metrics.Metric.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="evaluation.Evaluation.metrics">
+<tt class="descname">metrics</tt><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.metrics" title="Permalink to this definition">¶</a></dt>
+<dd><p>The list of “binary” metrics (A metric which takes two Datasets)
+that the Evaluation should use.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="evaluation.Evaluation.results">
+<tt class="descname">results</tt><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.results" title="Permalink to this definition">¶</a></dt>
+<dd><p>A list containing the results of running regular metric evaluations.
+The shape of results is <tt class="docutils literal"><span class="pre">(num_metrics,</span> <span class="pre">num_target_datasets)</span></tt> if
+the user doesn’t specify subregion information. Otherwise the shape
+is <tt class="docutils literal"><span class="pre">(num_metrics,</span> <span class="pre">num_target_datasets,</span> <span class="pre">num_subregions)</span></tt>.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="evaluation.Evaluation.run">
+<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#evaluation.Evaluation.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run the evaluation.</p>
+<p>There are two phases to a run of the Evaluation. First, if there are
+any “binary” metrics they are run through the evaluation. Binary
+metrics are only run if there is a reference dataset and at least one
+target dataset.</p>
+<p>If there is subregion information provided then each dataset is subset
+before being run through the binary metrics.</p>
+<p>..note:: Only the binary metrics are subset with subregion information.</p>
+<p>Next, if there are any “unary” metrics they are run. Unary metrics are
+only run if there is at least one target dataset or a reference dataset.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="evaluation.Evaluation.target_datasets">
+<tt class="descname">target_datasets</tt><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.target_datasets" title="Permalink to this definition">¶</a></dt>
+<dd><p>The target dataset(s) which should each be compared with
+the reference dataset when the evaluation is run.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="evaluation.Evaluation.unary_metrics">
+<tt class="descname">unary_metrics</tt><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.unary_metrics" title="Permalink to this definition">¶</a></dt>
+<dd><p>The list of “unary” metrics (A metric which takes one Dataset) that
+the Evaluation should use.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="evaluation.Evaluation.unary_results">
+<tt class="descname">unary_results</tt><em class="property"> = None</em><a class="headerlink" href="#evaluation.Evaluation.unary_results" title="Permalink to this definition">¶</a></dt>
+<dd><p>A list containing the results of running the unary metric
+evaluations. The shape of unary_results is
+<tt class="docutils literal"><span class="pre">(num_metrics,</span> <span class="pre">num_targets)</span></tt> where <tt class="docutils literal"><span class="pre">num_targets</span> <span class="pre">=</span>
+<span class="pre">num_target_ds</span> <span class="pre">+</span> <span class="pre">(1</span> <span class="pre">if</span> <span class="pre">ref_dataset</span> <span class="pre">!=</span> <span class="pre">None</span> <span class="pre">else</span> <span class="pre">0</span></tt></p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="dataset_processor.html"
+ title="previous chapter">Dataset Processor Module</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="metrics.html"
+ title="next chapter">Metrics Module</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ocw/evaluation.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="metrics.html" title="Metrics Module"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="dataset_processor.html" title="Dataset Processor Module"
+ >previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/climate/blob/791a06c5/ocw/metrics.html
----------------------------------------------------------------------
diff --git a/ocw/metrics.html b/ocw/metrics.html
new file mode 100644
index 0000000..6dfe295
--- /dev/null
+++ b/ocw/metrics.html
@@ -0,0 +1,262 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Metrics Module — Apache Open Climate Workbench 0.3-incubating documentation</title>
+
+ <link rel="stylesheet" href="../_static/default.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '0.3-incubating',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="top" title="Apache Open Climate Workbench 0.3-incubating documentation" href="../index.html" />
+ <link rel="next" title="Plotter Module" href="plotter.html" />
+ <link rel="prev" title="Evaluation Module" href="evaluation.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="plotter.html" title="Plotter Module"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="evaluation.html" title="Evaluation Module"
+ accesskey="P">previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="metrics-module">
+<h1>Metrics Module<a class="headerlink" href="#metrics-module" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="unarymetric">
+<h2>UnaryMetric<a class="headerlink" href="#unarymetric" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="metrics.UnaryMetric">
+<em class="property">class </em><tt class="descclassname">metrics.</tt><tt class="descname">UnaryMetric</tt><a class="headerlink" href="#metrics.UnaryMetric" title="Permalink to this definition">¶</a></dt>
+<dd><p>Abstract Base Class from which all unary metrics inherit.</p>
+<dl class="method">
+<dt id="metrics.UnaryMetric.run">
+<tt class="descname">run</tt><big>(</big><em>target_dataset</em><big>)</big><a class="headerlink" href="#metrics.UnaryMetric.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run the metric for a given target dataset.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> – The dataset on which the current metric will
+be run.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The result of evaluating the metric on the target_dataset.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="binarymetric">
+<h2>BinaryMetric<a class="headerlink" href="#binarymetric" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="metrics.BinaryMetric">
+<em class="property">class </em><tt class="descclassname">metrics.</tt><tt class="descname">BinaryMetric</tt><a class="headerlink" href="#metrics.BinaryMetric" title="Permalink to this definition">¶</a></dt>
+<dd><p>Abstract Base Class from which all binary metrics inherit.</p>
+<dl class="method">
+<dt id="metrics.BinaryMetric.run">
+<tt class="descname">run</tt><big>(</big><em>ref_dataset</em>, <em>target_dataset</em><big>)</big><a class="headerlink" href="#metrics.BinaryMetric.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Run the metric for the given reference and target datasets.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>ref_dataset</strong> (<em>Dataset</em>) – The Dataset to use as the reference dataset when
+running the evaluation.</li>
+<li><strong>target_dataset</strong> – The Dataset to use as the target dataset when
+running the evaluation.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The result of evaluation the metric on the reference and
+target dataset.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="bias">
+<h2>Bias<a class="headerlink" href="#bias" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="metrics.Bias">
+<em class="property">class </em><tt class="descclassname">metrics.</tt><tt class="descname">Bias</tt><a class="headerlink" href="#metrics.Bias" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the bias between a reference and target dataset.</p>
+<dl class="method">
+<dt id="metrics.Bias.run">
+<tt class="descname">run</tt><big>(</big><em>ref_dataset</em>, <em>target_dataset</em><big>)</big><a class="headerlink" href="#metrics.Bias.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the bias between a reference and target dataset.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Overrides BinaryMetric.run()</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>ref_dataset</strong> (<em>Dataset.</em>) – The reference dataset to use in this metric run.</li>
+<li><strong>target_dataset</strong> (<em>Dataset.</em>) – The target dataset to evaluate against the
+reference dataset in this metric run.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The difference between the reference and target datasets.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Numpy Array</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="temporalstddev">
+<h2>TemporalStdDev<a class="headerlink" href="#temporalstddev" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="metrics.TemporalStdDev">
+<em class="property">class </em><tt class="descclassname">metrics.</tt><tt class="descname">TemporalStdDev</tt><a class="headerlink" href="#metrics.TemporalStdDev" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the standard deviation over the time.</p>
+<dl class="method">
+<dt id="metrics.TemporalStdDev.run">
+<tt class="descname">run</tt><big>(</big><em>target_dataset</em><big>)</big><a class="headerlink" href="#metrics.TemporalStdDev.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the temporal std. dev. for a datasets.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Overrides UnaryMetric.run()</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target_dataset</strong> (<em>Dataset</em>) – The target_dataset on which to calculate the
+temporal standard deviation.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The temporal standard deviation of the target dataset</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Numpy Array</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="../index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Metrics Module</a><ul>
+<li><a class="reference internal" href="#unarymetric">UnaryMetric</a></li>
+<li><a class="reference internal" href="#binarymetric">BinaryMetric</a></li>
+<li><a class="reference internal" href="#bias">Bias</a></li>
+<li><a class="reference internal" href="#temporalstddev">TemporalStdDev</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="evaluation.html"
+ title="previous chapter">Evaluation Module</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="plotter.html"
+ title="next chapter">Plotter Module</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/ocw/metrics.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../http-routingtable.html" title="HTTP Routing Table"
+ >routing table</a> |</li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="plotter.html" title="Plotter Module"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="evaluation.html" title="Evaluation Module"
+ >previous</a> |</li>
+ <li><a href="../index.html">Apache Open Climate Workbench 0.3-incubating documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Michael Joyce.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
+ </div>
+ </body>
+</html>
\ No newline at end of file