snakemake-novice-lattice

Introduction to Snakemake for Lattice Quantum Field Theory

https://github.com/edbennett/snakemake-novice-lattice

Science Score: 44.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.7%) to scientific vocabulary

Keywords

english lattice-field-theory lattice-gauge-theory lattice-qcd lesson pre-alpha snakemake
Last synced: 6 months ago · JSON representation ·

Repository

Introduction to Snakemake for Lattice Quantum Field Theory

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
english lattice-field-theory lattice-gauge-theory lattice-qcd lesson pre-alpha snakemake
Created about 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Authors

README.md

Snakemake for Lattice Quantum Field Theory

Snakemake for Lattice Quantum Field Theory

This lesson introduces the Snakemake workflow system in the context of a lattice quantum field theory data analysis task.

To quote from the official Snakemake documentation:

The Snakemake workflow management system is a tool to create reproducible and scalable data analyses. Workflows are described via a human readable, Python based language. They can be seamlessly scaled to server, cluster, grid and cloud environments, without the need to modify the workflow definition. Finally, Snakemake workflows can entail a description of required software, which will be automatically deployed to any execution environment.

Snakemake originated as, and remains most popular as, a tool for bioinformatics. However, Snakemake is a general-purpose system and may be used for all manner of data processing tasks; the examples we use here are tailored to the context of Lattice Quantum Field Theory, which in some cases has different priorities in the design of analysis workflows.

Snakemake is a superset of the Python language and as such can draw on the full power of Python, but you do not need to be a Python programmer to use it. This lesson assumes no prior knowledge of Python and introduces just a few concepts as needed to construct useful workflows.

Contributing

We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.

We'd like to ask you to familiarize yourself with our Contribution Guide and have a look at the more detailed guidelines on proper formatting, ways to render the lesson locally, and even how to write new episodes.

Please see the current list of issues for ideas for contributing to this repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter Contributing to a Project in Pro Git by Scott Chacon. Look for the tag good\_first\_issue. This indicates that the maintainers will welcome a pull request fixing this issue.

Maintainer(s)

Current maintainers of this lesson are

Authors

A list of contributors to the lesson can be found in AUTHORS

Citation

To cite this lesson, please consult with CITATION

Acknowledgement

This lesson draws on material and structure from the Introduction to Snakemake for Bioinformatics.

The development of this lesson was funded by the UKRI Science and Technology Facilities Council (STFC) Research Software Engineer Fellowship EP/V052489/1.

Owner

  • Name: Ed Bennett
  • Login: edbennett
  • Kind: user
  • Location: Swansea, UK
  • Company: Swansea Academy of Advanced Computing, Swansea University

Citation (CITATION.cff)

# This template CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to replace its contents
# with information about your lesson.
# Remember to update this file periodically, 
# ensuring that the author list and other fields remain accurate.

cff-version: 1.2.0
title: Snakemake for Lattice Quantum Field Theory
message: >-
  Please cite this lesson using the information in this file
  when you refer to it in publications, and/or if you
  re-use, adapt, or expand on the content in your own
  training material.
type: dataset
authors:
  - given-names: Ed
    family-names: Bennett
abstract: >-
  This lesson introduces the Snakemake workflow manager,
  and teaches how to use it in the context of
  data analysis for Lattice Quantum Field Theory.
license: CC-BY-4.0

GitHub Events

Total
  • Push event: 37
  • Create event: 4
Last Year
  • Push event: 37
  • Create event: 4

Dependencies

.github/workflows/pr-close-signal.yaml actions
  • actions/upload-artifact v4 composite
.github/workflows/pr-comment.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
  • carpentries/actions/download-workflow-artifact main composite
.github/workflows/pr-post-remove-branch.yaml actions
  • carpentries/actions/download-workflow-artifact main composite
  • carpentries/actions/remove-branch main composite
.github/workflows/pr-preflight.yaml actions
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/comment-diff main composite
.github/workflows/pr-receive.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • carpentries/actions/check-valid-pr main composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/sandpaper-main.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/setup-lesson-deps main composite
  • carpentries/actions/setup-sandpaper main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-cache.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-lockfile main composite
  • carpentries/create-pull-request main composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/update-workflows.yaml actions
  • actions/checkout v4 composite
  • carpentries/actions/check-valid-credentials main composite
  • carpentries/actions/update-workflows main composite
  • carpentries/create-pull-request main composite