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 2017/04/26 01:01:54 UTC
climate git commit: CLIMATE-529 Verify that Nio dependency has been
removed from mccsearch
Repository: climate
Updated Branches:
refs/heads/master 0950f5438 -> 7cf81795d
CLIMATE-529 Verify that Nio dependency has been removed from mccsearch
Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/7cf81795
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/7cf81795
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/7cf81795
Branch: refs/heads/master
Commit: 7cf81795d016b84e69896507345f9738d464ac48
Parents: 0950f54
Author: Lewis John McGibbney <le...@gmail.com>
Authored: Tue Apr 25 17:56:48 2017 -0700
Committer: Lewis John McGibbney <le...@gmail.com>
Committed: Tue Apr 25 17:56:48 2017 -0700
----------------------------------------------------------------------
mccsearch/README.md | 4 ++--
mccsearch/docs/mccsearch.md | 18 +++++++++---------
2 files changed, 11 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/climate/blob/7cf81795/mccsearch/README.md
----------------------------------------------------------------------
diff --git a/mccsearch/README.md b/mccsearch/README.md
index e337ce9..d076ead 100644
--- a/mccsearch/README.md
+++ b/mccsearch/README.md
@@ -1,3 +1,3 @@
-#Graph-based Search for the Identification and Chatacterization of Mesoscale Convective Complexes
+# Graph-based Search for the Identification and Chatacterization of Mesoscale Convective Complexes
-Please see /docs/mccsearch.md document for all current documentation relating to this module.
\ No newline at end of file
+Please see the [mccsearch documentation](https://github.com/apache/climate/blob/master/mccsearch/docs/mccsearch.md) for all current documentation relating to this module.
http://git-wip-us.apache.org/repos/asf/climate/blob/7cf81795/mccsearch/docs/mccsearch.md
----------------------------------------------------------------------
diff --git a/mccsearch/docs/mccsearch.md b/mccsearch/docs/mccsearch.md
index a879093..8885809 100644
--- a/mccsearch/docs/mccsearch.md
+++ b/mccsearch/docs/mccsearch.md
@@ -1,6 +1,6 @@
-#Graph-based Search for the Identification and Chatacterization of Mesoscale Convective Complexes
+# Graph-based Search for the Identification and Chatacterization of Mesoscale Convective Complexes
-##Introduction and Context
+## Introduction and Context
This program searches for a weather feature known as a Mesoscale Convective Complex (MCC) in gridded infrared and precipitation rate satellite data (MERG and TRMM datasets have been tested).
The work is direct output from [Kim Whitehall's](http://www.kimwhitehall.com/) Ph.D. thesis which acts as the basis and driver for inclusion in OCW.
@@ -12,7 +12,7 @@ Data from MERG and TRMM datasets is read from netCDF files into arrays with the
* numerous visualizations including histograms of precipitation during MCC, area Vs time plots, cross dataset visualization of CE...
If you are still reading this file it means that you wish to use the mccsearch program, or learn more about it within the context of OCW.
-##What is needed?
+## What is needed?
* Python (verified with 2.7.4) - http://python.org
* netCDF4 (verified with netCDF4-1.1.1)- http://www.unidata.ucar.edu/software/netcdf/
* sciPy (verified with 0.14.0)- http://www.scipy.org/scipylib/index.html
@@ -24,7 +24,7 @@ If you are still reading this file it means that you wish to use the mccsearch p
So, without further a-do, lets progress with using mccsearch.
-##Source Code
+## Source Code
* [mccSearch.py](../code/mccSearch.py) contains the primary MCC functionality
* [mccSearchUI.py](../code/mccSearchUI.py) contains a wizard type Q&A for running the mccSearch program
* [mainProg.py](../code/mainProg.py) contains a sample of the general workflow of the order the modules should be called. You will have to supply three main input arguments:
@@ -32,29 +32,29 @@ So, without further a-do, lets progress with using mccsearch.
* TRMMdirName : a directory containing the original TRMM data in netCDF format
* CEoriDirName : a directory containing the original MERG data in netCDF format
-##Download MERG and TRMM data
+## Download MERG and TRMM data
The following assumptions are made:
* Input data are in one folder. mainProg.py looks for MERG data as a single directory 'CEoriDirName' and TRMM data as a single directory 'TRMMdirName', just as described above. These directories cannot be the same and the data all needs to be of type netCDF data files only.
* There is RUDIMENTARY FILE checking that ensures ALL files between the times requested are in the folder requested in netCDF format.
* THERE IS NO FILE ERROR HANDLING. Please ensure that the MERG data and the TRMM data files are correlated temporally and spatially
-##Run mccSearchUI.py
+## Run mccSearchUI.py
As a first try to determine the workflow, run the mccSearchUI.py wizard.
-##Configure mainProg.py
+## Configure mainProg.py
Guidance on the workflow can be seen in the figure below. More details on individual functions in mccSearch.py can be found in the DocStrings.
The general workflow of the program. The dashed lines indicate optional paths.
-##Run mainProg.py
+## Run mainProg.py
Keep your fingers & toes crossed!! Once everything went well, the directory you indicated where outputs should be stored will be generated, and four folders should appear in it.
* The image folder will store all images generated from plots.
* The textFiles folder will store all the text files generated during the run, e.g. cloudElementsUserFile.txt that contains information about each cloud element identified
* The MERGnetcdfCEs folder contains the infrared data in clipped netCDF files that have been generated for each cloud element identified
* The TRMMnetcdfCEs folder contains the precipitation data in clipped netCDF files that have been generated for each cloud element identified.
-##Anticipated future work
+## Anticipated future work
* Implement functionality for file checking to ensure all files are there
* Create a user interface based on mainProg.py.
* Plug the project into the Regional Climate Model Evaluation Database (RCMED) that is available at Apache OCW.