bground

 1'''
 2Package: BGROUND
 3----------------
 4Semi-automatic background subtraction.
 5
 6* The package can subtract background in 1D-data = XY-data.
 7* The XY-data are typically saved in a file containing two (or more) columns.
 8
 9Key modules of bground package:
10
11* bground.api = API ~ UI = user interface to run all bkg subtraction methods
12* bground.help = help and links to docs to all background subtraction methods
13
14Complete documentation and examples are available at www:
15
16* https://pypi.org/project/bground
17* https://mirekslouf.github.io/bground/docs
18'''
19
20__version__ = '1.2.2'
21
22
23# Obligatory acknowledgement -- the development was co-funded by TACR.
24#  TACR requires that the acknowledgement is printed when we run the program.
25#  Nevertheless, Python packages run within other programs, not directly.
26# The following code ensures that the acknowledgement is printed when:
27#  (1) You run this file: __init__.py
28#  (2) You run the package from command line: python -m bground
29# Technical notes:
30#  To get item (2) above, we define __main__.py (next to __init__.py).
31#  The usage of __main__.py is not very common, but still quite standard.
32
33def acknowledgement():
34    print('BGROUND package - semi-automatic background subtraction.')
35    print('------')
36    print('The development of the package was co-funded by')
37    print('the Technology agency of the Czech Republic,')
38    print('program NCK, project TN02000020.')
39    
40if __name__ == '__main__':
41    acknowledgement()