edbennett / lattice_workflow_survey

Analysis of a survey of reproducibility and open science in lattice field theory
Other
0 stars 0 forks source link

Survey on Reproducible Workflows and Open Science in Lattice Field Theory

DOI

This repository contains the results of a survey on software workflows and open science in lattice field theory conducted in 2022 by Andreas Athenodorou, Ed Bennett, Julian Lenz, and Elli Papadopolou. These data were collected using LimeSurvey, and were first presented in a talk at Lattice 2022 by Andreas Athenodorou.

The analysis is based on Julian Lenz's LimeSurvey CSV parser.

Data

The data are included in survey-results-redacted.csv, with ; delimiting fields, and %%% separating question codes from question texts in column headings.

The survey structure is included as survey-structure.lss. This gives more detail on the options presented for each question. This was generated using LimeSurvey version 5.3.18+220530, and can be reimported into any version of LimeSurvey compatible with files generated by that version.

Setup

# Install dependencies
pipenv install

Usage

With the dependencies installed, it should be sufficient to run

make

This will run the analysis.ipynb Jupyter notebook and generate the plots used in Andreas Athenodorou's talk at Lattice 2022. Alternatively, you can open the notebook directly and interrogate it in more detail.

If you have an updated raw data file, and place it in survey-results.csv (or otherwise specify its location in the Makefile), then this will additionally strip personally-identifiable information from it to update the file survey-results-redacted.csv prior to running the notebook.

Credits

This package was created with Cookiecutter and the sourcery-ai/python-best-practices-cookiecutter project template.

The analysis makes use of a list of common English words provided by Josh Kaufman, which is included for convenience as supporting_data/most_common_words.txt.