Skip to main content Cube library

Project description


Open Source Python implementation of the API for working with CrunchCubes


This package contains the implementation of the CrunchCube API. It is used to extract useful information from CrunchCube responses (we'll refer to them as cubes in the subsequent text). Cubes are obtained from the platform, as JSON responses to the specific queries created by the user. These queries specify which data the user wants to extract from the system. The most common usage is to obtain the following:

  • Cross correlation between different variable
  • Margins of the cross tab cube
  • Proportions of the cross tab cube (e.g. proportions of each single element to the entire sample size)
  • Percentages

When the data is obtained from the platform, it needs to be interpreted to the form that's convenient for a user. The actual shape of the cube JSON contains many internal details, which are not of essence to the end-user (but are still necessary for proper cube functionality).

The job of this library is to provide a convenient API that handles those intricacies, and enables the user to quickly and easily obtain (extract) the relevant data from the cube. Such data is best represented in a table-like format. For this reason, the most of the API functions return some form of the ndarray type, from the numpy package. Each function is explained in greater detail, uner its own section, under the API subsection of this document.


The cr.cube package can be installed by using the pip install:

pip install cr.cube

For developers

For development mode, cr.cube needs to be installed from the local checkout of the crunch-cube repository. It is strongly advised to use virtualenv. Assuming you've created and activated a virtual environment venv, navigate to the top-level folder of the repo, on the local file system, and run:

pip install -e .


python develop

Running tests

To setup and run tests, you will need to install cr.cube as well as testing dependencies. To do this, from the root directory, simply run:

pip install -e .[testing]

And then tests can be run using py.test in the root directory:



After the cr.cube package has been successfully installed, the usage is as simple as:

from cr.cube.crunch_cube import CrunchCube

### Obtain the crunch cube JSON from the
### And store it in the 'cube_JSON_response' variable

cube = CrunchCube(cube_JSON_response)

### Outputs:
# np.array([
#     [5, 2],
#     [5, 3]
# ])



Tabular, or matrix, representation of the cube. The detailed description can be found here.


Calculates margins of the cube. The detailed description can be found here.


Calculates proportions of single variable elements to the whole sample size. The detailed description can be found here.


Calculates percentages of single variable elements to the whole sample size. The detailed description can be found here.

Build Status Coverage Status Documentation Status



  • Fix index_table for MR (single element) x CAT


  • fix second "broadcast error" bug (different cause)
  • refactor to extract _Measures object and related
  • other general factoring improvements in cr.cube.crunch_cube


  • fix "broadcast error" bug
  • improve test coverage
  • relocate test fixtures and add cached fixture lazy-loading

For a complete list of changes see history.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cr.cube-1.8.4-py2-none-any.whl (66.9 kB) Copy SHA256 hash SHA256 Wheel py2
cr.cube-1.8.4.tar.gz (844.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page