Changeset 344

Timestamp:

15/06/04 13:46:45 (16 years ago)

Author:

astephen

Message:

* empty log message *

Location:

nappy/trunk

Files:

• doc/00README.txt (modified) (2 diffs)
• doc/Documentation notes.txt (deleted)
• doc/nappy.doc (added)
• test/testCdmsWrite.py (modified) (1 diff)
• test/testRead1001.py (deleted)
• test/testRead1010.py (deleted)
• test/testRead1020.py (deleted)
• test/testRead2010.py (deleted)
• test/testRead2110.py (deleted)
• test/testRead2160.py (deleted)
• test/testRead2310.py (deleted)
• test/testRead3010.py (deleted)
• test/testRead4010.py (deleted)
• test/testReadAllFFIs.py (modified) (1 diff)
• test/testWrites.py (modified) (1 diff)

nappy/trunk/doc/00README.txt

@@ -1 @@
-NASAAmesIO-0.3
+nappy
+=====
+
+NASA Ames Package in Python.
+
+Description:
+============
+
+A NASA Ames IO package - A python input/output package for NASA Ames file formats
+
+
+Version history:
+================
+
+Most recent version
+
+Version 0.9.7.2: Original - Ag Stephens, 14th May 2004.
+
+
+Planning Notes:
+===============
+
+Software written with reference to:
+
+'Format Specification for Data Exchange' paper by Gaines and Hipkind (1998).
+makeheader.f fortran application to write NASA Ames headers, Anne de Rudder (2000).
+Ames python library developed by Bryan Lawrence (2003).
+
+Conventions:
 ==============
 
-Current status on Sunday 25th April 2004.
+The basic NASAAmes class holds a dictionary called naVars which holds all the 
+variables described in the Gaines and Hipkind document and these are all named
+using CAPITAL LETTERS for compliance/reference with that document.
 
-Most read classes now work.
+For example the number of independent variables is held in the instance variable:
 
-Use the test/testReadNNNN.py scripts to try and read them.
+self["NIV"]
+
+Return values are being calculated for many functions/methods are often prefixed with
+'rt' symbolising 'return'.
+
+
+CDMS-link
+=========
+
+At the start, there are a number of formats that are not compatible with the CDMS format:
+
+2110 - changing second independent variable length at each first independent variable value.
+2160 - Character independent and auxiliary variables - would need a map to implement in CDMS so not intended.
+2310 - changing second independent variable length at each first independent variable value.
+
+The following are unlikely, but can be done:
+
+1020 - with NVPM (implied independent variable values) - we can allow it but low priority to implement.
+
+FFIs that need to be converted:
+
+1001, 1010, 2010, 3010, 4010.
+
+The following have already been done:
+
+1001, 2010, 3010, 4010.
+
+Current Status of the software
+==============================
+
+All read classes should now work.
+
+Use the test/testReadAllFFIs.py scripts to try and read them.
 
 Note that the data sections may not be reading properly for some FFIs.
 
-The readData() methods are DEFINITELY not yet working for FFIs:
-2110, 2160, 2310.
+The FFI classes for 2010, 3010 and 4010 all follow the same code exactly.
 
-The FFI classes for 2010, 3010 and 4010 all follow the same code exactly.
+Write classes should be working for: 1001, 2010, 3010 and 4010.
+
+You can test these using:
+
+test/testWrites.py
+
+You can write cdat output files to the following formats (i.e. any that you can write to from nappy):
+
+1001, 2010, 3010, 4010.
+
+Test with:
+
+test/testCmdsWrite.py
+
 
 Reversing the independent variable marks
@@ -51 +125 @@
 
 
-Things to do
-============
 
-1. Complete the read data methods and check correct.
+Plans for improving nappy
+=========================
 
-2. Create simple write methods to match the read stuff.
 
-3. Create the following bridge to CDMS:
+•       Split the code into individual FFI files (naFile1001, naFile1010 etc). - Ag
+    ALL SPLIT AND READS APPEAR TO BE WORKING.
+•       Document code – Ag  - MAINLY DONE
+•       Write a NASA Ames compliance document by working through the Gaines and Hipkind guide and listing all the requirements of a file conforming to the NASA Ames standard – Wendy.
+•       Test all the input/output routines – Sue.
+•       Write additional output routines for FFI 1010, 1020, 2310, 2160, 2110. – Sue.
+•       Write a manual for the package - Ag
+•       Create a standard mapping file between cdat and nappy so that global attributes convert appropriately. This should be xml and should be a local table for various centres – Sue and Ag.
+•       Put the cdms stuff in the a class called NACdms and put that in cdmsTools/cdmsOut.py -> CdmsOut().
+        NOT DONE DUE TO ANNOYING MULTIPLE RECURSIVE IMPORT DEPENDENCIES!!!
+•       Make the /bin directory and put the scripts in there called cdms2na.py, na2nc.py, also make nc2na.py that is just a pointer to cdms2na.py (just there to simplify things for dummies).
 
-        self.toCdmsFile(filename, attribute_dictionary=None) - attribute 
-                        dictionary can be extras if you want
-        self.varToCdmsVariable(variable) - you can send it a variable number
-                        or a variable name.
-        self.varToCdmsAxis(independentVariable) - you can send it an independent
-                        variable name or number.
-        self.auxVarToCdmsVariable(variable) - you can send it a name or number.
+- routines should not automatically read or write the DATA section.
+   DONE FOR READING, IS IT NEEDED FOR WRITING - you either write or you don't.
+- strip out _recursiveList operators so that they can be used elsewhere (and any other generic funcs) - maybe put in listManipulators.py
+    DONE TELL SUE.
+- Organise the underscores leading func names to be coherent.
+    DONE
+- Start including exceptions everywhere for checking.
+- history doesn't map properly from netcdf.
+- delimiters - let the user decide how to space items.
+- output formatting - let user decide eg %s, %4.3f etc
 
-4. Create the cdms2na.py script containing a functions called:
-        cdmsToNASAAmesFile(cdmsFile, naFile, nasaAmesAttributes={})
-        cdmsVariableToNASAAmesFile(cdmsVariable, naFile, nasaAmesAttributes={})
 
-Ag Stephens, 20 April 2004.
+
+

nappy/trunk/test/testCdmsWrite.py

@@ -1 @@
-import sys ; sys.path.append("..")
-import naCore, textParser, naFile, general
-reload(naCore) ; reload(textParser) ; reload(naFile) ; reload(general)
+import sys 
+import os
+sys.path.append(os.path.join("..", ".."))
+import nappy ; reload(nappy)
 
 for ffi in [1001, 2010, 3010, 4010]:
     print "Reading in NASA Ames 1001:"
-    x=general.openNAFile(r'../data_files/%s.na' % ffi)
+    infile=os.path.join("..", "data_files", "%s.na" % ffi)
+    x=nappy.openNAFile(infile)
+    x.readData()
     print "Read file OK."
 
-    outfile="../output/out%s.nc" % ffi
+    outfile=os.path.join("..", "output", "out%s.nc" % ffi)
     print "Writing output NetCDF file %s" % outfile 
     x.toCdmsFile(outfile)

nappy/trunk/test/testReadAllFFIs.py

@@ -9 +9 @@
 """
 
+import os
+import sys
+sys.path.append(os.path.join("..", ".."))
+import nappy ; reload(nappy)
+
+
 FFIs=(1001, 1010, 1020, 2010, 2110, 2160, 2310, 3010, 4010)
 
-for FFI in FFIs:
-    print "Testing FFI: ", FFI
-    __import__("testRead%s" % FFI)
+for ffi in FFIs:
+    print "\n\nTesting FFI: ", ffi
+    file=os.path.join("..", "data_files", "%s.na" % ffi)
+    if not os.path.exists(file): file=os.path.join("..", "data_files", "%sa.na" % ffi)
+    f=nappy.openNAFile(file)
+    f.readData()
+    print "DX:",f.DX
+    print "VNAME", f.VNAME
+    print "V:",f.V[0]
+
+    if f.NAUXV>1:
+        print "AUX:"
+        print f.ANAME[0], f.ASCAL[0]
+        print f.A[0]

nappy/trunk/test/testWrites.py

@@ -1 @@
-import sys ; sys.path.append("..")
-import naCore, textParser, naFile, general
-reload(naCore) ; reload(textParser) ; reload(naFile) ; reload(general)
+#!/usr/bin/env python
+
+"""
+testWrites.py
+==============
+
+Tests all working write routines for nappy package.
+
+"""
+
+import os
+import sys ; sys.path.append(os.path.join("..",".."))
+import nappy ; reload(nappy)
 
 for ffi in [1001, 2010, 3010, 4010]:
-    x=general.openNAFile(r'../data_files/%s.na' % ffi)
+    infile=os.path.join("..", "data_files", "%s.na" % ffi)
+    print "Reading in ", infile
+    x=nappy.openNAFile(infile)
+    x.readData()
     d=x.getNADict()
     del d["FFI"]
 
-    print "Writing output file output/out%s.na..." % ffi
-    y=general.openNAFile(r'..\output\out%s.na' % ffi, 'w', d)
+    outfile=os.path.join("..", "output", "out%s.na" % ffi)
+    print "Writing output ", outfile
+    y=nappy.openNAFile(outfile, 'w', d)
     print "\nFile written successfully, so let's open it."
 
-    x=general.openNAFile(r'..\output\out%s.na' % ffi)
+    x=nappy.openNAFile(outfile)
     print "variables are:\n"
     print x.getVariables()