<commit_before>Simphony-Mayavi
===============

A plugin-library for the Simphony framework (http://www.simphony-project.eu/) to provide
visualization support of the CUDS highlevel components.

.. image:: https://travis-ci.org/simphony/simphony-mayavi.svg?branch=master
  :target: https://travis-ci.org/simphony/simphony-mayavi
  :alt: Build status

.. image:: http://codecov.io/github/simphony/simphony-mayavi/coverage.svg?branch=master
  :target: http://codecov.io/github/simphony/simphony-mayavi?branch=master
  :alt: Test coverage

.. image:: https://readthedocs.org/projects/simphony-mayavi/badge/?version=latest
  :target: https://readthedocs.org/projects/simphony-mayavi/?badge=latest
  :alt: Documentation Status

Repository
----------

Simphony-mayavi is hosted on github: https://github.com/simphony/simphony-mayavi

Requirements
------------

- mayavi[app] >= 4.4.0
- simphony[H5IO] >= 0.3.0

Optional requirements
~~~~~~~~~~~~~~~~~~~~~

To support the documentation built you need the following packages:

- sphinx >= 1.2.3
- sectiondoc commit 8a0c2be, https://github.com/enthought/sectiondoc
- trait-documenter, https://github.com/enthought/trait-documenter
- mock

Alternative running :command:`pip install -r doc_requirements` should install the
minimum necessary components for the documentation built.

Installation
------------

The package requires python 2.7.x, installation is based on setuptools::

  # build and install
  python setup.py install

or::

  # build for in-place development
  python setup.py develop

Testing
-------

To run the full test-suite run::

  python -m unittest discover

Documentation
-------------

To build the documentation in the doc/build directory run::

  python setup.py build_sphinx

.. note::
<commit_msg>mention requirements for testing in README<commit_after>Simphony-Mayavi
===============

A plugin-library for the Simphony framework (http://www.simphony-project.eu/) to provide
visualization support of the CUDS highlevel components.

.. image:: https://travis-ci.org/simphony/simphony-mayavi.svg?branch=master
  :target: https://travis-ci.org/simphony/simphony-mayavi
  :alt: Build status

.. image:: http://codecov.io/github/simphony/simphony-mayavi/coverage.svg?branch=master
  :target: http://codecov.io/github/simphony/simphony-mayavi?branch=master
  :alt: Test coverage

.. image:: https://readthedocs.org/projects/simphony-mayavi/badge/?version=latest
  :target: https://readthedocs.org/projects/simphony-mayavi/?badge=latest
  :alt: Documentation Status

Repository
----------

Simphony-mayavi is hosted on github: https://github.com/simphony/simphony-mayavi

Requirements
------------

- mayavi[app] >= 4.4.0
- simphony[H5IO] >= 0.3.0

Optional requirements
~~~~~~~~~~~~~~~~~~~~~

To support testing, you will need the following packages:

- PIL
- nose
- mock

Alternatively unning :command:`pip install -r dev-requirements.txt` should install the
packages needed for development purposes.


To support the documentation built you need the following packages:

- sphinx >= 1.2.3
- sectiondoc commit 8a0c2be, https://github.com/enthought/sectiondoc
- trait-documenter, https://github.com/enthought/trait-documenter

Alternative running :command:`pip install -r doc_requirements.txt` should install the
minimum necessary components for the documentation built.

Installation
------------

The package requires python 2.7.x, installation is based on setuptools::

  # build and install
  python setup.py install

or::

  # build for in-place development
  python setup.py develop

Testing
-------

To run the full test-suite run::

  python -m unittest discover

Documentation
-------------

To build the documentation in the doc/build directory run::

  python setup.py build_sphinx

.. note::

{'fraction_non_alphanumeric': 0.14634794156706507, 'fraction_numerical': 0.00796812749003984, 'mean_word_length': 3.8530927835051547, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1936295', 'n_tokens_mistral': 1164, 'n_tokens_neox': 1121, 'n_words': 304}