Simphony-Aviz

A visualisation wrapper for the SimPhoNy-framework (http://www.simphony-project.eu/) to provide visualisation support of the CUDS high-level components.

Build status Coverage status Documentation Status

Repository

Simphony-aviz is hosted at: https://github.com/simphony/simphony-aviz

Requirements

Optional Requirements

For testing of simphony-aviz, the following is required: - Pillow

To support the documentation built you need the following packages:

  • sphinx >= 1.3.1
  • mock

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:

python -m unittest discover

Documentation

To build the documentation:

python setup.py build_sphinx

Usage

After installation the user should be able to import and use the aviz visualisation plugin module for visualizing with AViz:

from simphony.visualisation import aviz
    aviz.show(my_particles)

or to create snapshot with AViz:

from simphony.visualisation import aviz
    aviz.snapshot(my_particles, "snapshot.png")

API Reference

Indices and tables