Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
csbrasnett committed Sep 17, 2024
2 parents 49e49d0 + dea28bb commit bd2b1b0
Showing 1 changed file with 9 additions and 20 deletions.
29 changes: 9 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,11 @@ Thanks to [Jan Stevens](https://github.com/jan-stevens) for `vis.vmd`

If the solution here isn't working for you, please open an issue!

## Disclaimers

This code's mainly been tested on relatively simple systems.
It hasn't been tested extensively for larger/more complex systems with
big mixtures of lipids and proteins, so if you're looking at something big, it's likely there'll be an error.

If you find an error, please open an issue so it can be fixed!

## Installation

### Installation with _pip_

```commandline
python3 -m venv venv && source venv/bin/activate # Not required, but often convenient.
pip install git+https://github.com/csbrasnett/MartiniGlass
```

### From repository source

```commandline
git clone https://github.com/Martini-Force-Field-Initiative/MartiniGlass.git
cd MartiniGlass
python3 -m venv venv && source venv/bin/activate
pip install .
pip install martiniglass
```

## Usage
Expand Down Expand Up @@ -160,6 +141,14 @@ latest version of martinize2, where the Gō parameters are calculated internally
If you're using a different version of the Gō model where this file is called something
different, you can specify that with the `-gf` flag

## Disclaimers

This code's mainly been tested on relatively simple systems.
It hasn't been tested extensively for larger/more complex systems with
big mixtures of lipids and proteins, so if you're looking at something big, it's likely there'll be an error.

If you find an error, please open an issue so it can be fixed!

## FAQs

### The bonds are going everywhere
Expand Down

0 comments on commit bd2b1b0

Please sign in to comment.