Metadata-Version: 2.1
Name: hdxms-datasets
Version: 0.1.3
Summary: Download and parse curated HDX-MS datasets
Project-URL: Source, https://github.com/Jhsmit/hdxms-datasets/
Project-URL: Documentation, https://jhsmit.github.io/hdxms-datasets/
Author-email: Jochem Smit <jhsmit@gmail.com>
License-Expression: MIT
License-File: AUTHORS.rst
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.9
Requires-Dist: omegaconf
Requires-Dist: packaging
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: black[jupyter]>=22.12.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: jupyter>=1.0.0; extra == 'docs'
Requires-Dist: mkdocs-gen-files>=0.4.0; extra == 'docs'
Requires-Dist: mkdocs-jupyter>=0.22.0; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.5.0; extra == 'docs'
Requires-Dist: mkdocs-material>=8.5.11; extra == 'docs'
Requires-Dist: mkdocs>=1.4.2; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.19.1; extra == 'docs'
Requires-Dist: pygments>=2.13.0; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest>=7.2.0; extra == 'test'
Description-Content-Type: text/markdown

# HDXMS Datasets


* Free software: MIT license

### Installation

```bash
$ pip install hdxms-datasets
```

### Example code


```python
from hdxms_datasets import DataVault

vault = DataVault()

# Download a specific HDX dataset
vault.fetch_dataset("20221007_1530_SecA_Krishnamurthy")

# Load the dataset
ds = vault.load_dataset("20221007_1530_SecA_Krishnamurthy")

# Load the FD control of the first 'state' in the dataset.
fd_control = ds.load_peptides(0, "FD_control")

# Load the corresponding experimental peptides.
peptides = ds.load_peptides(0, "experiment")

```

