source: nappy/trunk/doc/00README.txt @ 339

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/nappy/trunk/doc/00README.txt@339
Revision 339, 2.7 KB checked in by astephen, 15 years ago (diff)

Initial revision

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1NASAAmesIO-0.3
2==============
3
4Current status on Sunday 25th April 2004.
5
6Most read classes now work.
7
8Use the test/testReadNNNN.py scripts to try and read them.
9
10Note that the data sections may not be reading properly for some FFIs.
11
12The readData() methods are DEFINITELY not yet working for FFIs:
132110, 2160, 2310.
14
15The FFI classes for 2010, 3010 and 4010 all follow the same code exactly.
16
17Reversing the independent variable marks
18========================================
19
20I have reversed the contents of the X, XNAME, DX, NX and NXDEF arrays as they are
21recorded in the NASA Ames documentation as Fortran-style arrays. These are indexed
22from the most-changing variable first whereas Python and C-style arrays are indexed
23from the least-changing variable first. These have therefore been reversed on input
24and may not match the documentation accordingly. However, when writing output to
25NASA Ames they are reversed again so that the files themselves will not be affected.
26
27/bin directory
28==============
29The /bin directory holds to python scripts to convert CDMS-compatible files to and
30from NASA Ames format. Note that CDMS can read Grads format (including GRIB), NetCDF,
31HDF (not as standard) and other formats and can therefore convert these files to NASA
32Ames.
33
34/doc directory
35==============
36
37Contains information on the package as well the original specification document for NASA Ames.
38
39
40Windows version
41===============
42
43The main package has been written without dependencies on other packages so instead of
44using Numeric arrays only lists are used. Whilst making a slight performance sacrifice
45this makes the package portable quickly to more platforms. In particular it can be used
46on Windows.
47
48Both the NASA Ames file classes and the conversion tools in the /bin directory contain
49calls to CDAT (cdms package) but an error is raised to inform users of Windows that this
50is not available. However, the read and write NASA Ames routines are not affected.
51
52
53Things to do
54============
55
561. Complete the read data methods and check correct.
57
582. Create simple write methods to match the read stuff.
59
603. Create the following bridge to CDMS:
61
62        self.toCdmsFile(filename, attribute_dictionary=None) - attribute
63                        dictionary can be extras if you want
64        self.varToCdmsVariable(variable) - you can send it a variable number
65                        or a variable name.
66        self.varToCdmsAxis(independentVariable) - you can send it an independent
67                        variable name or number.
68        self.auxVarToCdmsVariable(variable) - you can send it a name or number.
69
704. Create the cdms2na.py script containing a functions called:
71        cdmsToNASAAmesFile(cdmsFile, naFile, nasaAmesAttributes={})
72        cdmsVariableToNASAAmesFile(cdmsVariable, naFile, nasaAmesAttributes={})
73
74Ag Stephens, 20 April 2004.
Note: See TracBrowser for help on using the repository browser.