Skip to content

contributing

Oliver Beckstein edited this page Oct 31, 2017 · 6 revisions

We are looking for new data sets. Please read the following and consider contributing data.

Types of systems

The ideal set of files would be something like the Gromacs dataset for alchemtest: benzene in water for 1.. 10 ns per window, with dH/dlambda saved every 10 ps. For Gromacs we tend to put each lambda in a separate directory (see https://github.com/alchemistry/alchemtest/tree/master/src/alchemtest/gmx/benzene ) but you should provide files that are typical of how Amber is run.

Documentation

Add

  • a brief explanation of how you would analyze the data with alchemical-analysis (command line so that we can reproduce) and
  • the value(s) that you get so that we know the ground truth.

Comments on what to look out for in the output files (knowing what is what in the files helps). If you have links to where the format is defined, please let us know.

Licensing

Finally, because we want to make the data part of the actual tests that are run every time when new code is committed to the repository, we would need the data to be made available under an open license (preferrable CC0 (public domain) or CC-BY (attribution required)). The dataset will carry the license and your authorship.

For example, the gmx dataset is public domain via CC0.

Clone this wiki locally