topostats

Topostats

Submodules

• topostats.__main__
• topostats.filters
• topostats.grains
• topostats.grainstats
• topostats.io
• topostats.logs
• topostats.plotting
• topostats.plottingfuncs
• topostats.processing
• topostats.run_topostats
• topostats.scars
• topostats.theme
• topostats.thresholds
• topostats.tracing
• topostats.utils
• topostats.validation

Attributes

LOGGER
release
__version__

Functions

setup_logger(→ logging.Logger)

Setup a standard logger.

Package Contents

topostats.setup_logger(log_name: str = LOGGER_NAME) → logging.Logger

Setup a standard logger.

The logger for the module is initialised when the module is loaded (as this functions is called from __init__.py). This creates two stream handlers, one for general output and one for errors which are formatted differently (there is greater information in the error formatter). To use in modules import the ‘LOGGER_NAME’ and create a logger as shown in the Examples, it will inherit the formatting and direction of messages to the correct stream.

Parameters:

log_name (str) – Name under which logging information occurs.

Returns:

Logger object.

Return type:

logging.Logger

Examples

To use the logger in (sub-)modules have the following.

import logging from topostats.logs.logs import LOGGER_NAME

LOGGER = logging.getLogger(LOGGER_NAME)

LOGGER.info(‘This is a log message.’)

topostats.LOGGER

topostats.release

topostats.__version__ = ''