Changes between Initial Version and Version 1 of ExportFormat

Jun 24, 2010, 5:47:43 PM (10 years ago)



  • ExportFormat

    v1 v1  
     2Our export format doesn't have rigorous documentation or an XSD.
     3In lieu of that, you can get a long way by
     4studying the output of an export. It's pretty straightforward. Some of
     5the subtle points are explained below.
     7== The Export Comment ==
     9Each export contains a comment. This is informational only; our applications
     10ignore it when importing.
     12== Timestamps ==
     14Timestamps are always in
     15[ combined ISO format],
     16e.g. `2010-04-30T15:14:56`. The seconds field is always present, and there's
     17never time zone information.
     19Timestamps are always in the local time of the machine that wrote them.
     20Using local time isn't ideal for files that are meant to be shared globally,
     21but time zone information in Python isn't easy to deal
     22with and we opted not to.
     24== Missing Fields ==
     26In general, our import code doesn't care if optional fields are present
     27and empty or simply not present. If it's not present, our code assigns
     28a default value.
     30For instance, a blank comment can be represented as `<comment />` or
     31simply not present at all.
     33It's not valid for mandatory fields to be missing; e.g. each metabolite
     34element must contain at least one spin element.
     36== UUIDs ==
     38An object's UUID is stored in its id attribute.
     40It's valid for objects in an export file to lack a UUID. In this case, when
     41they're imported, a new id is assigned. This makes it easier to import objects
     42from 3rd party software into Vespa -- if you can convert the 3rd party format
     43into our format, we'll import it.
     45== Experiments ==
     47Experiments export files always include the metabolites and pulse sequence
     48to which the experiment refers. In other words, each experiment contains all
     49the information you need to recreate it.
     51When metabolites are referred to in simulations, the export file doesn't
     52repeat the entire metabolite definition, only the id. It's guaranteed that
     53the id refers to a metabolite defined in the same experiment element.
     55Experiments exports don't always include the experiment results. It's up
     56to the user who does the export whether or not the results will be
     59== Compression ==
     61Export files may be compressed; the compression is compatible
     62with [ gzip]. Our applications examine the file
     63contents (not the file name) to determine whether or not a file is