Athemis/pyKinetics
1
0
Fork 0
mirror of https://github.com/Athemis/pyKinetics.git synced 2025-04-25 22:49:11 +00:00
Code Issues Releases Wiki Activity

Improve documentation

Browse source
This commit is contained in:
Alexander Minges 2015-08-27 18:20:48 +02:00
parent 754c62ffd1
commit 4808d72f8e
1 changed files with 18 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

21
analyze-cli.py
View file

@ -36,6 +36,11 @@ except ImportError:
class ExperimentHelper(): class ExperimentHelper():
"""
Helper class for dealing with results of libkinetics.
Provides plotting and data output functionality for libkinetics.Experiment.
"""
def __init__(self, experiment, logger): def __init__(self, experiment, logger):
self.exp = experiment self.exp = experiment
@ -181,9 +186,14 @@ def parse_arguments():
def initialize_logger(): def initialize_logger():
""" """
Initialization of logging subsystem. Two logging handlers are brought up: Initialization of logging subsystem.
'fh' which logs to a log file and 'ch' which logs to standard output.
:return logger: returns a logger instance Two logging handlers are brought up: 'fh' which logs to a log file and
'ch' which logs to standard output. If colorlog is installed, logging
to console will be colored.
Returns:
logger: logging.Logger instance
""" """
if COLORED_LOG: if COLORED_LOG:
fmt = '%(log_color)s%(levelname)-8s%(reset)s %(message)s' fmt = '%(log_color)s%(levelname)-8s%(reset)s %(message)s'
@ -227,6 +237,11 @@ def initialize_logger():
def main(): def main():
"""
Main method of pyKinetics.
Will be executed when analyze-cli.py is started from the command line.
"""
# parse command line arguments # parse command line arguments
args = parse_arguments() args = parse_arguments()
# initialize logger # initialize logger