Document the commands, file formats, and interactions

[GoogleCodeExporter]

We should start writing some documentation about the commands provided
by the VM-MAD package, their interaction (e.g., run `distil.py` before
`simul.py`) and the file formats.

So, please add to the existing docs:

1. A section on the commands: for every command briefly explain the
   intended purpose and give usage notes.  Link to the "file formats"
   section when referencing the input and output files.

   Could possibly be enriched with a couple of examples and nice
   graphs, but that's optional and not really needed :-)

2. A section on file formats: we basically use CSV everywhere so
   there's not much to do here, except stating what columns are in
   each CSV file, and what's their meaning.

Original issue reported on code.google.com by riccardo.murri@gmail.com on 22 Feb 2012 at 9:57

• Blocked on: #10

[GoogleCodeExporter]

I've just started working on this issue. Some difficulties in working with 
Sphinx 
(still to get used to it). I have a problem in visualizing the:
http://vm-mad.googlecode.com/svn/trunk/doc/_build/html/commands.html page as I 
can see only plain HTML source code. Locally I can see it normally. 

Original comment by tyanko.a...@gmail.com on 29 Apr 2012 at 6:19

• Changed state: Started

[GoogleCodeExporter]

| I have a problem in visualizing the:
| http://vm-mad.googlecode.com/svn/trunk/doc/_build/html/commands.html page as
| I can see only plain HTML source code.

This is due to a missing "mime type" metadata on the HTML file.

You need to set the MIME type "text/html" using the subversion
"propset" command:

  svn propset svn:mime-type "text/html" trunk/_build/html/commands.html

You need to do this for any file that is not plain text (e.g.,
JavaScript files should have the "application/x-javascript" MIME type.  You can
use multiple file names on the command line, provided they all have
the same MIME type.

For more information:

https://weblion.psu.edu/trac/weblion/wiki/SubversionTricks

Original comment by riccardo.murri@gmail.com on 30 Apr 2012 at 4:23

[GoogleCodeExporter]

The problem was fixed as explained by Riccardo. 
Created a detailed draft on the simulation part. 
What should the orchestrator part include? 

Original comment by tyanko.a...@gmail.com on 4 May 2012 at 10:48