Skip to content

Document the commands, file formats, and interactions #11

@GoogleCodeExporter

Description

@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 [email protected] on 22 Feb 2012 at 9:57

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions