costfunction: chisq_m/a now track their results (better way?)
diagnostics: added LCurve class (not finished), comments for SVD
fielddata: properly ordered properties, added plot_field for ScalarField
phasemap: fixed bug for symmetric=False, cmap=None (no proper default!)

reconstruction: jutil.TakeTime is now used here.
scalebars: Module which allows nice scalebars to be displayed in all plots.
           This is the new default and can be turned off.
ramp: Now stores everything from the dataset directly to self, instead of
      keeping a reference to the DataSet (construct without Dataset in future!).
projector: tqdm now uses tqdm_notebook if used in IPython Notebook!
magcreator: Added functionality for smooth vortices (see de Graef et al.).
kernel: Corrected behaviour of slab geometry (u and v were still switched!).
dataset: phasemappers now accessable as dictionary or list. The append function
         now also takes lists (but projectors and phasemappers can in turn not
         set directly anymore). Se_inv will be updated automatically.
diagnostics: Functionality to access total, directional and magnitude error,
             according to Kemp et al.

kernel: u and v are switched and now finally correct.
        get_elementary_phase is also switched and corrected.
phasemapper: added PhaseMapperCharge from Feng Shan.
forward_model: now uses y instead of phase_vec/Se_inv and now direct properties.
costfunction: corrected some docstrings and documentation comments.
fielddata: corrected some missing integer divisions (// instead of /),
        added plot_streamline().

New API module unclutters the namespace (import pyramid.api as pr).

GUIs now import .ui-files directly.

Refactoring: Replaced MagData with VectorData and added ScalarData class (and common superclass FieldData).
magnitude is now called field (which is more appropriate)
projector now uses FieldData to process both vector and scalar data (foundation was in place before)

colormap: Added TransparentColormap.
magdata: Added get_magslice method, to_emd and from_emd.
phasemap: Added to_emd and from_emd.
gui: New GUI "PhaseMap Creator".
tests: Moved from ./tests to ./pyramid/tests. Not a package anymore!

semper: Implements the SemperFormat class for phasemaps and magnetizations.
forwardmodel: Docstrings for DistributedForwardModel.
phasemap: save_to_text now optionally without header.
ramp: Docstrings added.

forward_model: DistributedForwardModel created which uses the multiprocessing
               package for distributed computations.

Cleanup and documentation!
ramp: New class for polynomial ramps. Instantiated in the ForwardModel.
forwardmodel: Now uses new ramp class.
phasemapper: Ramp functionality moved to ramp class.
reconstruction: Ramp order not used, ramp can be now retrieved from the ramp
                class after reconstruction.
analytic, magcreator: Better and consistent definition of pixel centers and
                      their influence on the phase.
testing: Minor corrections for new syntax.

colormap: New module with colormap subclass which has special functions to
          calculate directional rgb-colors, now used in many plots!
__init__: On star import now also has abbreviations for a few modules.
fwd_model: Now has flags for fitting an offset and/or ramp.
           CAUTION: will be moved next update to new class!
magdata: Removed colorwheel stuff (all moved to 'colormap'). Overhaul of quiver
         plot in 2D and 3D. Now shows mask and uses new colormap for angular
         color coding.
phasemap: Now uses the new colormap for holo plots. Removed color wheel (moved
          to the new class). Added function to add ramps.
phasemapper: Now handles also offsets and ramps in the phase.
             CAUTION: will be moved next update to new class!
projector: Fixed bugs in SimpleProjector. 1) leftmost pixels are no longer moved
           moved to left corner of padded projection (when dim_uv is not None).
           2) odd padding when using dim_uv are now handled properly (one more
           pixel on top and right if necessary).
costfunction: n is now taken from the fwd_model instead of the data_set.
dataset: Introduced the count variable which gives the number of images.
magcreator: In the process of updating, more on next commit.
reconstruction: Also handles ramps and offsets now, properly extracts them after
                reconstruction.
regularisator: New argument 'add_params' is used to cut off input (for offset
               and ramp) which are not used in the regularisation.
scripts: several small changes...

costfunction: Now takes a ForwardModel as input instead of DataSet.
forwardmodel: New private function for processing one image (multiprocessing).
magdata: Quiver Plots (2D/3D) now support color encoding (angle or amplitude).
         Private method for creating the appropriate colormap.
reconstruction: Now takes Costfunction as argument instead of DataSet.
regularisator: Introduced ComboRegularisator.
scripts: New scripts.

Phase maps now also have a mask and a confidence matrix.
Began new script structure (temporary folders created).
Cleanup, logging and documentation done.
config: NTHREADS is now set here.
dataset: Method for creating 3D masks added.
phasemap: Mask and confidence matrix added. Padding and cropping supported.
forwardmodel: Stubs for multiprocessing added (next TODO!).
kernel: Added support for perturbed reference wave.
magdata: Padding and cropping supported.
projector: New property 'sparsity' introduced.
regularisator: Stub for ComboRegularisator added (next TODO!).
tests: Changed accordingly.

tests: implemented the missing TestCases!
dataset: mask is now created if not given!
phasemapper: guaranteed np.float32 format for RDRC (expected by Cython)
projector: now uses fft.FLOAT

docstrings: updated!
costfunction: CFAdapterScipyCG obsolete, deleted estimate_lambda()
dataset: use_fftw and threads obsolete
diagnostics: implemented stuff... much stuff...
fft: Docstrings and implementation of threads
magcreator: fixed bug in slab (dimension mix-up)
phasemap: plot now also returns colorbar
reconstruction: PrintIterator and optimize_simple_leastsq obsolete
regularisator: Docstrings
scripts: minor modifications
scripts - reconstruct_random_pixels: now use optimize_linear
testcases: analytic, compliance, kernel, magcreator, magdata, projector

kernel, phasemapper: now use the new pyramid.fft module.
MagData, PhaseMap: now use np.float32 instead of np.float64
MagData: new quiver_plot3d with just matplotlib (buggy and still WOP).
logging: deleted several logging.debug prompts for speed up.
util: deleted module!

setup: Changes to setup.py, pyramid.version to fit to numpy and jutil
       now uses __all__ magic and supports from pyramid import *
tests: changes to test_compliance/magcreator/analytic (should now work)
collaborations: added several scripts for Patrick
reconstruction: added batch file for the reconstruction of several configs
test methods: (unfinished) scripts for fftw tests and kernel comparisons
paper 1: ch5-4 changed padding values to 0, 1, 3 and 7
plotting: deleted plt.show() lines (have to be done manually now or via Spyder)
logging: now named _log instead of LOG (private variable instead of constant)
         also some logs were disabled, because Pylint says they are slow...
reconstruction: now has info argument (pass a list in which cost info is copied)
phasemapper: changed sign of constant PHI_0, is now correctly positive (instead
             the negative z-integration is taken into account which was not done
             before!)
kernel: now uses FFTW, numpy code was changed accordingly and is still available
phasemapper: also uses FFTW now, work in progress: FFTW for jac_T_dot

        m: i'm'age
        n: i'n'put

Still to do: PhaseMapperElectric does not work
             3D reconstruction does not converge

regularisator: new module to represent different regularisation strategies
costfunction: changed to use the new Regularisator classes, changed arguments!
dataset: fixed bug that always displayed the own phase maps instead of provided
reconstruction: changed to use the new Regularisator classes, changed arguments!
scripts/rueffner_file: tried to avoid Memory Error (no success)
scripts/zi_an: added holographic contour plots with overlayd magnetization
scripts/reconstruction_sparse_cg_test: now uses Regularisator classes and plots
                                       phase differences (original - reconstr.)

pep8: optimizations
phasemapper_core: numcore module for phasemapper
scripts: compatibility with new structure
reconstruction: new scripts

package: some minor corrections (mainly import statements), some old functions
         were revived (e.g. in MagData)

scripts: adaption to the new structure and sorting (more work is to do here...)

_version: __version__ string is now imported from this file

phasemapper_core.pyx: added to separate the corresponding numcore_functions
                      from kernel_core.pyx

Renames:
datacollection --> dataset
optimizer      --> reconstruction

scripts:
interactive_setup is now implemented in an extended Spyder startup file.
some other scripts are now
the rest is NOT adapted, yet, which is the next task at hand
furthermore scripts will be sorted and unused ones deleted in the next commit

not represent the correct matrizes (hopefully, now they do).

>>> PACKAGE
forwardmodel, kernel, phasemapper:
        b_0 is now again inherent part of the kernel.
projector:
        Corrected .jac_T_dot, now delivers product for the correct matrix.
>>> SCRIPTS
simple_reconstruction:
        Does simple compliance tests for 1 and 2 projections and tests a simple
        solver via scipy.sparse.linalg.cg for the reconstruction.

documentation: minor changes and updates of docstrings

modularity and compatibility with future algorithms and ideas.