bground

 1# Package initialization file.
 2
 3'''
 4Package: BGROUND
 5----------------
 6Semi-automatic background subtraction.
 7
 8* The package can subtract background in 1D-data = X,Y-data.
 9* The X,Y-data are typically saved in a file containing two (or more) columns.
10
11Sub-modules of bground package:
12
13* bground.api = package API, which can be used as a simple UI = user interface
14* bground.bdata = classes/data structures for background definition
15* bground.bfunc = functions and utilities for final background removal
16* bground.help = supplementary functions, which can print help to the package
17* bground.iplot = semi-automatic bkg subtraction with an interactive plot
18* bground.wvlet = automatic background subtraction using wavelet transform
19
20Usage of bground package:
21
22* See the initial example at the top of bground.api documentation.
23'''
24
25__version__ = '1.1.1'
26
27
28# Obligatory acknowledgement -- the development was co-funded by TACR.
29#  TACR requires that the acknowledgement is printed when we run the program.
30#  Nevertheless, Python packages run within other programs, not directly.
31# The following code ensures that the acknowledgement is printed when:
32#  (1) You run this file: __init__.py
33#  (2) You run the package from command line: python -m bground
34# Technical notes:
35#  To get item (2) above, we define __main__.py (next to __init__.py).
36#  The usage of __main__.py is not very common, but still quite standard.
37
38def acknowledgement():
39    print('BGROUND package - semi-automatic background subtraction.')
40    print('------')
41    print('The development of the package was co-funded by')
42    print('the Technology agency of the Czech Republic,')
43    print('program NCK, project TN02000020.')
44    
45if __name__ == '__main__':
46    acknowledgement()