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

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

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

## Module Contents

### Classes

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

* - {py:obj}`BindCraftParams <ovo.core.database.models_bindcraft.BindCraftParams>`
  - ```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams
    :summary:
    ```
* - {py:obj}`BindCraftBinderDesignWorkflow <ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow>`
  - ```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow
    :summary:
    ```
````

### API

`````{py:class} BindCraftParams
:canonical: ovo.core.database.models_bindcraft.BindCraftParams

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

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams
```

````{py:attribute} input_pdb_path
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.input_pdb_path
:type: str
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.input_pdb_path
```

````

````{py:attribute} target_chains
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.target_chains
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.target_chains
```

````

````{py:attribute} binder_length
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.binder_length
:type: str
:value: >
   '70,150'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.binder_length
```

````

````{py:attribute} hotspots
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.hotspots
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.hotspots
```

````

````{py:attribute} number_of_final_designs
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.number_of_final_designs
:type: int
:value: >
   2

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.number_of_final_designs
```

````

````{py:attribute} time_limit_hours
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.time_limit_hours
:type: int
:value: >
   24

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.time_limit_hours
```

````

````{py:attribute} filter_type
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.filter_type
:type: str
:value: >
   'Default'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.filter_type
```

````

````{py:attribute} design_protocol
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.design_protocol
:type: str
:value: >
   'Default'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.design_protocol
```

````

````{py:attribute} interface_protocol
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.interface_protocol
:type: str
:value: >
   'AlphaFold2'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.interface_protocol
```

````

````{py:attribute} template_protocol
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.template_protocol
:type: str
:value: >
   'Default'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.template_protocol
```

````

````{py:attribute} prediction_protocol
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.prediction_protocol
:type: str
:value: >
   'Default'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.prediction_protocol
```

````

````{py:attribute} custom_advanced_settings
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.custom_advanced_settings
:type: dict
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.custom_advanced_settings
```

````

````{py:attribute} custom_filter_settings
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.custom_filter_settings
:type: dict
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.custom_filter_settings
```

````

````{py:attribute} num_replicas
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.num_replicas
:type: int
:value: >
   1

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.num_replicas
```

````

````{py:method} from_dict(data)
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.from_dict
:classmethod:

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.from_dict
```

````

````{py:method} validate()
:canonical: ovo.core.database.models_bindcraft.BindCraftParams.validate

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftParams.validate
```

````

`````

`````{py:class} BindCraftBinderDesignWorkflow
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow

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

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow
```

````{py:attribute} bindcraft_params
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.bindcraft_params
:type: ovo.core.database.models_bindcraft.BindCraftParams | None
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.bindcraft_params
```

````

````{py:attribute} input_name
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.input_name
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.input_name
```

````

````{py:attribute} selected_segments
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.selected_segments
:type: list[str] | None
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.selected_segments
```

````

````{py:attribute} chains
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.chains
:type: dict | None
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.chains
```

````

````{py:method} get_input_pdb_paths()
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_input_pdb_paths

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_input_pdb_paths
```

````

````{py:method} get_input_pdb_path()
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_input_pdb_path

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_input_pdb_path
```

````

````{py:method} get_selected_segments()
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_selected_segments

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_selected_segments
```

````

````{py:method} set_selected_segments(segments: list[str])
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.set_selected_segments

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.set_selected_segments
```

````

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

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_pipeline_name
```

````

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

````

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

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.process_results
```

````

````{py:method} visualize_single_design_structures(design_id: str)
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.visualize_single_design_structures
:classmethod:

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.visualize_single_design_structures
```

````

````{py:method} get_download_fields()
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_download_fields
:classmethod:

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_download_fields
```

````

````{py:method} get_settings_paths()
:canonical: ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_settings_paths

```{autodoc2-docstring} ovo.core.database.models_bindcraft.BindCraftBinderDesignWorkflow.get_settings_paths
```

````

`````