Adding experimental data

Experimental data is stored in BilayerData/experiments folder. C-H bond order parameters from NMR are in OrderParameters subfolder and X-ray scattering form factors in FormFactors subfolder. The keys of these dictionaries are summarized in the Experiment metadata description.

Steps to add experimental data

  1. Create and fill the README.yaml file of your data.

  2. Copy this README file data into a appropriate directory named as described above.

  3. If you have order parameter data, create a file named {lipidname}_Order_Parameters.dat where {lipidname} is the universal name of the lipid from which the data is measured from. The first two columns of this file should define the atom pair with universal atom names, third column has the experimental order parameter value, and fourth column has the experimental error. If the experimental error is not known, set it to 0.02. Store the created {lipidname}_Order_Parameters.dat file into the appropriate folder with the README.yaml file. Create json version from dat file by running

    python data_to_json.py path-to-dat.dat
    

    in folder experiments/OrderParameters. You can see previously added experiments for examples.

  4. If you have X-ray scattering form factor data, store the form factor into appropriate folders in ASCII format where first column in x-axis values (Å-1), second column is y-axis value, and third is the error. Then create json file by runnig

    python data_to_json.py ascii-file.txt
    

    in folder [experiments/FormFactors](https://github.com/NMRLipids/BilayerData/tree/main/experiments/FormFactors). Please see previously added experiments for examples.

  5. Adding experiments can lead to recalculation of quality of some simulations and rankings. So, after the addition, please run

    nml_match_experiments
    nml_evaluate_quality
    nml_make_ranking
    
  6. Submit the files to your branch and make a pull-request.