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