climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lewi...@apache.org
Subject [49/50] [abbrv] git commit: Smarten up documentation for mccsearch branch.
Date Thu, 16 Oct 2014 17:17:45 GMT
Smarten up documentation for mccsearch branch.


Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/f9ae9c2d
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/f9ae9c2d
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/f9ae9c2d

Branch: refs/heads/master
Commit: f9ae9c2d85adc15cff578f9a272198c6121cbcff
Parents: 232601c
Author: Lewis John McGibbney <lewis.j.mcgibbney@jpl.nasa.gov>
Authored: Mon Aug 25 11:00:14 2014 -0700
Committer: Lewis John McGibbney <lewis.j.mcgibbney@jpl.nasa.gov>
Committed: Wed Oct 15 15:18:05 2014 -0700

----------------------------------------------------------------------
 mccsearch/README.md         |  2 +-
 mccsearch/docs/mccsearch.md | 18 +++++++++---------
 2 files changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/climate/blob/f9ae9c2d/mccsearch/README.md
----------------------------------------------------------------------
diff --git a/mccsearch/README.md b/mccsearch/README.md
index 6ee45e9..e337ce9 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
 
-Please see /docs directory for all current documentation relating to this module.
\ No newline at end of file
+Please see /docs/mccsearch.md document for all current documentation relating to this module.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/climate/blob/f9ae9c2d/mccsearch/docs/mccsearch.md
----------------------------------------------------------------------
diff --git a/mccsearch/docs/mccsearch.md b/mccsearch/docs/mccsearch.md
index 4948228..466e027 100644
--- a/mccsearch/docs/mccsearch.md
+++ b/mccsearch/docs/mccsearch.md
@@ -19,21 +19,21 @@ The data is read from netCDF files into arrays with the dimensions time,
latitud
  * LATS4D
 
 ##Download the source code and store in a folder
- (1) mccSearch.py contains all the function needed 
- (2) mccSearchUI.py contains a wizard type Q&A for running the program
- (3) process.py contains some needed functions (from older version of Apache OCW)
- (4) file.py contains some needed functions (from older version of Apache OCW)
- (5) mainProg.py contains a sample of the  general workflow of the order the modules should
be called. There are three main inputs you will have to supply:
+ * mccSearch.py contains all the function needed 
+ * mccSearchUI.py contains a wizard type Q&A for running the program
+ * process.py contains some needed functions (from older version of Apache OCW)
+ * file.py contains some needed functions (from older version of Apache OCW)
+ * mainProg.py contains a sample of the  general workflow of the order the modules should
be called. There are three main inputs you will have to supply:
      * mainDirStr : this is the directory where you wish all the output files –images,
textfiles, clipped netCDF files- to be store
      * TRMMdirName : this is the directory where the original TRMM data in netCDF format
is stored
      * CEoriDirName : this is the directory where the original MERG data in netCDF format
is stored
- (6) Store the GrADsScripts folder (and contents) in a separate folder in the same main directory
as the source code folder.  
+ * Store the GrADsScripts folder (and contents) in a separate folder in the same main directory
as the source code folder.  
 
 ##Download data in one folder (with only the data files)
 This is a very crude program. The following assumptions are made:
- (1) input data are in one folder. For MERG data this is CEoriDirName and for the TRMM data
this is TRMMdirName in mainProg.py.  These directories cannot be the same.
- (2) THERE IS NO FILE CHECKING. So please ensure ALL your files are there in netCDF format.

- (3)  THERE IS NO FILE ERROR HANDLING. Please ensure that the MERG data and the TRMM data
files are correlated temporally and spatially
+ * input data are in one folder. For MERG data this is CEoriDirName and for the TRMM data
this is TRMMdirName in mainProg.py.  These directories cannot be the same.
+ * THERE IS NO FILE CHECKING. So please ensure ALL your files are there 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
 As a first try to determine the workflow, run the mccSearchUI.py wizard. 


Mime
View raw message