diff --git a/README.md b/README.md index c91f3d6..43a6ae7 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,35 @@ # CCPBioSim PCA Workshop -[![build](https://github.com/ccpbiosim/pca-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/pca-workshop/actions/workflows/build.yaml) +[![ci](https://github.com/ccpbiosim/pca-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/pca-workshop/actions/workflows/build.yaml) +[![latest](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fccpbiosim.github.io%2Fworkshop.json&query=%24.containers.pca-workshop.latest&labelColor=grey&logo=github&logoColor=white&label=latest&color=purple)](https://github.com/ccpbiosim/pca-workshop/pkgs/container/pca-workshop) +[![issues](https://img.shields.io/github/issues/ccpbiosim/pca-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/pca-workshop/issues) +[![pr](https://img.shields.io/github/issues-pr/ccpbiosim/pca-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/pca-workshop/pulls) + +This workshop source repository contains the build recipe for a docker container derived from the CCPBioSim JupyterHub image. This container adds the necessary software packages and notebook content to form a deployable course container. The aim of the workshop is to illustrate methods we can use to assess convergence and sampling in MD trajectories. You will compare and contrast the most basic and widely-used method to do this - RMSD analysis - with the use of more sophisticated approaches based on Principal Component Analysis (PCA). You will apply the approaches to two common scenarios: firstly the comparison of the dynamics of a protein the presence and absence of a bound ligand, and secondly the evaluation of sampling and convergence in an ensemble of independent, replicate, MD trajectories of a protein. -## Docker +## How to Use + +This training course is deployed on the [CCPBioSim](www.ccpbiosim.ac.uk) website via our cloud infrastructure, however you can deploy on your own machine with docker. -This container is derived from the CCPBioSim JupyterHub image. This container -adds the necessary software packages and notebook content to form a deployable -course container. The source content for this course can be found at -https://github.com/CCPBioSim/pca-workshop +Pull the container from our repository:: -## How to Use + docker pull ghcr.io/ccpbiosim/pca-workshop:latest In our containers we are using the JupyterHub default port 8888, so you should forward this port when deploying locally:: docker run -p 8888:8888 ghcr.io/ccpbiosim/pca-workshop:latest +## Authors + +Workshop Content Authors: + +- Charlie Laughton + ## Contact -Please direct all comments and enquiries to [Charlie Laughton](mailto:charles.laughton@nottingham.ac.uk) +Please direct all questions and feedback to [Charlie Laughton](mailto:charles.laughton@nottingham.ac.uk)