{% extends "layout.html" %} {% set title = 'SphinxReport' %} {% block body %}

logo

Welcome

SphinxReport is a report generator that is implemented as an extension to Sphinx.

Its purpose is to facilitate writing scientific reports interpreting large and changing datasets. It is designed to assist the iterative analysis during the development of a computational scientific pipeline as understanding of the data grows. Once the pipeline settles down, SphinxReport permits an easy transition towards the automatic report generation needed when the pipeline is run on new data sets.

SphinxReport is easy to use and powerful enough to give all the flexibility needed during the development of computational pipelines and robustness during the production use of a pipeline. It is intended for developers and computational scientists with python scripting experience.

SphinxReport comes with all the batteries included thanks to python and Sphinx, in particular, it

How to get Sphinx

To install sphinx, simply type:

pip install SphinxReport

Sphinx source code is available on github. The latest release can be found on pypi.

Documentation

Examples

RNA-Seq report - a report generated from the CGAT RNA-Seq analysis pipeline using the data from Yang et. al. 2011.

Get SphinxReport

SphinxReport is available as an easy-installable package on the Python Package Index.

The code can be found at Google Code, at http://code.google.com/p/sphinx-report/.

{% endblock %}