myimg

 1'''
 2Package: MyImg
 3--------------
 4
 5A toolbox for the processing of micrographs, which can do the following:
 6    
 71. Process single micrographs (improve contrast, insert scalebars, etc.).
 82. Prepare publication-ready tiled images from the processed micrographs.
 93. Apply additional tools, such as: FFT, size distributions, labelling ...
10
11Key components:
12
13* myimg.api = a simple user interface with basic tools
14* myimg.apps = a subpackage providing access to the additional tools
15'''
16
17__version__ = '0.5.7'
18
19
20# More complete list of objects, modules, and sub-packages:
21# ---------------------------------------------------------    
22# * myimg.api = simple user interface, the starting point
23# * myimg.objects = key objects used by *MyImg*
24#     - myimg.objects.MyImage = single micrographs
25#     - myimg.objects.MyReport = multi-images = tiled images
26# * myimg.apps = sub-package containing additional tools and/or applications
27#     - myimg.apps = list of available additional applications
28#     - myimg.api.Apps = practical access to additional applications
29# * myimg.plots = auxiliary funcs for plotting
30# * myimg.utils = auxiliary funcs for more complex utils in *MyImg*
31# * myimg.settings = default settings employed by *MyImg* objects
32
33
34# Obligatory acknowledgement -- the development was co-funded by TACR
35# -------------------------------------------------------------------
36#  TACR requires that the acknowledgement is printed when we run the program.
37#  Nevertheless, Python packages run within other programs, not directly.
38# The following code ensures that the acknowledgement is printed when:
39#  (1) You run this file: __init__.py
40#  (2) You run the package from command line: python -m ediff
41# Technical notes:
42#  To get item (2) above, we define __main__.py (next to __init__.py).
43#  The usage of __main__.py is not very common, but still quite standard.
44
45def acknowledgement():
46    print('MyImg package - a toolbox for processing of microscopic images.')
47    print('------')
48    print('The development of the package was co-funded by')
49    print('the Technology agency of the Czech Republic,')
50    print('program NCK, project TN02000020.')
51    
52if __name__ == '__main__':
53    acknowledgement()