Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change log

## Unreleased

* Add missing `offline.cache` key to TOML config.

## [v1.1.0](https://github.com/simvue-io/client/releases/tag/v1.1.0) - 2024-10-21

* Add option to specify a callback executed when an alert is triggered for a run.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ _Simvue_ Python API utilises the [Ruff](https://github.com/astral-sh/ruff) linte

## :book: Documentation

To ensure functions, methods and classes are documented appropriately _Simvue_ Python API follows the Numpy docstring convention. We also ask that if adding new features you ensure these are mentioned within the official [documentation](https://github.com/simvue-io/docs).
To ensure functions, methods and classes are documented appropriately _Simvue_ Python API follows the Numpy docstring convention. We also ask that if adding new features you ensure these are mentioned within the official [documentation](https://github.com/simvue-io/docs).
4 changes: 4 additions & 0 deletions simvue/config/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ def check_valid_server(cls, values: "ServerSpecifications") -> bool:
return values


class OfflineSpecifications(pydantic.BaseModel):
cache: typing.Optional[pathlib.Path] = None


class DefaultRunSpecifications(pydantic.BaseModel):
name: typing.Optional[str] = None
description: typing.Optional[str] = None
Expand Down
2 changes: 2 additions & 0 deletions simvue/config/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
ClientGeneralOptions,
DefaultRunSpecifications,
ServerSpecifications,
OfflineSpecifications,
)

logger = logging.getLogger(__name__)
Expand All @@ -38,6 +39,7 @@ class SimvueConfiguration(pydantic.BaseModel):
..., description="Specifications for Simvue server"
)
run: DefaultRunSpecifications = DefaultRunSpecifications()
offline: OfflineSpecifications = OfflineSpecifications()

@classmethod
def _parse_ini_config(cls, ini_file: pathlib.Path) -> dict[str, dict[str, str]]:
Expand Down