Merge pull request #4 from simphony/readme-coverage

modified readme and added coverage

.coveragerc

@@ -0,0 +1,21 @@
+[run]
+branch = True
+source = jyulb
+omit = */tests/*
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    if __name__ == .__main__.:
+
+ignore_errors = True

.travis.yml

@@ -1,8 +1,15 @@
 language: python
 
 install:
-  - pip install -r requirements.txt
+  - pip install -r dev_requirements.txt
   - ./install_external.sh
+  - pip install coveralls
   - python setup.py develop
 
-script: python -m unittest discover
+script:
+  - flake8 .
+  - coverage run -m unittest discover
+  - coverage report
+
+after_success:
+  - coveralls

README.rst

@@ -0,0 +1,65 @@
+simphony-jyulb
+==============
+
+The JYU-LB engine-wrapper for the SimPhoNy framework.
+
+.. image:: https://travis-ci.org/simphony/simphony-jyulb.svg?branch=master
+    :target: https://travis-ci.org/simphony/simphony-jyulb
+      :alt: Build status
+
+.. image:: https://coveralls.io/repos/simphony/simphony-jyulb/badge.svg
+   :target: https://coveralls.io/r/simphony/simphony-jyulb
+      :alt: Test coverage
+
+Repository
+----------
+
+simphony-jyulb is hosted on github: https://github.com/simphony/simphony-jyulb
+
+Requirements
+------------
+ - `simphony-common`_ >= 0.0.1 
+
+.. _simphony-common: https://github.com/simphony/simphony-common
+
+.. note::
+  simphony-jyulb uses keywords (COLLISION_OPERATOR, REFERENCE_DENSITY, GRAVITY,
+  FLOW_TYPE, EXTERNAL_FORCING) which currently do not belong to the CUBA-keywords.
+
+  simphony-jyulb treats the BC data component as a dummy variable (currently there
+  is no SimPhoNy definition for BC).  
+
+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
+
+JYU-LB installation
+~~~~~~~~~~~~~~~~~~~
+
+This engine-wrapper uses JYU-LB fluid flow simulator.
+
+The JYU-LB source code is available on github: https://github.com/simphony/JYU-LB
+
+The engine wrapper assumes that there is an executable called "jyu_lb_isothermal3D.exe"
+that can be found in the PATH and an exception is thrown if this is not the case.  
+
+Testing
+-------
+
+To run the full test-suite run::
+
+    python -m unittest discover
+
+Directory structure
+-------------------
+
+- jyulb -- to hold the wrapper implementation

requirements.txt → dev_requirements.txt

@@ -1,3 +1,4 @@
 numpy==1.9.1
 -e git+https://github.com/simphony/simphony-common.git#egg=simphony
-
+coverage
+flake8