Skip to main content

Read Gromacs EDR files.

Project description

Github Actions Build Status Coverage Status

This repository hosts the source files for both the Pyedr and Panedr packages.

pyedr and panedr are compatible with Python 3.6 and greater.

Pyedr

Pyedr provides a means of reading a Gromacs EDR binary XDR file and return its contents as a dictionary of numpy arrays. Pyedr exposes the following functions:

  • edr_to_dict: returns a dictionary of NumPy arrays keyed by the energy type from a given path to an EDR file.

  • read_edr: parses an EDR file and returns the energy terms in a nested list

  • get_unit_dictionary: Returns a dictionary that holds the units of each energy term found in the EDR file.

Panedr

Panedr uses the Pyedr library to read a Gromacs EDR binary energy XDR file and returns its contents as a pandas dataframe. Panedr exposes the following functions:

  • edr_to_df: which gets the path to an EDR file and returns a pandas DataFrame.

  • get_unit_dictionary: Returns a dictionary that holds the units of each energy term found in the EDR file.

Example

Using pyedr:

import pyedr

# Read the EDR file
path = 'ener.edr'
dic = pyedr.edr_to_dict(path)

# The `verbose` optional parameter can be set to True to display the
# progress on stderr
dic = pyedr.edr_to_dict(path, verbose=True)

# Get the average pressure after the first 10 ns
pressure_avg = dic['Pressure'][dic['Time'] > 10000].mean()

# Get the units of the EDR entries
unit_dict = pyedr.get_unit_dictionary(path)
unit_dict["Temperature"]  # returns "K"

Using panedr:

import panedr

# Read the EDR file
path = 'ener.edr'
df = panedr.edr_to_df(path)

# The `verbose` optional parameter can be set to True to display the
# progress on stderr
df = panedr.edr_to_df(path, verbose=True)

# Get the average pressure after the first 10 ns
pressure_avg = df['Pressure'][df['Time'] > 10000].mean()

# Get the units of the EDR entries
unit_dict = panedr.get_unit_dictionary(path)
unit_dict["Temperature"]  # returns "K"

Install

You can install pyedr and panedr using pip:

pip install pyedr

# installing panedr automatically installs pyedr
pip install panedr

If you are using conda and conda-forge, you can install with:

conda install -c conda-forge pyedr

# install panedr automatically installs pyedr
conda install -c conda-forge panedr

Tests

The pyedr and panedr repositories contains a series of tests. If you downloaded or cloned the code from the repository, you can run the tests. To do so, install pytest, and, in the directory of the panedr source code, run:

For pyedr:

pytest -v pyedr/pyedr/tests

For panedr:

pytest -v panedr/panedr/tests

License

Pyedr and Panedr translate part of the source code of Gromacs into Python. Therefore, Panedr is distributed under the same GNU Lesser General Public License version 2.1 as Gromacs. See the license for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyedr-0.8.0.tar.gz (392.8 kB view details)

Uploaded Source

Built Distribution

pyedr-0.8.0-py3-none-any.whl (397.0 kB view details)

Uploaded Python 3

File details

Details for the file pyedr-0.8.0.tar.gz.

File metadata

  • Download URL: pyedr-0.8.0.tar.gz
  • Upload date:
  • Size: 392.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for pyedr-0.8.0.tar.gz
Algorithm Hash digest
SHA256 2d119dc32cd0b0b2a14584626c2349b9dbad132a6bfed32723fe841ed5857fd0
MD5 aa0089143399e64f5767a2e45b18dd69
BLAKE2b-256 0557c6bc9d7c68f53dbed1562ea102f9c0ed531c72e988ed57eb2e50c0dea7a1

See more details on using hashes here.

File details

Details for the file pyedr-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: pyedr-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 397.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for pyedr-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e61705d4460bae9fd1f4245a11bdd433ac7fc6084ebd0ab8b8f5b6bcfeb5ad0
MD5 7b490f3b17799e313ea59bbb757463da
BLAKE2b-256 267733237d2e9f19e32774704555f8efbd4c336d82b1bcf4dab712d5a8c2a9d5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page