Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.38 KB

README.rst

File metadata and controls

57 lines (36 loc) · 1.38 KB

Simphony-common

The native implementation of the SimPhoNy cuds objects and io code.

https://travis-ci.org/simphony/simphony-common.svg?branch=master

Repository

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

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

If your system has multiple python versions installed, you may need to call the desired version explicitly, for instance

python2.7 setup.py install

If you do not have write permission outside your home directory you may want to install to a particular directory using

python setup.py develop --install-dir mydirectory

where mydirectory is a directory in which you have write permission. Doing this will in turn require setting the PYTHONPATH environment variable to include mydirectory.

Testing

To run the full test-suite run:

python -m unittest discover

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
  • bench -- holds basic benchmarking code