Skip to content
ESI for "An introduction to classical molecular dynamics simulation for experimental scattering users"
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
reports
scripts
.gitignore
.zenodo.json
LICENSE
README.md
Snakefile
requirements.txt

README.md

ESI for "An introduction to classical molecular dynamics simulation for experimental scattering users"

DOI arXiv License

Andrew R. McCluskey*, James Grant, Adam R.Symington, Tim Snow, James Doutch, Benjamin J. Morgan*, Stephen C. Parker, Karen J. Edler.

*a.r.mccluskey@bath.ac.uk/andrew.mccluskey@diamond.ac.uk & b.j.morgan@bath.ac.uk

An open educational resource to engage users of scattering techniques in classical simulation.

This is the electronic supplementary information (ESI) associated with the publication "An introduction to classical molecular dynamics simulation for experimental scattering users". This ESI provides full details of the analyses performed in the work and access to an automated analysis workflow, through this we aim to provide better access to analysis reproduciblility. For more information about reproducible workflows in Python, check out Tania Allard's talk from Pycon2018.

Analysis

This ESI aims to provide a fully reproducible workflow to the data analysis presented within the paper.

Requirements:

  • anaconda or miniconda python

The supplied Snakemake file, will reproduce all of the analysis, plot the figures, and build a preprint version of the paper (reports/paper.pdf) when run.

If you want to re-run the analysis, the following commands:

conda create --name paper_env python

source activate paper_env

conda install -c biopython snakemake

pip install -r requirements.txt

snakemake clean # this will remove all of the output from previous runs

snakemake

Figures

PDF versions of the figures, can be found in the reports/figures directory.

Acknowledgements

A. R. M. is grateful to the University of Bath and Diamond Light Source for co-funding a studentship (Studentship No. STU0149). B. J. M. acknowledges support from the Royal Society (Grant No. UF130329).

Project Organization

.
├── LICENSE         # CC-BY-SA-4.0
├── README.md       # You are here
├── Snakefile       # Makefile to outline workflow
├── config          # requirements.txt file
├── notebooks       # Notebook for plotting
├── reports         # Paper and ESI
    └── figures
You can’t perform that action at this time.