tclose
commented
6 years ago Merging this PR as it doesn't change any content of the specification only the format
Closed tclose closed 6 years ago
tclose
commented
6 years ago Merging this PR as it doesn't change any content of the specification only the format
This PR converts the specification document from LaTeX into reStructured Text so it can built as HTML & PDF on readthedocs and to make subsequent changes to the spec easy to read within the GitHub PR dialog.
You can check out the built docs at http://nineml-spec.readthedocs.io/en/restructured_text/.
The only substantive (i.e. non formatting/section order) changes to the spec are:
the removal of random distributions that are not implemented in GSL (see #106)
the renaming of
RandomValuetoRandomDistributionValue, as I am pretty sure that this was my mistake (left over from an early version of the spec) and the name that was agreed upon in the committee meeting in Antwerp wasRandomDistributionValue. However, I can revert this change if you think it is not worth it at this point (I have proposed that this element be replaced with something more general in v2.0, see #63)I have named the version/release of the spec as 1.0.1 but could change this to 1.1 if you feel that is more appropriate. If we do move to 1.1 one thing I would like to add is a section on serialisation to different hierarchical formats (e.g. JSON, YAML, HDF5, etc...), which are supported by my latest PR to the NineML Python library. Although there may need to be a bit of discussion around the best ways of doing this (see my PR for details).
Please reply with any suggestions/improvements or just '+1' if you are happy with everything above.