# -*- coding: utf-8 -*-

Created on Tue Jan 22 11:45:08 2019

@author: lenz

The 'pyVis' package collects classes and functions for data management and
visualization. While every class and function was extensively used in the past,
the revised versions of this package are barely tested. 

See the examples for an introduction to the basic functionality.

The package is structured as follows:

    - pyVis.data:
        This is the core of the package. Contains classes for reading and
        storing the data. 
        
    - pyVis.onConfig:
        Contains the OnConfig class which reads, manages and stores data
        from 'OnConfig' files and performs various calculation on them.

    - pyVis.view:
        Contains a set of high-level functions to quickly view your data. 
    
    - pyVis.styling:
        Defines some helper functions that bundle functionalities like 
        fig.tight_layout(), etc. Also defines the default style for our plots.
        
        ALWAYS CALL
            
            pyVis.styling.defaultStyling()
        
        AT THE BEGINNING OF YOUR SCRIPT.
        
    - pyVis.plotting:
        Functions and classes for specialized plots.
    
    - pyVis.aux:
        Auxiliary functions and definitions used in other submodules.

    - pyVis.derivatives:
        Collects methods for computing derivatives numerically.

To-Do:

    - thoroughly test the revised implementations
      
    - think of a better name because a package pyVis already exists

    - enlarge the functionality of the OnConfig class (see To-Dos there)

    - generalize brokenAxis to x- and/or y-broken axis