https://github.com/arm61/sim_vs_trad

ESI for "Assessing molecular simulation for the analysis of lipid monolayer reflectometry"

https://github.com/arm61/sim_vs_trad

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 16 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org, aps.org, zenodo.org
  • Committers with academic emails
    2 of 2 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

ESI for "Assessing molecular simulation for the analysis of lipid monolayer reflectometry"

Basic Info
  • Host: GitHub
  • Owner: arm61
  • License: cc-by-sa-4.0
  • Language: Jupyter Notebook
  • Default Branch: master
  • Homepage:
  • Size: 248 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 4
Created over 7 years ago · Last pushed over 6 years ago
Metadata Files
Readme License Authors

README.md

ESI for "Assessing molecular simulation for the analysis of lipid monolayer reflectometry"

J. Phys. Comm. DOI arXiv License

Andrew R. McCluskey*, James Grant, Andrew J. Smith, Jonathan L. Rawle, David J. Barlow, M. Jayne Lawrence, Stephen C. Parker, Karen J. Edler*.

*a.r.mccluskey@bath.ac.uk/andrew.mccluskey@diamond.ac.uk & k.edler@bath.ac.uk

Comparing different molecular dynamics potential models to improve reflectometry analysis.

This is the electronic supplementary information (ESI) associated with the publication "Assessing molecular simulation for the analysis of lipid monolayer reflectometry". 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. The Supplementary Information document can be found in the reports folder, alongside a preprint copy of the publication. For more information about reproducible workflows in Python, check out Tania Allard's talk from Pycon2018.

Data

The reduced neutron reflectometry data and simulation inputs and trajectories can be obtained from the University of Bath Research Data Archive.

DOI: 10.15125/BATH-00586

Analysis

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

Requirements:

  • anaconda or miniconda python
  • REVTeX

The supplied Snakemake file, will reproduce all of the analysis, plot the figures, and build a preprint version of the paper (reports/preprint.pdf) when run. Be aware that the analyses within this work are non-trivial and take many hours to run so use caution before re-running.

If you still want to re-run all of the analysis, please download the experimental data zip file, and unzip it (in the sim_vs_trad directory) using the following command:

unzip sim_vs_trad_data.zip

Then run the following commands:

``` conda env create -f config/environment.yml

source activate simvstrad

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.

Citations

Paper: A. R. McCluskey, J. Grant, A. J. Smith, J. L. Rawle, D. J. Barlow, M. J. Lawrence, S. C. Parker and K. J. Edler, J. Phys. Comm., 2019, 3(7), 075001.

ESI: A. R. McCluskey, J. Grant, A. J. Smith, J. L. Rawle, D. J. Barlow, M. J. Lawrence, S. C. Parker and K. J. Edler, simvstrad (Version 1.0), http://doi.org/10.5281/zenodo.3254719.

Data: A. R. McCluskey, J. Grant, A. J. Smith, J. L. Rawle, D. J. Barlow, M. J. Lawrence, S. C. Parker and K. J. Edler, Dataset for ‘Assessing molecular simulation for the analysis of lipid monolayer reflectometry’, https://doi.org/10.15125/BATH-00586.

BibTeX

``` @article{simvstrad_paper, title={Assessing molecular simulation for the analysis of lipid monolayer reflectometry}, volume={3}, DOI={10.1088/2399-6528/ab12a9}, number={7}, journal={Phys. Chem. Chem. Phys.}, author={McCluskey, A. R. and Grant, J. and Smith, A. J. and Rawle, J. L. and Barlow, D. J. and Lawrence, M. J. and Parker, S. C. and Edler, K. J.}, year={2019}, pages={075001} }

@misc{simvstradesi, title={simvs_trad (Version 1.0)}, url={http://doi.org/10.5281/zenodo.3254719}, author={McCluskey, A. R. and Grant, J. and Smith, A. J. and Rawle, J. L. and Barlow, D. J. and Lawrence, M. J. and Parker, S. C. and Edler, K. J.}, year={2019} }

@misc{simvstrad_data, title={Dataset for “Assessing molecular simulation for the analysis of lipid monolayer reflectometry”}, url={https://doi.org/10.15125/BATH-00586}, author={McCluskey, A. R. and Grant, J. and Smith, A. J. and Rawle, J. L. and Barlow, D. J. and Lawrence, M. J. and Parker, S. C. and Edler, K. J.}, year={2019} } ```

Acknowledgements

A. R. M. is grateful to the University of Bath and Diamond Light Source for co-funding a studentship (Studentship Number STU0149).

Project Organization

.
├── AUTHORS.md
├── LICENSE         # CC BY-SA-4.0
├── README.md       # You are here
├── Snakefile       # Makefile to outline workflow
├── output          # Files and data output by analysis scripts
│   ├── simulation
│   └── traditional
├── config          # requirements.txt file
├── reports         # Paper and ESI
│   └── figures
└── scripts       # Python scripts for analysis
    ├── simulation
    └── traditional

Owner

  • Name: Andrew McCluskey
  • Login: arm61
  • Kind: user
  • Location: Copenhagen
  • Company: European Spallation Source

instrument data scientist @essneutron (he/him)

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 91
  • Total Committers: 2
  • Avg Commits per committer: 45.5
  • Development Distribution Score (DDS): 0.231
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
arm61 a****1@b****k 70
Andrew McCluskey a****y@b****k 21
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 1
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 4 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • arm61 (1)
Pull Request Authors
  • arm61 (1)
Top Labels
Issue Labels
Pull Request Labels