Skip to content

models

DataRepository

Bases: BaseModel

Information about the data repository where the source data is published

Source code in hdxms_datasets/models.py
438
439
440
441
442
443
444
445
class DataRepository(BaseModel):
    """Information about the data repository where the source data is published"""

    name: Annotated[str, Field(..., description="Repository name")]  # ie Pride, Zenodo,
    url: Annotated[Optional[HttpUrl], Field(None, description="Repository URL")]
    identifier: Annotated[Optional[str], Field(None, description="Repository entry identifier")]
    doi: Annotated[Optional[str], Field(None, description="Repository DOI")]
    description: Annotated[Optional[str], Field(None, description="Repository description")]

DeuterationType

Bases: str, Enum

Experimental Deuteration Type of the peptide

Source code in hdxms_datasets/models.py
177
178
179
180
181
182
class DeuterationType(str, Enum):
    """Experimental Deuteration Type of the peptide"""

    partially_deuterated = "partially_deuterated"
    fully_deuterated = "fully_deuterated"
    non_deuterated = "non_deuterated"

HDXDataSet

Bases: BaseModel

HDX-MS dataset containing multiple states

Source code in hdxms_datasets/models.py
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
class HDXDataSet(BaseModel):
    """HDX-MS dataset containing multiple states"""

    hdx_id: Annotated[
        str, Field(default_factory=id_factory, description="HDX-MS dataset identifier")
    ]

    # Basic information
    description: Annotated[Optional[str], Field(None, description="Dataset description")]

    states: list[State] = Field(description="List of HDX states in the dataset")
    structure: Annotated[Structure, Field(description="Structural model file path")]
    protein_identifiers: Annotated[
        ProteinIdentifiers, Field(description="Protein identifiers (UniProt, etc.)")
    ]
    metadata: Annotated[DatasetMetadata, Field(description="Dataset metadata")]
    file_hash: Annotated[
        Optional[str], Field(None, init=False, description="Hash of the files in the dataset")
    ]

    @model_validator(mode="after")
    def validate_hdx_id(self):
        """Validate hdx_id format: 'HDX_' followed by 8 uppercase alphanumeric chars (e.g. HDX_3BAE2080)."""
        from hdxms_datasets.database import valid_id

        if not valid_id(self.hdx_id):
            raise ValueError(
                "hdx_id must match pattern 'HDX_XXXXXXXX' where X are uppercase letters or digits, e.g. 'HDX_3BAE2080'"
            )
        return self

    @model_validator(mode="after")
    def compute_file_hash(self):
        """Compute a hash of the dataset based on its data files"""
        if any(not p.exists() for p in self.data_files):
            self.file_hash = None
            return self

        self.file_hash = self.hash_files()[:16]  # Shorten to 16 characters

        return self

    @model_validator(mode="after")
    def verify_unique_state_names(self):
        """Ensure that all state names are unique within the dataset"""
        state_names = [state.name for state in self.states]
        if len(state_names) != len(set(state_names)):
            raise ValueError("State names must be unique within the dataset.")
        return self

    def hash_files(self) -> str:
        return hash_files(self.data_files)  # Ensure files are sorted and hashed consistently

    def validate_file_integrity(self) -> bool:
        """Match hash of files with the stored hash"""
        if self.file_hash is None:
            return False
        current_hash = self.hash_files()
        return current_hash.startswith(self.file_hash)

    def get_state(self, state: str | int) -> State:
        """Get a specific state by name or index"""
        if isinstance(state, int):
            return self.states[state]
        elif isinstance(state, str):
            for s in self.states:
                if s.name == state:
                    return s
        raise ValueError(f"State '{state}' not found in dataset.")

    @property
    def data_files(self) -> list[Path]:
        """List of all data files in the dataset"""
        return sorted(set(extract_values_by_types(self, Path)))

    @classmethod
    def from_json(
        cls,
        json_str: str,
        dataset_root: Optional[Path] = None,
    ) -> HDXDataSet:
        """Load dataset from JSON string

        Args:
            json_str: JSON string representing the dataset
            dataset_root: Optional root directory to resolve relative paths

        Returns:
            HDXDataSet instance.

        """
        if dataset_root is None:
            context = {}
        else:
            context = {"dataset_root": dataset_root}
        return cls.model_validate_json(json_str, context=context)

data_files property

List of all data files in the dataset

compute_file_hash()

Compute a hash of the dataset based on its data files

Source code in hdxms_datasets/models.py
547
548
549
550
551
552
553
554
555
556
@model_validator(mode="after")
def compute_file_hash(self):
    """Compute a hash of the dataset based on its data files"""
    if any(not p.exists() for p in self.data_files):
        self.file_hash = None
        return self

    self.file_hash = self.hash_files()[:16]  # Shorten to 16 characters

    return self

from_json(json_str, dataset_root=None) classmethod

Load dataset from JSON string

Parameters:

Name Type Description Default
json_str str

JSON string representing the dataset

required
dataset_root Optional[Path]

Optional root directory to resolve relative paths

None

Returns:

Type Description
HDXDataSet

HDXDataSet instance.

Source code in hdxms_datasets/models.py
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
@classmethod
def from_json(
    cls,
    json_str: str,
    dataset_root: Optional[Path] = None,
) -> HDXDataSet:
    """Load dataset from JSON string

    Args:
        json_str: JSON string representing the dataset
        dataset_root: Optional root directory to resolve relative paths

    Returns:
        HDXDataSet instance.

    """
    if dataset_root is None:
        context = {}
    else:
        context = {"dataset_root": dataset_root}
    return cls.model_validate_json(json_str, context=context)

get_state(state)

Get a specific state by name or index

Source code in hdxms_datasets/models.py
576
577
578
579
580
581
582
583
584
def get_state(self, state: str | int) -> State:
    """Get a specific state by name or index"""
    if isinstance(state, int):
        return self.states[state]
    elif isinstance(state, str):
        for s in self.states:
            if s.name == state:
                return s
    raise ValueError(f"State '{state}' not found in dataset.")

validate_file_integrity()

Match hash of files with the stored hash

Source code in hdxms_datasets/models.py
569
570
571
572
573
574
def validate_file_integrity(self) -> bool:
    """Match hash of files with the stored hash"""
    if self.file_hash is None:
        return False
    current_hash = self.hash_files()
    return current_hash.startswith(self.file_hash)

validate_hdx_id()

Validate hdx_id format: 'HDX_' followed by 8 uppercase alphanumeric chars (e.g. HDX_3BAE2080).

Source code in hdxms_datasets/models.py
536
537
538
539
540
541
542
543
544
545
@model_validator(mode="after")
def validate_hdx_id(self):
    """Validate hdx_id format: 'HDX_' followed by 8 uppercase alphanumeric chars (e.g. HDX_3BAE2080)."""
    from hdxms_datasets.database import valid_id

    if not valid_id(self.hdx_id):
        raise ValueError(
            "hdx_id must match pattern 'HDX_XXXXXXXX' where X are uppercase letters or digits, e.g. 'HDX_3BAE2080'"
        )
    return self

verify_unique_state_names()

Ensure that all state names are unique within the dataset

Source code in hdxms_datasets/models.py
558
559
560
561
562
563
564
@model_validator(mode="after")
def verify_unique_state_names(self):
    """Ensure that all state names are unique within the dataset"""
    state_names = [state.name for state in self.states]
    if len(state_names) != len(set(state_names)):
        raise ValueError("State names must be unique within the dataset.")
    return self

PeptideFormat

Bases: str, Enum

Format of the peptide data

Source code in hdxms_datasets/models.py
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
class PeptideFormat(str, Enum):
    """Format of the peptide data"""

    DynamX_v3_state = "DynamX_v3_state"
    DynamX_v3_cluster = "DynamX_v3_cluster"
    DynamX_vx_state = "DynamX_vx_state"
    HDExaminer_v3 = "HDExaminer_v3"
    HXMS = "HXMS"
    OpenHDX = "OpenHDX"

    @classmethod
    def identify(cls, df: nw.DataFrame) -> PeptideFormat | None:
        """Identify format from DataFrame"""
        from hdxms_datasets.formats import identify_format

        fmt = identify_format(df)
        if fmt:
            return cls(fmt.name)
        return None

identify(df) classmethod

Identify format from DataFrame

Source code in hdxms_datasets/models.py
166
167
168
169
170
171
172
173
174
@classmethod
def identify(cls, df: nw.DataFrame) -> PeptideFormat | None:
    """Identify format from DataFrame"""
    from hdxms_datasets.formats import identify_format

    fmt = identify_format(df)
    if fmt:
        return cls(fmt.name)
    return None

Peptides

Bases: BaseModel

Information about HDX-MS peptides

Source code in hdxms_datasets/models.py
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
class Peptides(BaseModel):
    """Information about HDX-MS peptides"""

    data_file: DataFilePath
    data_format: Annotated[PeptideFormat, Field(description="Data format (e.g., OpenHDX)")]
    deuteration_type: Annotated[
        DeuterationType, Field(description="Type of the peptide (e.g., fully_deuterated)")
    ]
    filters: Annotated[
        dict[str, ValueType | list[ValueType]],
        Field(default_factory=dict, description="Filters applied to the data"),
        AfterValidator(validate_nonfinite_numbers_recursive),
        PlainSerializer(serialize_nonfinite_numbers_recursive),
    ]
    pH: Annotated[
        Optional[float], Field(description="pH (read, uncorrected) of the experiment")
    ] = None
    temperature: Annotated[Optional[float], Field(description="Temperature in Kelvin")] = None
    d_percentage: Annotated[Optional[float], Field(description="Deuteration percentage")] = None
    ionic_strength: Annotated[Optional[float], Field(description="Ionic strength in Molar")] = None

    structure_mapping: Annotated[
        StructureMapping, Field(description="Structure mapping information")
    ] = StructureMapping()

    def load(
        self,
        convert: bool = True,
        aggregate: bool | None = None,
        sort_rows: bool = True,
        sort_columns: bool = True,
        drop_null: bool = True,
    ) -> nw.DataFrame:
        """Load the peptides from the data file

        Args:
            convert: Whether to convert the data to a standard format.
            aggregate: Whether to aggregate the data. If None, will aggregate if the data is not already aggregated.
            sort_rows: Whether to sort the rows.
            sort_columns: Whether to sort the columns in a standard order.
            drop_null: Whether to drop columns that are entirely null.

        """
        if self.data_file.exists():
            from hdxms_datasets.loader import load_peptides

            return load_peptides(
                self,
                convert=convert,
                aggregate=aggregate,
                sort_rows=sort_rows,
                sort_columns=sort_columns,
                drop_null=drop_null,
            )
        else:
            raise FileNotFoundError(f"Data file {self.data_file} does not exist.")

load(convert=True, aggregate=None, sort_rows=True, sort_columns=True, drop_null=True)

Load the peptides from the data file

Parameters:

Name Type Description Default
convert bool

Whether to convert the data to a standard format.

True
aggregate bool | None

Whether to aggregate the data. If None, will aggregate if the data is not already aggregated.

None
sort_rows bool

Whether to sort the rows.

True
sort_columns bool

Whether to sort the columns in a standard order.

True
drop_null bool

Whether to drop columns that are entirely null.

True
Source code in hdxms_datasets/models.py
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
def load(
    self,
    convert: bool = True,
    aggregate: bool | None = None,
    sort_rows: bool = True,
    sort_columns: bool = True,
    drop_null: bool = True,
) -> nw.DataFrame:
    """Load the peptides from the data file

    Args:
        convert: Whether to convert the data to a standard format.
        aggregate: Whether to aggregate the data. If None, will aggregate if the data is not already aggregated.
        sort_rows: Whether to sort the rows.
        sort_columns: Whether to sort the columns in a standard order.
        drop_null: Whether to drop columns that are entirely null.

    """
    if self.data_file.exists():
        from hdxms_datasets.loader import load_peptides

        return load_peptides(
            self,
            convert=convert,
            aggregate=aggregate,
            sort_rows=sort_rows,
            sort_columns=sort_columns,
            drop_null=drop_null,
        )
    else:
        raise FileNotFoundError(f"Data file {self.data_file} does not exist.")

ProteinIdentifiers

Bases: BaseModel

General protein information

Source code in hdxms_datasets/models.py
273
274
275
276
277
278
279
280
281
282
class ProteinIdentifiers(BaseModel):
    """General protein information"""

    uniprot_accession_number: Annotated[Optional[str], Field(None, description="UniProt ID")] = None
    uniprot_entry_name: Annotated[Optional[str], Field(None, description="UniProt entry name")] = (
        None
    )
    protein_name: Annotated[Optional[str], Field(None, description="Recommended protein name")] = (
        None
    )

ProteinState

Bases: BaseModel

Protein information for a specific state

Source code in hdxms_datasets/models.py
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
class ProteinState(BaseModel):
    """Protein information for a specific state"""

    sequence: Annotated[str | list[str], Field(description="Amino acid sequence")]
    n_term: Annotated[int, Field(description="N-terminal residue number")]
    c_term: Annotated[int, Field(description="C-terminal residue number")]
    mutations: Annotated[Optional[list[str]], Field(description="List of mutations")] = None
    oligomeric_state: Annotated[Optional[int], Field(description="Oligomeric state")] = None
    ligand: Annotated[Optional[str], Field(description="Bound ligand information")] = None

    @model_validator(mode="after")
    def check_sequence(self):
        if len(self.sequence) != self.c_term - self.n_term + 1:
            raise ValueError("Sequence length does not match N-term and C-term residue numbers.")
        return self

Publication

Bases: BaseModel

Publication information

Source code in hdxms_datasets/models.py
426
427
428
429
430
431
432
433
434
435
class Publication(BaseModel):
    """Publication information"""

    title: Optional[str] = None
    authors: Optional[List[str]] = None
    journal: Optional[str] = None
    year: Optional[int] = None
    doi: Optional[str] = None
    pmid: Optional[str] = None
    url: Optional[str] = None

State

Bases: BaseModel

Information about HDX-MS state

Source code in hdxms_datasets/models.py
302
303
304
305
306
307
308
class State(BaseModel):
    """Information about HDX-MS state"""

    name: Annotated[str, Field(description="State name")]
    peptides: list[Peptides] = Field(..., description="List of peptides in this state")
    description: Annotated[str, Field(description="State description")] = ""  # TODO max length?
    protein_state: ProteinState = Field(..., description="Protein information for this state")

Structure

Bases: BaseModel

Structural model file information

Residues or protein chains may have different numbering/labels depending on if they are
the assigned labels by the author of the structure ('auth') or renumbered by the RCSB PDB.

If your HDX data uses the author numbering/labels, set auth_residue_numbers and/or
auth_chain_labels to True.

Source code in hdxms_datasets/models.py
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
class Structure(BaseModel):
    """Structural model file information

    Residues or protein chains may have different numbering/labels depending on if they are
    the assigned labels by the author of the structure ('auth') or renumbered by the RCSB PDB.

    If your HDX data uses the author numbering/labels, set `auth_residue_numbers` and/or
    `auth_chain_labels` to True.
    """

    data_file: DataFilePath
    format: Annotated[str, Field(description="Format of the structure file (e.g., PDB, mmCIF)")]
    description: Annotated[Optional[str], Field(description="Description of the structure")] = None

    # source database identifiers
    pdb_id: Annotated[Optional[str], Field(None, description="RCSB PDB ID")] = None
    alphafold_id: Annotated[Optional[str], Field(None, description="AlphaFold ID")] = None

    def pdbemolstar_custom_data(self) -> dict[str, Any]:
        """
        Returns a dictionary with custom data for PDBeMolstar visualization.
        """

        if self.format in ["bcif"]:
            binary = True
        else:
            binary = False

        if self.data_file.is_file():
            data = self.data_file.read_bytes()
        else:
            raise ValueError(f"Path {self.data_file} is not a file.")

        return {
            "data": data,
            "format": self.format,
            "binary": binary,
        }

    def get_auth_residue_mapping(self) -> dict[tuple[str, str], tuple[str, str]]:
        """Create a mapping from author residue numbers to RCSB residue numbers."""

        if self.label_auth_mapping is not None:
            return self.label_auth_mapping

        else:
            if self.format.lower() not in ["cif", "mmcif"]:
                raise ValueError("Author residue number mapping is only supported for mmCIF files.")

            mapping = residue_number_mapping(self.data_file)
            self.label_auth_mapping = mapping
            return mapping

    def to_biopython(self) -> BioStructure:
        """Load the structure using Biopython"""
        try:
            from Bio.PDB.PDBParser import PDBParser
            from Bio.PDB.MMCIFParser import MMCIFParser
        except ImportError:
            raise ImportError("Biopython is required to load structures.")

        if self.format.lower() in ["pdb"]:
            parser = PDBParser(QUIET=True)
        elif self.format.lower() in ["cif", "mmcif"]:
            parser = MMCIFParser(QUIET=True)
        else:
            raise ValueError(f"Unsupported structure format: {self.format}")

        structure = parser.get_structure(self.pdb_id or "structure", self.data_file)
        assert structure is not None

        return structure

get_auth_residue_mapping()

Create a mapping from author residue numbers to RCSB residue numbers.

Source code in hdxms_datasets/models.py
391
392
393
394
395
396
397
398
399
400
401
402
403
def get_auth_residue_mapping(self) -> dict[tuple[str, str], tuple[str, str]]:
    """Create a mapping from author residue numbers to RCSB residue numbers."""

    if self.label_auth_mapping is not None:
        return self.label_auth_mapping

    else:
        if self.format.lower() not in ["cif", "mmcif"]:
            raise ValueError("Author residue number mapping is only supported for mmCIF files.")

        mapping = residue_number_mapping(self.data_file)
        self.label_auth_mapping = mapping
        return mapping

pdbemolstar_custom_data()

Returns a dictionary with custom data for PDBeMolstar visualization.

Source code in hdxms_datasets/models.py
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
def pdbemolstar_custom_data(self) -> dict[str, Any]:
    """
    Returns a dictionary with custom data for PDBeMolstar visualization.
    """

    if self.format in ["bcif"]:
        binary = True
    else:
        binary = False

    if self.data_file.is_file():
        data = self.data_file.read_bytes()
    else:
        raise ValueError(f"Path {self.data_file} is not a file.")

    return {
        "data": data,
        "format": self.format,
        "binary": binary,
    }

to_biopython()

Load the structure using Biopython

Source code in hdxms_datasets/models.py
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
def to_biopython(self) -> BioStructure:
    """Load the structure using Biopython"""
    try:
        from Bio.PDB.PDBParser import PDBParser
        from Bio.PDB.MMCIFParser import MMCIFParser
    except ImportError:
        raise ImportError("Biopython is required to load structures.")

    if self.format.lower() in ["pdb"]:
        parser = PDBParser(QUIET=True)
    elif self.format.lower() in ["cif", "mmcif"]:
        parser = MMCIFParser(QUIET=True)
    else:
        raise ValueError(f"Unsupported structure format: {self.format}")

    structure = parser.get_structure(self.pdb_id or "structure", self.data_file)
    assert structure is not None

    return structure

StructureMapping

Bases: BaseModel

Maps peptide HDX-MS data to a structure

Residue numbers can be mapped from HDX-MS data to a structure using either an residue number
offset or a specific dictionary mapping.

Source code in hdxms_datasets/models.py
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
class StructureMapping(BaseModel):
    """Maps peptide HDX-MS data to a structure

    Residue numbers can be mapped from HDX-MS data to a structure using either an residue number
    offset or a specific dictionary mapping.

    """

    entity_id: Annotated[Optional[str], Field(None, description="Entity identifier")] = None
    chain: Annotated[Optional[list[str]], Field(None, description="Chain identifiers")] = None
    residue_offset: Annotated[int, Field(None, description="Residue number offset to apply")] = 0
    mapping: dict[int, int] = Field(default_factory=dict, description="Residue number mapping")

    auth_residue_numbers: Annotated[
        bool, Field(default=False, description="Use author residue numbers")
    ] = False
    auth_chain_labels: Annotated[
        bool, Field(default=False, description="Use author chain labels")
    ] = False

    def map(self, residue_number: int) -> int:
        """Map a residue number using the mapping dictionary and offset"""
        if self.residue_offset:
            return residue_number + self.residue_offset
        elif self.mapping:
            return self.mapping.get(residue_number, residue_number)
        else:
            return residue_number

map(residue_number)

Map a residue number using the mapping dictionary and offset

Source code in hdxms_datasets/models.py
205
206
207
208
209
210
211
212
def map(self, residue_number: int) -> int:
    """Map a residue number using the mapping dictionary and offset"""
    if self.residue_offset:
        return residue_number + self.residue_offset
    elif self.mapping:
        return self.mapping.get(residue_number, residue_number)
    else:
        return residue_number

extract_values_by_types(obj, target_types)

Recursively extract all values of specified type(s) from a nested structure.
This function can handle Pydantic models, lists, tuples, sets, and dictionaries.

Parameters:

Name Type Description Default
obj Any

Pydantic model instance or any nested structure

required
target_types Type | tuple[Type, ...]

Single type or tuple of types to search for

required

Returns:

Type Description
list[Any]

List of all values matching any of the target types

Source code in hdxms_datasets/models.py
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def extract_values_by_types(obj: Any, target_types: Type | tuple[Type, ...]) -> list[Any]:
    """
    Recursively extract all values of specified type(s) from a nested structure.
    This function can handle Pydantic models, lists, tuples, sets, and dictionaries.

    Args:
        obj: Pydantic model instance or any nested structure
        target_types: Single type or tuple of types to search for

    Returns:
        List of all values matching any of the target types
    """
    values = []

    # Normalize target_types to tuple
    if not isinstance(target_types, tuple):
        target_types = (target_types,)

    # Check if current object is of any target type
    if isinstance(obj, target_types):
        values.append(obj)

    elif isinstance(obj, BaseModel):
        # Iterate through all field values in the Pydantic model
        for field_name, field_value in obj.__dict__.items():
            values.extend(extract_values_by_types(field_value, target_types))

    elif isinstance(obj, (list, tuple, set)):
        # Handle sequences
        for item in obj:
            values.extend(extract_values_by_types(item, target_types))

    elif isinstance(obj, dict):
        # Handle dictionaries (both keys and values)
        for key, value in obj.items():
            values.extend(extract_values_by_types(key, target_types))
            values.extend(extract_values_by_types(value, target_types))

    return values

hash_files(data_files)

Compute a hash of all data files in the dataset

Source code in hdxms_datasets/models.py
134
135
136
137
138
139
140
141
142
143
144
145
def hash_files(data_files: Iterable[Path]) -> str:
    """Compute a hash of all data files in the dataset"""
    hash_obj = hashlib.sha256()
    files = sorted(data_files, key=lambda p: p.as_posix())  # Sort to ensure consistent order
    for f in files:
        if f.suffix in TEXT_FILE_FORMATS:
            content = f.read_text(encoding="utf-8").replace("\r\n", "\n").replace("\r", "\n")
            hash_obj.update(content.encode("utf-8"))
        else:
            hash_obj.update(f.read_bytes())

    return hash_obj.hexdigest()

id_factory()

Factory function to generate a new dataset ID

Source code in hdxms_datasets/models.py
509
510
511
512
513
def id_factory() -> str:
    """Factory function to generate a new dataset ID"""
    from hdxms_datasets.database import mint_new_dataset_id

    return mint_new_dataset_id()

residue_number_mapping(cif_path, chain=True, residue=True)

Create a mapping from author residue numbers to RCSB residue numbers from an mmCIF file.

Parameters:

Name Type Description Default
cif_path Path

Path to the mmCIF file.

required
chain

Whether to include chain mapping.

True
residue

Whether to include residue number mapping.

True
Source code in hdxms_datasets/models.py
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def residue_number_mapping(
    cif_path: Path, chain=True, residue=True
) -> dict[tuple[str, str], tuple[str, str]]:
    """Create a mapping from author residue numbers to RCSB residue numbers from an mmCIF file.

    Args:
        cif_path: Path to the mmCIF file.
        chain: Whether to include chain mapping.
        residue: Whether to include residue number mapping.


    """
    try:
        from Bio.PDB.MMCIF2Dict import MMCIF2Dict
    except ImportError:
        raise ImportError("Biopython is required for residue number mapping from mmCIF files.")

    mm = MMCIF2Dict(cif_path)

    label_asym = mm["_atom_site.label_asym_id"]
    if chain:
        auth_asym = mm.get("_atom_site.auth_asym_id", label_asym)
    else:
        auth_asym = label_asym

    label_seq = mm.get("_atom_site.label_seq_id", [])
    if residue:
        auth_seq = mm.get("_atom_site.auth_seq_id", label_seq)
    else:
        auth_seq = label_seq

    # maps author chain/residue numbers to PDB chain/residue numbers
    mapping = {
        (a_asym, a_seq): (l_asym, l_seq)
        for l_asym, l_seq, a_asym, a_seq in zip(label_asym, label_seq, auth_asym, auth_seq)
        if l_asym != a_asym or l_seq != a_seq  # dont include identical mappings
    }

    return mapping

serialize_datafile_path(x, info)

Pydantic serializer to convert paths to relative paths based on context

Source code in hdxms_datasets/models.py
79
80
81
82
83
84
85
def serialize_datafile_path(x: Path, info: ValidationInfo) -> str:
    """Pydantic serializer to convert paths to relative paths based on context"""
    context = info.context
    if context and "dataset_root" in context:
        relpath = x.relative_to(Path(context["dataset_root"]))
        return relpath.as_posix()
    return x.as_posix()

validate_datafile_path(x, info)

Pydantic validator to resolve relative paths based on context

Source code in hdxms_datasets/models.py
70
71
72
73
74
75
76
def validate_datafile_path(x: Path, info: ValidationInfo):
    """Pydantic validator to resolve relative paths based on context"""
    context = info.context
    if context and "dataset_root" in context and not x.is_absolute():
        root = Path(context["dataset_root"])
        x = root / x
    return x