A python wrapper around the gromacs tools.
Project description
A primitive wrapper around the Gromacs tools until we have proper python bindings. It also provides a small library (cook book) of often-used recipes and an optional analysis module with plugins for more complicated analysis tasks.
Documentation is mostly provided through the python doc strings and available at http://gromacswrapper.readthedocs.org for recent releases.
The source code is available in the GromacsWrapper git repository.
Please be aware that this is alpha software that most definitely contains bugs. It is your responsibility to ensure that you are running simulations with sensible parameters.
Licence
The GromacsWrapper package is made available under the terms of the GNU Public License v3 (or any higher version at your choice) except as noted below. See the file COPYING for the licensing terms for all modules.
The vmd module is made available under the LGPL v3 (see COPYING and COPYING.LESSER). numkit is provided under the “Modified BSD Licence” (as it contains some code from scipy).
The distribution contains third party software that is copyrighted by the authors but distributed under licences compatible with this package license. Where permitted and necessary, software/files were modified to integrate with GromacsWrapper.
Installation
Releases
The latest version of GromacsWrapper from PyPi and can be installed with
pip install GromacsWrapper
Development version
The develop branch in the GitHub source repository generally contains useful code but nevertheless, things can break in weird and wonderful ways. Please report issues through the Issue Tracker and mention that you used the develop branch.
To use the development code base: checkout the develop branch:
git clone https://github.com/Becksteinlab/GromacsWrapper.git cd GromacsWrapper git checkout -b develop origin/develop
and install
python setup.py install
Download and Availability
The GromacsWrapper home page is http://github.com/Becksteinlab/GromacsWrapper. The latest release of the package is being made available from https://github.com/Becksteinlab/GromacsWrapper/releases
You can also clone the GromacsWrapper git repository or fork for your own development:
git clone git://github.com/Becksteinlab/GromacsWrapper.git
Reporting Bugs and Contributing to GromacsWrapper
Please use the Issue Tracker to report bugs, installation problems, and feature requests.
Pull requests for bug fixes and enhancements are very welcome.
Building Documentation
Install Sphinx:
apt-get install python-sphinx
and compile:
cd package/doc/sphinx make html
Citing
GromacsWrapper was written by Oliver Beckstein with contributions from many other people. Please see the file AUTHORS for all the names.
If you find this package useful and use it in published work I’d be grateful if it was acknowledged in text as
“… used GromacsWrapper (Oliver Beckstein et al, http://github.com/Becksteinlab/GromacsWrapper doi: 10.5281/zenodo.17901)”
or in the Acknowledgements section.
Thank you.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file GromacsWrapper-0.5.0.tar.gz.
File metadata
- Download URL: GromacsWrapper-0.5.0.tar.gz
- Upload date:
- Size: 708.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3c2c15f43713d8935802188da96e38b81bc8150debdb3e6e7745b1b74364db2d |
|
| MD5 | 29a1b87d9e4d7067793cee4564da5568 |
|
| BLAKE2b-256 | e46b054d15e27a4ebe00534fef7e4319df3aa417aeef4d9d57ece2adede99df2 |
Provenance
File details
Details for the file GromacsWrapper-0.5.0-py2.7.egg.
File metadata
- Download URL: GromacsWrapper-0.5.0-py2.7.egg
- Upload date:
- Size: 731.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9eada7d1327659a95050c1f13d2d027ff5a005dd32f3e8981bb241c7797f71c7 |
|
| MD5 | ff5db27da252b4012abcd5829f94490f |
|
| BLAKE2b-256 | 4804c47c3b7ab4d8834c297ee4deabb5ab638884539fd46f23a581ffcebc1878 |
Provenance
File details
Details for the file GromacsWrapper-0.5.0-py2-none-any.whl.
File metadata
- Download URL: GromacsWrapper-0.5.0-py2-none-any.whl
- Upload date:
- Size: 412.3 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aa170b8158676f53b89ea5c7d0a11aab6ddb7cd555723358ddf23b6d6fb44266 |
|
| MD5 | a7ea1fbccd1b4d96b9af8d5621499051 |
|
| BLAKE2b-256 | a567dec2dd69d69700289f12592961266c1a8a90eac4c091a961360a6cd55dc0 |
