pyexperiment 0.1.13

Framework for easy and clean experiments with python.

============
pyexperiment
============

[](https://pypi.python.org/pypi/pyexperiment/)

There is no shortage of great Python libraries for command line
interfaces, logging, configuration file management, persistent state,
or plotting. When writing small scripts for quick experiments though,
it's often too much effort to configure these components, and one ends
up rewriting the same setup code over and over again.

Pyexperiment fixes this by providing a very simple way to jump start a
short experiment, adding many features of a full-blown framework.

Importing one or several modules from pyexperiment will give you:
- A basic command line interface that allows calling arbitrary
functions (and passing arguments) from the command prompt, providing
help text derived from the functions' docstrings (based on the
standard library's argparse).
- A simple configuration management with an easy way to provide
default values (based on the excellent configobj library).
- A thread-safe logger with configurable logging levels and rotating
log files (based on the standard library's logging module).
- Persistent state with platform independent, configurable,
(optionally rotating) state files that are compatible with many
other programs (based on h5py).
- A sensible setup for plotting with configurable defaults (based on
matplotlib).
- Many other bits and pieces that might come in handy...

As a design principle, pyexperiment's components come ready to use
without any further configuration. Inevitably then, the choices made
in this setup are opinionated and may or may not fit your personal
taste. Feel free to start a discussion on github
(https://github.com/duerrp/pyexperiment/issues).

For usage examples, check the examples folder.

Dependencies
============

The pyexperiment package has a few external dependencies:

* configobj >= 5.0.5
* numpy >= 1.8.1
* h5py >= 2.3.1

If you install the dependencies with pip, you may need to install
libhdf5 first, e.g., by running `sudo apt-get install libhdf5-dev`.

License
=======

The pyexperiment package is licensed under an MIT licence (see the
LICENSE file).