Home | Trees | Indices | Help |
|
---|
|
1 #!/usr/bin/python -tt 2 #======================================================================= 3 # General Documentation 4 5 """qtcm Package. 6 7 Some useful online help commands for the package: 8 * help(qtcm): Help for the package. A list of all modules in this 9 package is found in the "Package Contents" section of the help 10 output. 11 * help(qtcm.M): Details of each module "M", where "M" is the module's 12 name. 13 """ 14 15 #----------------------------------------------------------------------- 16 # Additional Documentation 17 # 18 # SVN Revision Code: 19 # $Id: __init__.py 3 2008-06-25 01:02:46Z jlin $ 20 # 21 # Modification History: 22 # - 30 May 2008: Original by Johnny Lin, Physics Department, North 23 # Park University. Passed passably reasonable visual tests. 24 # 25 # Notes: 26 # - Written for Python 2.4. 27 # - Module docstrings can be tested using the doctest module. To 28 # test, execute "python __init__.py". 29 # - See import statements throughout for non-"built-in" packages and 30 # modules required. 31 # 32 # Copyright (c) 2007-2008 by Johnny Lin. For licensing, distribution 33 # conditions, contact information, and additional documentation see 34 # the URL http://www.johnny-lin.com/py_pkgs/qtcm/doc/. 35 #======================================================================= 36 37 38 39 40 #---------------- Module General Import and Declarations --------------- 41 42 #- If you're importing this module in testing mode, or you're running 43 # pydoc on this module via the command line, import user-specific 44 # settings to make sure any non-standard libraries are found: 45 46 import os, sys 47 if (__name__ == "__main__") or \ 48 ("pydoc" in os.path.basename(sys.argv[0])): 49 import user 50 del os, sys 51 52 53 #- Import package version and set module version to package version. 54 # Note that in qtcm.__init__.py if you put the statement "del 55 # package_version" then it will be impossible to use the statement 56 # "import qtcm.package_version" or "from qtcm import package_ver- 57 # sion": 58 59 import package_version 60 __version__ = package_version.version 61 __author__ = package_version.author 62 __date__ = package_version.date 63 __credits__ = package_version.credits 64 65 66 #- List of modules in package: 67 68 __all__ = [ "defaults", 69 "field", 70 "num_settings", 71 "package_version", 72 "plot", 73 "qtcm", 74 "where_close" ] 75 76 77 78 79 #-------------- Import To Make Available At Package Level -------------- 80 81 from field import Field 82 from num_settings import N #- numpy/Numeric/numarray as appropriate 83 from qtcm import Qtcm 84 85 86 87 88 #-------------------------- Main: Test Module ------------------------- 89 90 #- Execute doctest if module is run from command line: 91 92 if __name__ == "__main__": 93 """Test the module. 94 95 Note: To help ensure that module testing of this file works, the 96 parent directory to the current directory is added to sys.path. 97 """ 98 import doctest, sys, os 99 sys.path.append(os.pardir) 100 doctest.testmod(sys.modules[__name__]) 101 102 103 104 105 # ===== end file ===== 106
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Fri Sep 12 14:24:50 2008 | http://epydoc.sourceforge.net |