# {py:mod}`ovo.core.logic.descriptor_logic`

```{py:module} ovo.core.logic.descriptor_logic
```

```{autodoc2-docstring} ovo.core.logic.descriptor_logic
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`get_available_descriptors <ovo.core.logic.descriptor_logic.get_available_descriptors>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.get_available_descriptors
    :summary:
    ```
* - {py:obj}`get_wide_descriptor_table <ovo.core.logic.descriptor_logic.get_wide_descriptor_table>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.get_wide_descriptor_table
    :summary:
    ```
* - {py:obj}`submit_descriptor_workflow <ovo.core.logic.descriptor_logic.submit_descriptor_workflow>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.submit_descriptor_workflow
    :summary:
    ```
* - {py:obj}`prepare_proteinqc_params <ovo.core.logic.descriptor_logic.prepare_proteinqc_params>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.prepare_proteinqc_params
    :summary:
    ```
* - {py:obj}`prepare_refolding_params <ovo.core.logic.descriptor_logic.prepare_refolding_params>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.prepare_refolding_params
    :summary:
    ```
* - {py:obj}`get_log <ovo.core.logic.descriptor_logic.get_log>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.get_log
    :summary:
    ```
* - {py:obj}`process_results <ovo.core.logic.descriptor_logic.process_results>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.process_results
    :summary:
    ```
* - {py:obj}`read_descriptor_file_values <ovo.core.logic.descriptor_logic.read_descriptor_file_values>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.read_descriptor_file_values
    :summary:
    ```
* - {py:obj}`save_descriptor_job_for_design_job <ovo.core.logic.descriptor_logic.save_descriptor_job_for_design_job>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.save_descriptor_job_for_design_job
    :summary:
    ```
* - {py:obj}`find_id_column <ovo.core.logic.descriptor_logic.find_id_column>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.find_id_column
    :summary:
    ```
* - {py:obj}`generate_descriptor_values_for_design <ovo.core.logic.descriptor_logic.generate_descriptor_values_for_design>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.generate_descriptor_values_for_design
    :summary:
    ```
* - {py:obj}`update_and_process_descriptors <ovo.core.logic.descriptor_logic.update_and_process_descriptors>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.update_and_process_descriptors
    :summary:
    ```
* - {py:obj}`export_proteinqc_excel <ovo.core.logic.descriptor_logic.export_proteinqc_excel>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.export_proteinqc_excel
    :summary:
    ```
* - {py:obj}`export_design_descriptors_excel <ovo.core.logic.descriptor_logic.export_design_descriptors_excel>`
  - ```{autodoc2-docstring} ovo.core.logic.descriptor_logic.export_design_descriptors_excel
    :summary:
    ```
````

### API

````{py:function} get_available_descriptors(design_ids: list[str]) -> dict[str, ovo.core.database.models.Descriptor]
:canonical: ovo.core.logic.descriptor_logic.get_available_descriptors

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.get_available_descriptors
```
````

````{py:function} get_wide_descriptor_table(*, pool_ids: typing.Collection[str] = None, design_ids: typing.Collection[str] = None, descriptor_keys: typing.Collection[str] = None, human_readable=True, nested=False, **filters) -> pandas.DataFrame
:canonical: ovo.core.logic.descriptor_logic.get_wide_descriptor_table

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.get_wide_descriptor_table
```
````

````{py:function} submit_descriptor_workflow(workflow: ovo.core.database.models.DescriptorWorkflow, scheduler_key: str, round_id: str)
:canonical: ovo.core.logic.descriptor_logic.submit_descriptor_workflow

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.submit_descriptor_workflow
```
````

````{py:function} prepare_proteinqc_params(workflow: ovo.core.database.models_proteinqc.ProteinQCWorkflow, workdir: str) -> dict
:canonical: ovo.core.logic.descriptor_logic.prepare_proteinqc_params

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.prepare_proteinqc_params
```
````

````{py:function} prepare_refolding_params(workflow: ovo.core.database.models_refolding.RefoldingWorkflow, workdir: str) -> dict
:canonical: ovo.core.logic.descriptor_logic.prepare_refolding_params

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.prepare_refolding_params
```
````

````{py:function} get_log(descriptor_job: ovo.core.database.models.DescriptorJob, tail: int = None) -> str
:canonical: ovo.core.logic.descriptor_logic.get_log

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.get_log
```
````

````{py:function} process_results(descriptor_job: ovo.core.database.models.DescriptorJob, callback: typing.Callable = None, wait: bool = True)
:canonical: ovo.core.logic.descriptor_logic.process_results

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.process_results
```
````

````{py:function} read_descriptor_file_values(descriptor_job: ovo.core.database.models.DescriptorJob, design_id_mapping: dict[str, str | tuple], filenames: dict[str, str] = None, descriptor_tables: dict[str, pandas.DataFrame] = None) -> list[ovo.core.database.models.DescriptorValue]
:canonical: ovo.core.logic.descriptor_logic.read_descriptor_file_values

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.read_descriptor_file_values
```
````

````{py:function} save_descriptor_job_for_design_job(design_job: ovo.core.database.models.DesignJob, round_id: str, chains: list[str], design_ids: list[str]) -> ovo.core.database.models.DescriptorJob
:canonical: ovo.core.logic.descriptor_logic.save_descriptor_job_for_design_job

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.save_descriptor_job_for_design_job
```
````

````{py:function} find_id_column(df: pandas.DataFrame, df_name: str)
:canonical: ovo.core.logic.descriptor_logic.find_id_column

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.find_id_column
```
````

````{py:function} generate_descriptor_values_for_design(design_id: str, table_ids: str | tuple, descriptor_job_id: str | None, descriptor_tables, chains: list[str]) -> list[ovo.core.database.models.DescriptorValue]
:canonical: ovo.core.logic.descriptor_logic.generate_descriptor_values_for_design

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.generate_descriptor_values_for_design
```
````

````{py:function} update_and_process_descriptors(descriptor_jobs: typing.List[ovo.core.database.models.DescriptorJob], error_callback: typing.Callable)
:canonical: ovo.core.logic.descriptor_logic.update_and_process_descriptors

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.update_and_process_descriptors
```
````

````{py:function} export_proteinqc_excel(design_ids: list[str], output_path: str = None)
:canonical: ovo.core.logic.descriptor_logic.export_proteinqc_excel

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.export_proteinqc_excel
```
````

````{py:function} export_design_descriptors_excel(df: pandas.DataFrame, output_path=None) -> io.BytesIO | None
:canonical: ovo.core.logic.descriptor_logic.export_design_descriptors_excel

```{autodoc2-docstring} ovo.core.logic.descriptor_logic.export_design_descriptors_excel
```
````