# {py:mod}`simvx.core.project`

```{py:module} simvx.core.project
```

```{autodoc2-docstring} simvx.core.project
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ProjectSettings <simvx.core.project.ProjectSettings>`
  - ```{autodoc2-docstring} simvx.core.project.ProjectSettings
    :summary:
    ```
````

### Functions

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

* - {py:obj}`load_project <simvx.core.project.load_project>`
  - ```{autodoc2-docstring} simvx.core.project.load_project
    :summary:
    ```
* - {py:obj}`save_project <simvx.core.project.save_project>`
  - ```{autodoc2-docstring} simvx.core.project.save_project
    :summary:
    ```
* - {py:obj}`boot_project <simvx.core.project.boot_project>`
  - ```{autodoc2-docstring} simvx.core.project.boot_project
    :summary:
    ```
````

### Data

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

* - {py:obj}`log <simvx.core.project.log>`
  - ```{autodoc2-docstring} simvx.core.project.log
    :summary:
    ```
* - {py:obj}`__all__ <simvx.core.project.__all__>`
  - ```{autodoc2-docstring} simvx.core.project.__all__
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.core.project.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.project.log
```

````

````{py:data} __all__
:canonical: simvx.core.project.__all__
:value: >
   ['ProjectSettings', 'load_project', 'save_project']

```{autodoc2-docstring} simvx.core.project.__all__
```

````

`````{py:class} ProjectSettings(data: dict[str, typing.Any] | None = None)
:canonical: simvx.core.project.ProjectSettings

```{autodoc2-docstring} simvx.core.project.ProjectSettings
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.project.ProjectSettings.__init__
```

````{py:method} to_dict() -> dict[str, typing.Any]
:canonical: simvx.core.project.ProjectSettings.to_dict

```{autodoc2-docstring} simvx.core.project.ProjectSettings.to_dict
```

````

````{py:method} get_project_dir() -> str
:canonical: simvx.core.project.ProjectSettings.get_project_dir

```{autodoc2-docstring} simvx.core.project.ProjectSettings.get_project_dir
```

````

````{py:method} resolve_path(relative: str) -> str
:canonical: simvx.core.project.ProjectSettings.resolve_path

```{autodoc2-docstring} simvx.core.project.ProjectSettings.resolve_path
```

````

````{py:method} apply_input_actions()
:canonical: simvx.core.project.ProjectSettings.apply_input_actions

```{autodoc2-docstring} simvx.core.project.ProjectSettings.apply_input_actions
```

````

`````

````{py:function} load_project(path: str | pathlib.Path) -> simvx.core.project.ProjectSettings
:canonical: simvx.core.project.load_project

```{autodoc2-docstring} simvx.core.project.load_project
```
````

````{py:function} save_project(settings: simvx.core.project.ProjectSettings, path: str | pathlib.Path | None = None) -> None
:canonical: simvx.core.project.save_project

```{autodoc2-docstring} simvx.core.project.save_project
```
````

````{py:function} boot_project(path: str | pathlib.Path) -> simvx.core.project.ProjectSettings
:canonical: simvx.core.project.boot_project

```{autodoc2-docstring} simvx.core.project.boot_project
```
````