Download SimPhoNy Documentation

SimPhoNy Documentation, Release 0.2.1
Will make sure that the requirements of H5IO and CUBAGen support are installed. (see setuptools extras for more
information)
1.3 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
1.4 Testing
To run the full test-suite run:
python -m unittest discover -p test*
1.5 Documentation
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.
Note:
• One can use the –help option with a setup.py command to see all available options.
• The documentation will be saved in the ./build directory.
• Not all the png files of the UML diagrams are used.
1.6 Directory structure
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
2
Chapter 1. Simphony-common