Changeset 1122 for trunk/bindings/python/nxs/__init__.py

Timestamp:

25/10/08 02:55:50 (4 years ago)

Author:

Paul Kienzle

Message:

python: make docs and code correspond; simplify slab interface. Refs #101.

File:

• trunk/bindings/python/nxs/__init__.py (modified) (4 diffs)

trunk/bindings/python/nxs/__init__.py

@@ -9 +9 @@
 used as well as the data measured.
 
-The NeXus file interface requires binary libraries to read the
-underlying HDF_ files, and 
-
-Please be sure that the NeXus libraries are installed.  The
-NeXus format site contains binaries for some platforms.  Details
-of where the nxs package searches for the libraries are in `nxs.napi`.
+The NeXus file interface requires compiled libraries to read the
+underlying HDF_ files.  Binary packages are available for some
+platforms from the NeXus site.  Details of where the nxs package 
+searches for the libraries are recorded in `nxs.napi`.
 
 Example
@@ -22 +20 @@
 
     import nxs
-    f = nxs.read('file.nxs')
+    f = nxs.load('file.nxs')
 
 We can examine the file structure using a number of commands::
@@ -36 +34 @@
 We can create a copy of the file using write::
 
-    nxs.write('copy.nxs', tree)
+    nxs.save('copy.nxs', tree)
 
 For a complete description of the features available in this tree view
@@ -45 +43 @@
 
 When converting code to python from other languages you do not
-necessarily want to redo the file handling code.  The `nxs.napi`
-package provides an interface which more closely follows the
-NeXus application programming interface (NAPI_).
+necessarily want to rewrite the file handling code using the
+tree view.  The `nxs.napi` module provides an interface which 
+more closely follows the NeXus application programming 
+interface (NAPI_).
 
 .. _Nexus: http://www.nexusformat.org/Introduction