search

peastman / MolecularFileFormatSpecs

A repository of specs for file formats used in molecular modelling
8 stars 1 forks source link

Add summary of GSD format. #2

Closed bdice closed 4 years ago

bdice commented 4 years ago

I have added some information describing the GSD format used by HOOMD-blue.

Since there isn't a real "table" to fill out yet, I wrote a summary of the format including links to the GSD documentation. I emphasized uncommon features that might be different in GSD than other formats, since that is likely to be useful in the creation of a larger comparison between formats.

@joaander if you have any input, I have given you write access to my fork. You can update the branch gsd-summary directly.

peastman commented 4 years ago

Looks good to me. Do you want to include a copy of the files from https://gsd.readthedocs.io/en/stable/specification.html here?

bdice commented 4 years ago

@peastman I considered that, but I would rather link to the source than maintain two copies. If a comparison table or “unified” description of several file formats is created, I’m happy to update this content and adjust the level of detail or copy descriptions over as needed.

peastman commented 4 years ago

Ok, that makes sense. Though it does raise the question of what this repository is intended to be: a collection of specs, or a collection of links to specs? Anyway, I'll go ahead and merge this.