Skip to content

Latest commit

 

History

History
126 lines (69 loc) · 3.59 KB

README.rst

File metadata and controls

126 lines (69 loc) · 3.59 KB
Raw

Eskapade-Core

  • Version: 1.0.0
  • Released: Jan 2018

Eskapade is a light-weight, python-based data analysis framework, meant for modularizing all sorts of data analysis problems into reusable analysis components.

For the full documentation on Eskapade, including many examples, please go to this link.

The core functionality of Eskapade, namely: the Link, Chain, process_manager, DataStore, ConfigObject and corresponding tutorials, has now been split off from the growing Eskapade repository, into this new package Eskapade-Core.

For the minimal documentation on Eskapade-Core, please go here.

Release notes

Version 1.0.0

In Eskapade-Core v1.0.0:

  • Eskapade goes parallel. The execution of chains can be forked, so chains can run in parallel! See tutorial esk112 for details.
  • The eskapade_bootstrap method has been severely upgraded. Running this command will generate you a new (Eskapade) project directory with a working link, macro, tests, entry-point scripts, and setup.py file!
  • escore.eskapade_run() has been made more user-friendly for standalone use with python or jupyter.
  • added __main__ function to every newly generated macro, so macros can now be run standalone. In addition, eskapade_generate_macro now makes a python function in the macro.
  • The Eskapade DbConnection base class has been migraged to core.
  • The DataStore now has a fancy get() function that can assert the type, length, and presence of object.
  • Added a new link ApplyFunc that applies function to objects in the datastore. Simple but very useful.
  • Plus several small updates to existing links in core_ops: skip_chain_if_empty, import_data_store, BreakLink.

Version 0.9

Version 0.9 of Eskapade-Core (December 2018) is a split off of the core and core_ops modules of Eskapade v0.9 into a separate package. Eskapade v0.9 builds on top of Eskapade-Core, and focussed on analysis modules.

Installation

requirements

Eskapade-Core works standalone and is a very light-weight Python3 package, and requires Python 3.6+.

pypi

To install the package from pypi, do:

$ pip install Eskapade-Core

github

Alternatively, you can check out the repository from github and install it yourself:

$ git clone https://github.com/KaveIO/Eskapade-Core.git eskapade-core

To (re)install the python code from your local directory, type from the top directory:

$ pip install -e eskapade-core

python

After installation, you can now do in Python:

import escore

Congratulations, you are now ready to use Eskapade!

Quick run

To see the available examples in Eskapade-Core, do:

$ export TUTDIRC=`pip show Eskapade-Core | grep Location | awk '{ print $2"/escore/tutorials" }'`
$ ls -l $TUTDIRC/

E.g. you can now run:

$ eskapade_run $TUTDIRC/esk101_helloworld.py

This documentation here is minimal on purpose. For all examples on using Eskapade links, chains and the DataStore to set up an analysis work flow, please see the Eskapade tutorials section.

For more examples, see the full Eskapade documentation.

Contact and support

Contact us at: kave [at] kpmg [dot] com

Please note that the KPMG Eskapade group provides support only on a best-effort basis.