# {py:mod}`ovo.core.configuration`

```{py:module} ovo.core.configuration
```

```{autodoc2-docstring} ovo.core.configuration
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`BaseConfigModel <ovo.core.configuration.BaseConfigModel>`
  -
* - {py:obj}`DBConfig <ovo.core.configuration.DBConfig>`
  - ```{autodoc2-docstring} ovo.core.configuration.DBConfig
    :summary:
    ```
* - {py:obj}`AWSConfig <ovo.core.configuration.AWSConfig>`
  - ```{autodoc2-docstring} ovo.core.configuration.AWSConfig
    :summary:
    ```
* - {py:obj}`StorageConfig <ovo.core.configuration.StorageConfig>`
  - ```{autodoc2-docstring} ovo.core.configuration.StorageConfig
    :summary:
    ```
* - {py:obj}`SchedulerConfig <ovo.core.configuration.SchedulerConfig>`
  - ```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig
    :summary:
    ```
* - {py:obj}`AuthConfig <ovo.core.configuration.AuthConfig>`
  - ```{autodoc2-docstring} ovo.core.configuration.AuthConfig
    :summary:
    ```
* - {py:obj}`ConfigProps <ovo.core.configuration.ConfigProps>`
  - ```{autodoc2-docstring} ovo.core.configuration.ConfigProps
    :summary:
    ```
* - {py:obj}`TemplatesConfig <ovo.core.configuration.TemplatesConfig>`
  - ```{autodoc2-docstring} ovo.core.configuration.TemplatesConfig
    :summary:
    ```
* - {py:obj}`OVOConfig <ovo.core.configuration.OVOConfig>`
  -
````

### Functions

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

* - {py:obj}`save_global_home_dir <ovo.core.configuration.save_global_home_dir>`
  - ```{autodoc2-docstring} ovo.core.configuration.save_global_home_dir
    :summary:
    ```
* - {py:obj}`get_shell_config_path <ovo.core.configuration.get_shell_config_path>`
  - ```{autodoc2-docstring} ovo.core.configuration.get_shell_config_path
    :summary:
    ```
* - {py:obj}`get_source_command <ovo.core.configuration.get_source_command>`
  - ```{autodoc2-docstring} ovo.core.configuration.get_source_command
    :summary:
    ```
* - {py:obj}`load_config <ovo.core.configuration.load_config>`
  - ```{autodoc2-docstring} ovo.core.configuration.load_config
    :summary:
    ```
* - {py:obj}`save_default_config <ovo.core.configuration.save_default_config>`
  - ```{autodoc2-docstring} ovo.core.configuration.save_default_config
    :summary:
    ```
````

### Data

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

* - {py:obj}`DEFAULT_OVO_HOME <ovo.core.configuration.DEFAULT_OVO_HOME>`
  - ```{autodoc2-docstring} ovo.core.configuration.DEFAULT_OVO_HOME
    :summary:
    ```
* - {py:obj}`GLOBAL_OVO_HOME <ovo.core.configuration.GLOBAL_OVO_HOME>`
  - ```{autodoc2-docstring} ovo.core.configuration.GLOBAL_OVO_HOME
    :summary:
    ```
* - {py:obj}`site_packages_dir <ovo.core.configuration.site_packages_dir>`
  - ```{autodoc2-docstring} ovo.core.configuration.site_packages_dir
    :summary:
    ```
* - {py:obj}`global_config_flag <ovo.core.configuration.global_config_flag>`
  - ```{autodoc2-docstring} ovo.core.configuration.global_config_flag
    :summary:
    ```
* - {py:obj}`default_data <ovo.core.configuration.default_data>`
  - ```{autodoc2-docstring} ovo.core.configuration.default_data
    :summary:
    ```
````

### API

`````{py:class} BaseConfigModel(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_nested_max_split: int | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _cli_kebab_case: bool | None = None, _cli_shortcuts: collections.abc.Mapping[str, str | list[str]] | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any)
:canonical: ovo.core.configuration.BaseConfigModel

Bases: {py:obj}`pydantic_settings.BaseSettings`

````{py:attribute} model_config
:canonical: ovo.core.configuration.BaseConfigModel.model_config
:value: >
   'SettingsConfigDict(...)'

```{autodoc2-docstring} ovo.core.configuration.BaseConfigModel.model_config
```

````

`````

`````{py:class} DBConfig
:canonical: ovo.core.configuration.DBConfig

```{autodoc2-docstring} ovo.core.configuration.DBConfig
```

````{py:attribute} url
:canonical: ovo.core.configuration.DBConfig.url
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.DBConfig.url
```

````

````{py:attribute} verbose
:canonical: ovo.core.configuration.DBConfig.verbose
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.configuration.DBConfig.verbose
```

````

`````

`````{py:class} AWSConfig
:canonical: ovo.core.configuration.AWSConfig

```{autodoc2-docstring} ovo.core.configuration.AWSConfig
```

````{py:attribute} region
:canonical: ovo.core.configuration.AWSConfig.region
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.AWSConfig.region
```

````

````{py:attribute} assume_role_arn
:canonical: ovo.core.configuration.AWSConfig.assume_role_arn
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.AWSConfig.assume_role_arn
```

````

`````

`````{py:class} StorageConfig
:canonical: ovo.core.configuration.StorageConfig

```{autodoc2-docstring} ovo.core.configuration.StorageConfig
```

````{py:attribute} path
:canonical: ovo.core.configuration.StorageConfig.path
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.StorageConfig.path
```

````

````{py:attribute} verbose
:canonical: ovo.core.configuration.StorageConfig.verbose
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.configuration.StorageConfig.verbose
```

````

````{py:attribute} aws
:canonical: ovo.core.configuration.StorageConfig.aws
:type: ovo.core.configuration.AWSConfig | None
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.StorageConfig.aws
```

````

`````

`````{py:class} SchedulerConfig
:canonical: ovo.core.configuration.SchedulerConfig

```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig
```

````{py:attribute} type
:canonical: ovo.core.configuration.SchedulerConfig.type
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig.type
```

````

````{py:attribute} name
:canonical: ovo.core.configuration.SchedulerConfig.name
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig.name
```

````

````{py:attribute} workdir
:canonical: ovo.core.configuration.SchedulerConfig.workdir
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig.workdir
```

````

````{py:attribute} aws
:canonical: ovo.core.configuration.SchedulerConfig.aws
:type: ovo.core.configuration.AWSConfig | None
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig.aws
```

````

````{py:attribute} submission_args
:canonical: ovo.core.configuration.SchedulerConfig.submission_args
:type: dict
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.SchedulerConfig.submission_args
```

````

`````

`````{py:class} AuthConfig
:canonical: ovo.core.configuration.AuthConfig

```{autodoc2-docstring} ovo.core.configuration.AuthConfig
```

````{py:attribute} admin_users
:canonical: ovo.core.configuration.AuthConfig.admin_users
:type: list[str]
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.AuthConfig.admin_users
```

````

````{py:attribute} streamlit_auth
:canonical: ovo.core.configuration.AuthConfig.streamlit_auth
:type: bool
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.AuthConfig.streamlit_auth
```

````

````{py:attribute} allow_private_project_link_access
:canonical: ovo.core.configuration.AuthConfig.allow_private_project_link_access
:type: bool
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.AuthConfig.allow_private_project_link_access
```

````

````{py:attribute} hide_admin_warning
:canonical: ovo.core.configuration.AuthConfig.hide_admin_warning
:type: bool
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.AuthConfig.hide_admin_warning
```

````

````{py:attribute} always_require_token
:canonical: ovo.core.configuration.AuthConfig.always_require_token
:type: bool
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.AuthConfig.always_require_token
```

````

`````

`````{py:class} ConfigProps
:canonical: ovo.core.configuration.ConfigProps

```{autodoc2-docstring} ovo.core.configuration.ConfigProps
```

````{py:attribute} pyrosetta_license
:canonical: ovo.core.configuration.ConfigProps.pyrosetta_license
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.configuration.ConfigProps.pyrosetta_license
```

````

````{py:attribute} read_only
:canonical: ovo.core.configuration.ConfigProps.read_only
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.configuration.ConfigProps.read_only
```

````

````{py:attribute} rfdiffusion_backbones_limit
:canonical: ovo.core.configuration.ConfigProps.rfdiffusion_backbones_limit
:type: int
:value: >
   1000

```{autodoc2-docstring} ovo.core.configuration.ConfigProps.rfdiffusion_backbones_limit
```

````

````{py:attribute} rfdiffusion_backbones_limit_admin
:canonical: ovo.core.configuration.ConfigProps.rfdiffusion_backbones_limit_admin
:type: int
:value: >
   5000

```{autodoc2-docstring} ovo.core.configuration.ConfigProps.rfdiffusion_backbones_limit_admin
```

````

````{py:attribute} mpnn_sequences_limit
:canonical: ovo.core.configuration.ConfigProps.mpnn_sequences_limit
:type: int
:value: >
   100

```{autodoc2-docstring} ovo.core.configuration.ConfigProps.mpnn_sequences_limit
```

````

`````

`````{py:class} TemplatesConfig
:canonical: ovo.core.configuration.TemplatesConfig

```{autodoc2-docstring} ovo.core.configuration.TemplatesConfig
```

````{py:attribute} welcome
:canonical: ovo.core.configuration.TemplatesConfig.welcome
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.TemplatesConfig.welcome
```

````

````{py:attribute} welcome_appendix
:canonical: ovo.core.configuration.TemplatesConfig.welcome_appendix
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.TemplatesConfig.welcome_appendix
```

````

`````

`````{py:class} OVOConfig(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_nested_max_split: int | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _cli_kebab_case: bool | None = None, _cli_shortcuts: collections.abc.Mapping[str, str | list[str]] | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any)
:canonical: ovo.core.configuration.OVOConfig

Bases: {py:obj}`ovo.core.configuration.BaseConfigModel`

````{py:attribute} dir
:canonical: ovo.core.configuration.OVOConfig.dir
:type: str
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.dir
```

````

````{py:attribute} reference_files_dir
:canonical: ovo.core.configuration.OVOConfig.reference_files_dir
:type: str
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.reference_files_dir
```

````

````{py:attribute} db
:canonical: ovo.core.configuration.OVOConfig.db
:type: ovo.core.configuration.DBConfig
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.db
```

````

````{py:attribute} auth
:canonical: ovo.core.configuration.OVOConfig.auth
:type: ovo.core.configuration.AuthConfig
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.auth
```

````

````{py:attribute} storage
:canonical: ovo.core.configuration.OVOConfig.storage
:type: ovo.core.configuration.StorageConfig
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.storage
```

````

````{py:attribute} default_scheduler
:canonical: ovo.core.configuration.OVOConfig.default_scheduler
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.default_scheduler
```

````

````{py:attribute} local_scheduler
:canonical: ovo.core.configuration.OVOConfig.local_scheduler
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.local_scheduler
```

````

````{py:attribute} schedulers
:canonical: ovo.core.configuration.OVOConfig.schedulers
:type: dict[str, ovo.core.configuration.SchedulerConfig]
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.schedulers
```

````

````{py:attribute} nextflow_home
:canonical: ovo.core.configuration.OVOConfig.nextflow_home
:type: str
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.nextflow_home
```

````

````{py:attribute} templates
:canonical: ovo.core.configuration.OVOConfig.templates
:type: ovo.core.configuration.TemplatesConfig
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.templates
```

````

````{py:attribute} props
:canonical: ovo.core.configuration.OVOConfig.props
:type: ovo.core.configuration.ConfigProps
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.props
```

````

````{py:method} resolve_relative_paths()
:canonical: ovo.core.configuration.OVOConfig.resolve_relative_paths

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.resolve_relative_paths
```

````

````{py:method} default(props: ovo.core.configuration.ConfigProps, default_profile=None, admin_users: list[str] = None) -> str
:canonical: ovo.core.configuration.OVOConfig.default
:classmethod:

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.default
```

````

````{py:method} default_nextflow_config()
:canonical: ovo.core.configuration.OVOConfig.default_nextflow_config
:staticmethod:

```{autodoc2-docstring} ovo.core.configuration.OVOConfig.default_nextflow_config
```

````

`````

````{py:data} DEFAULT_OVO_HOME
:canonical: ovo.core.configuration.DEFAULT_OVO_HOME
:value: >
   'abspath(...)'

```{autodoc2-docstring} ovo.core.configuration.DEFAULT_OVO_HOME
```

````

````{py:data} GLOBAL_OVO_HOME
:canonical: ovo.core.configuration.GLOBAL_OVO_HOME
:value: >
   None

```{autodoc2-docstring} ovo.core.configuration.GLOBAL_OVO_HOME
```

````

````{py:data} site_packages_dir
:canonical: ovo.core.configuration.site_packages_dir
:value: >
   'dirname(...)'

```{autodoc2-docstring} ovo.core.configuration.site_packages_dir
```

````

````{py:data} global_config_flag
:canonical: ovo.core.configuration.global_config_flag
:value: >
   'join(...)'

```{autodoc2-docstring} ovo.core.configuration.global_config_flag
```

````

````{py:data} default_data
:canonical: ovo.core.configuration.default_data
:value: >
   'safe_load(...)'

```{autodoc2-docstring} ovo.core.configuration.default_data
```

````

````{py:function} save_global_home_dir(home_dir: str)
:canonical: ovo.core.configuration.save_global_home_dir

```{autodoc2-docstring} ovo.core.configuration.save_global_home_dir
```
````

````{py:function} get_shell_config_path()
:canonical: ovo.core.configuration.get_shell_config_path

```{autodoc2-docstring} ovo.core.configuration.get_shell_config_path
```
````

````{py:function} get_source_command()
:canonical: ovo.core.configuration.get_source_command

```{autodoc2-docstring} ovo.core.configuration.get_source_command
```
````

````{py:function} load_config(home_dir: str) -> ovo.core.configuration.OVOConfig
:canonical: ovo.core.configuration.load_config

```{autodoc2-docstring} ovo.core.configuration.load_config
```
````

````{py:function} save_default_config(home_dir, config_props: ovo.core.configuration.ConfigProps, default_profile: str = None, admin_users: list[str] = None) -> str
:canonical: ovo.core.configuration.save_default_config

```{autodoc2-docstring} ovo.core.configuration.save_default_config
```
````