# {py:mod}`ovo.core.database.models_proteinqc`

```{py:module} ovo.core.database.models_proteinqc
```

```{autodoc2-docstring} ovo.core.database.models_proteinqc
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ProteinQCTool <ovo.core.database.models_proteinqc.ProteinQCTool>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCTool
    :summary:
    ```
* - {py:obj}`ProteinQCWorkflow <ovo.core.database.models_proteinqc.ProteinQCWorkflow>`
  -
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`SEQ_COMPOSITION <ovo.core.database.models_proteinqc.SEQ_COMPOSITION>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.SEQ_COMPOSITION
    :summary:
    ```
* - {py:obj}`ESM_1V <ovo.core.database.models_proteinqc.ESM_1V>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.ESM_1V
    :summary:
    ```
* - {py:obj}`ESM_IF <ovo.core.database.models_proteinqc.ESM_IF>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.ESM_IF
    :summary:
    ```
* - {py:obj}`DSSP <ovo.core.database.models_proteinqc.DSSP>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.DSSP
    :summary:
    ```
* - {py:obj}`PEPPATCH <ovo.core.database.models_proteinqc.PEPPATCH>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.PEPPATCH
    :summary:
    ```
* - {py:obj}`PROTEINSOL <ovo.core.database.models_proteinqc.PROTEINSOL>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.PROTEINSOL
    :summary:
    ```
* - {py:obj}`PROTEINQC_TOOLS <ovo.core.database.models_proteinqc.PROTEINQC_TOOLS>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.PROTEINQC_TOOLS
    :summary:
    ```
* - {py:obj}`PROTEINQC_TOOLS_BY_KEY <ovo.core.database.models_proteinqc.PROTEINQC_TOOLS_BY_KEY>`
  - ```{autodoc2-docstring} ovo.core.database.models_proteinqc.PROTEINQC_TOOLS_BY_KEY
    :summary:
    ```
````

### API

`````{py:class} ProteinQCTool
:canonical: ovo.core.database.models_proteinqc.ProteinQCTool

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCTool
```

````{py:attribute} name
:canonical: ovo.core.database.models_proteinqc.ProteinQCTool.name
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCTool.name
```

````

````{py:attribute} tool_key
:canonical: ovo.core.database.models_proteinqc.ProteinQCTool.tool_key
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCTool.tool_key
```

````

````{py:attribute} supports_conda
:canonical: ovo.core.database.models_proteinqc.ProteinQCTool.supports_conda
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCTool.supports_conda
```

````

````{py:attribute} supports_multichain
:canonical: ovo.core.database.models_proteinqc.ProteinQCTool.supports_multichain
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCTool.supports_multichain
```

````

`````

````{py:data} SEQ_COMPOSITION
:canonical: ovo.core.database.models_proteinqc.SEQ_COMPOSITION
:value: >
   'ProteinQCTool(...)'

```{autodoc2-docstring} ovo.core.database.models_proteinqc.SEQ_COMPOSITION
```

````

````{py:data} ESM_1V
:canonical: ovo.core.database.models_proteinqc.ESM_1V
:value: >
   'ProteinQCTool(...)'

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ESM_1V
```

````

````{py:data} ESM_IF
:canonical: ovo.core.database.models_proteinqc.ESM_IF
:value: >
   'ProteinQCTool(...)'

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ESM_IF
```

````

````{py:data} DSSP
:canonical: ovo.core.database.models_proteinqc.DSSP
:value: >
   'ProteinQCTool(...)'

```{autodoc2-docstring} ovo.core.database.models_proteinqc.DSSP
```

````

````{py:data} PEPPATCH
:canonical: ovo.core.database.models_proteinqc.PEPPATCH
:value: >
   'ProteinQCTool(...)'

```{autodoc2-docstring} ovo.core.database.models_proteinqc.PEPPATCH
```

````

````{py:data} PROTEINSOL
:canonical: ovo.core.database.models_proteinqc.PROTEINSOL
:value: >
   'ProteinQCTool(...)'

```{autodoc2-docstring} ovo.core.database.models_proteinqc.PROTEINSOL
```

````

````{py:data} PROTEINQC_TOOLS
:canonical: ovo.core.database.models_proteinqc.PROTEINQC_TOOLS
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_proteinqc.PROTEINQC_TOOLS
```

````

````{py:data} PROTEINQC_TOOLS_BY_KEY
:canonical: ovo.core.database.models_proteinqc.PROTEINQC_TOOLS_BY_KEY
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_proteinqc.PROTEINQC_TOOLS_BY_KEY
```

````

`````{py:class} ProteinQCWorkflow
:canonical: ovo.core.database.models_proteinqc.ProteinQCWorkflow

Bases: {py:obj}`ovo.core.database.models.DescriptorWorkflow`

````{py:attribute} tools
:canonical: ovo.core.database.models_proteinqc.ProteinQCWorkflow.tools
:type: typing.List[str]
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCWorkflow.tools
```

````

````{py:method} get_pipeline_name() -> str
:canonical: ovo.core.database.models_proteinqc.ProteinQCWorkflow.get_pipeline_name

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCWorkflow.get_pipeline_name
```

````

````{py:method} prepare_params(workdir: str) -> dict
:canonical: ovo.core.database.models_proteinqc.ProteinQCWorkflow.prepare_params

````

````{py:method} process_results(job: ovo.core.database.DescriptorJob, callback: typing.Callable = None) -> list[ovo.core.database.models.Base]
:canonical: ovo.core.database.models_proteinqc.ProteinQCWorkflow.process_results

````

````{py:method} validate()
:canonical: ovo.core.database.models_proteinqc.ProteinQCWorkflow.validate

```{autodoc2-docstring} ovo.core.database.models_proteinqc.ProteinQCWorkflow.validate
```

````

`````