import_structures
import_structures(structures_dir, session_dir, /, *, copy_method='hardlink', strict=False, _=None)
Import structures from a file or directory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
structures_dir
|
Annotated[Path, Parameter(validator=Path(file_okay=False, dir_okay=True, exists=True))]
|
Directory containing structure files to import |
required |
session_dir
|
Annotated[Path, Parameter(validator=Path(file_okay=False, dir_okay=True))]
|
Session directory to store results |
required |
copy_method
|
CopyMethod
|
Method to use for importing files. If 'copy', files will be copied. If 'symlink', symbolic links will be created. If 'hardlink', hard links will be created (unavailable on Windows). |
'hardlink'
|
strict
|
Annotated[bool, Parameter(negative='')]
|
Raise an error if structure files do not meet expected criteria (single chain A, single UniProt accession). Without this flag, files that do not meet these criteria are skipped with a warning. |
False
|