Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #15

Open
wants to merge 4 commits into
base: Shocker
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions .github/workflows/python-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,14 @@ jobs:
pip install -r requirements-tests.txt

- name: Run pytest with codecoverage
run: |
coverage run --source=shocker $(which pytest) -vv shocker
coverage report --omit='*/bin/pytest'
codecov
run: pytest --cov polyply --cov-report=xml
- name: Upload coverage codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./coverage.xml
fail_ci_if_error: true
verbose: true

lint:
runs-on: ubuntu-latest
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Shocker
[![codecov](https://codecov.io/gh/marrink-lab/shocker/branch/Shocker/graph/badge.svg)](https://codecov.io/gh/marrink-lab/shocker)
[![Build Status](https://github.com/marrink-lab/shocker/actions/workflows/python-ci.yml/badge.svg)](https://github.com/marrink-lab/shocker/actions)
[![BioRxiv:10.1101/2023.08.16.553535](http://img.shields.io/badge/BioRxiv-10.1101/2023.08.16.553535-ad353a.svg)](https://doi.org/10.1101/2023.08.16.553535)
[![JCTC:10.1021/acs.jctc.3c00961](http://img.shields.io/badge/JCTC-10.1021/acs.jctc.3c00961-007b42.svg)](https://doi.org/10.1021/acs.jctc.3c00961)
![license](https://img.shields.io/github/license/marrink-lab/shocker)

Shocker is a python package for simulating the effects of water efflux (influx) during a hypertonic (hypotonic) osmotic shock by relocating water particles from the inner to the outer compartment (or vice versa). The algortihm can be applied to any structure containing an enclosed compartment of solvent such as a vesicle, tube or double bilayer system. The tool works with the md code GROMACS and can be applied to both AA systems and CG systems. Shocker is applicable to membranes containing proteins and other molecules such as polymers and DNA. Shocker divides the simulation in pumping cycles, defined as relocation of a number of water particles followed by relaxation time.

# Instructions
Expand Down
Loading