The native implementation of the SimPhoNy cuds objects and io code (http://www.simphony-project.eu/).

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

• enum34 >= 1.0.4
• stevedore >= 1.2.0
• numpy >= 1.4.1

To support the cuba-generate script the following packages need to be installed prior to installing Simphony:

• click >= 3.3
• pyyaml >= 3.11
• tabulate >= 0.7.4

To support the HDF5 based native IO:

• PyTables >= 3.1.1

To support the documentation built you need the following packages:

• sphinx >= 1.3.1
• mock

install_requires = ["simphony[H5IO, CUBAGen]"]

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

To run the full test-suite run:

python -m unittest discover -p test*

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

python setup.py build_sphinx

If you recreate the uml diagrams you need to have java and xdot installed:

sudo apt-get install default-jre xdot

A copy of the plantuml.jar needs also to be available in the doc/ folder. Running make uml inside the doc/ directory will recreate all the UML diagrams.

There are four subpackages:

• core -- used for common low level classes and utility code
• cuds -- to hold all the native cuds implementations
• io -- to hold the io specific code
• bench -- holds basic benchmarking code
• examples -- holds SimPhoNy example code
• doc -- Documentation related files
  • source -- Sphinx rst source files
  • build -- Documentation build directory, if documentation has been generated using the make script in the doc directory.

The simphony library is the core component of the SimPhoNy Framework; information on setting up the framework is provided on a separate repository https://github.com/simphony/simphony-framework.