Changeset 5053

Timestamp:

Feb 19, 2008, 3:44:11 PM (17 years ago)

Author:

ole

Message:

Added more data formats to ignore and more documentation

Location:

anuga_core/source/anuga/utilities

Files:

• data_audit.py (modified) (1 diff)
• data_audit_wrapper.py (modified) (1 diff)

anuga_core/source/anuga/utilities/data_audit.py

@@ -1 +1 @@
 """Track IP of data files in an entire directory tree.
 See docstring for the public function IP_verified()
-for details.
+for details on algorithm.
+
+An example of the XML format expected by this module is
+
+
+<?xml version="1.0" encoding="iso-8859-1"?>
+
+<ga_license_file>
+  <metadata>
+    <author>Ole Nielsen</author>
+  </metadata>
+  
+  <datafile>
+    <filename>channel1.png</filename>
+    <checksum>1339122967</checksum>
+    <publishable>Yes</publishable>
+    <accountable>Ole Nielsen</accountable>
+    <source>Generated by ANUGA development team</source>
+    <IP_owner>Geoscience Australia</IP_owner>
+    <IP_info>For use with ANUGA manual</IP_info>    
+  </datafile>
+
+</ga_license_file>
+
+
+There can be more than one <datafile> element to cover files
+with different extensions.
+
+
+Here's a DTD format, we might implement one day
+
+   <!DOCTYPE ga_license_file [
+      <!ELEMENT ga_license_file (source, datafile+)>
+      <!ELEMENT metadata (author, svn_keywords)>
+      <!ELEMENT svn_keywords (author, date, revision, url, id)>    
+      <!ELEMENT datafile (filename, publishable, accountable, 
+                        owner, location, IP_info)>    
+      <!ELEMENT filename (#PCDATA)>
+      <!ELEMENT publishable (#PCDATA)>    
+      <!ELEMENT accountable (#PCDATA)>        
+      <!ELEMENT source (#PCDATA)>                               
+      <!ELEMENT IP_owner (#PCDATA)>            
+      <!ELEMENT IP_info (#PCDATA)>                
+  ]>
+
+
+
 """
 

anuga_core/source/anuga/utilities/data_audit_wrapper.py

@@ -14 +14 @@
 
 # Ignore source code files
-extensions_to_ignore = ['.py','.c', '.h', '.cpp', '.f', '.bat']
+extensions_to_ignore = ['.py','.c', '.h', '.cpp', '.f', '.bat', '.m']
 
 # Ignore LaTeX documents