Skip to content

Commit 0eaef1a

Browse files
authored
Update README with workshop and usage information
Added workshop details, usage instructions, and author information.
1 parent 6d84695 commit 0eaef1a

1 file changed

Lines changed: 34 additions & 2 deletions

File tree

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,41 @@
1-
Though Python is a very popular and powerful environment for Biomolecular Simulation,
2-
many important and well-established tools require working from the command line in a terminal window. So it's an advantage to be familiar and comfortable with both ways of working.
1+
# CCPBioSim Protein Simulation Workshop
2+
3+
[![ci](https://github.com/ccpbiosim/protein-simulation-workshop/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/ccpbiosim/protein-simulation-workshop/actions/workflows/build.yaml)
4+
[![latest](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fccpbiosim.github.io%2Fworkshop.json&query=%24.containers.protein-simulation-workshop.latest&labelColor=grey&logo=github&logoColor=white&label=latest&color=purple)](https://github.com/ccpbiosim/protein-simulation-workshop/pkgs/container/protein-simulation-workshop)
5+
[![issues](https://img.shields.io/github/issues/ccpbiosim/protein-simulation-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/protein-simulation-workshop/issues)
6+
[![pr](https://img.shields.io/github/issues-pr/ccpbiosim/protein-simulation-workshop?logo=github&labelColor=grey)](https://github.com/CCPBioSim/protein-simulation-workshop/pulls)
7+
8+
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.
9+
10+
Though Python is a very popular and powerful environment for Biomolecular Simulation, many important and well-established tools require working from the command line in a terminal window. So it's an advantage to be familiar and comfortable with both ways of working.
311

412
This workshop demonstrates two approaches to running MD simulations on a simple protein system:
513

614
1. From the command line in a terminal window, using AMBER
715
2. In Python, via a Jupter Notebook, using OpenMM
816

917
The focus is on the preliminary simulations that are required to relax and equiliobrate an initially-built system, so that later "production" simulations have the best chance of being stable and reliable.
18+
19+
20+
## How to Use
21+
22+
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.
23+
24+
Pull the container from our repository::
25+
26+
docker pull ghcr.io/ccpbiosim/protein-simulation-workshop:latest
27+
28+
In our containers we are using the JupyterHub default port 8888, so you should
29+
forward this port when deploying locally::
30+
31+
docker run -p 8888:8888 ghcr.io/ccpbiosim/protein-simulation-workshop:latest
32+
33+
## Authors
34+
35+
Workshop Content Authors:
36+
37+
- Charlie Laughton
38+
39+
## Contact
40+
41+
Please direct all questions and feedback to [Charlie Laughton](mailto:charles.laughton@nottingham.ac.uk)

0 commit comments

Comments
 (0)