Skip to main content

MDAnalysisData

Build Status codecov docs PRs welcome Anaconda-Server Badge DOI

Access to data for workshops and extended tests of MDAnalysis.

Data sets are stored at external stable URLs (e.g., on figshare, zenodo, or DataDryad) and this package provides a simple interface to download, cache, and access data sets.

Installation

To use, install the package

pip install --upgrade MDAnalysisData

or install with conda

conda install --channel conda-forge mdanalysisdata

Accessing data sets

Import the datasets and access your data set of choice:

from MDAnalysisData import datasets

adk = datasets.fetch_adk_equilibrium()

The returned object contains attributes with the paths to topology and trajectory files so that you can use it directly with, for instance, MDAnalysis:

import MDAnalysis as mda
u = mda.Universe(adk.topology, adk.trajectory)

The metadata object also contains a DESCR attribute with a description of the data set, including relevant citations:

print(adk.DESCR)

Managing data

Data are locally stored in the data directory ~/MDAnalysis_data (i.e., in the user's home directory). This location can be changed by setting the environment variable MDANALYSIS_DATA, for instance

export MDANALYSIS_DATA=/tmp/MDAnalysis_data

The location of the data directory can be obtained with

MDAnalysisData.base.get_data_home()

If the data directory is removed then data are downloaded again. Data file integrity is checked with a SHA256 checksum when the file is downloaded.

The data directory can we wiped with the function

MDAnalysisData.base.clear_data_home()

Credits

This package is modelled after sklearn.datasets. It uses code from sklearn.datasets (under the BSD 3-clause license).

No data are included; please see the DESCR attribute for each data set for authorship, citation, and license information for the data.

Release files for MDAnalysisData 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for MDAnalysisData 0.5.0
File Size Uploaded
MDAnalysisData-0.5.0.tar.gz 54.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for MDAnalysisData 0.5.0
File Interpreter ABI Platform
MDAnalysisData-0.5.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 78.3 kB

Release files / MDAnalysisData-0.5.0.tar.gz

Download URL MDAnalysisData-0.5.0.tar.gz
Size 54.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7bf84795bc0e5b1f2bb3769614c75fd4a6fa6a1eb9a8681ae3a5d2321c91242c
BLAKE2b-256 checksum
How to use checksums
7feddc8981f928fad4b7bdc0fa0ad26150518e1b2114f5008687bea6e6290e5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

Release files / MDAnalysisData-0.5.0-py2.py3-none-any.whl

Download URL MDAnalysisData-0.5.0-py2.py3-none-any.whl
Size 23.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2b5c18b5ea60d68bfbb25ec7a3f8de9690c4322dcb69dcfcc9d8dbd43d0ba26c
BLAKE2b-256 checksum
How to use checksums
e43f96e8727bbe59b81e18b2845f9698287e16a35753f8498d0259661d318fa9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

Release history Release notifications | RSS feed

0.9.1

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page