system

check

check(outer=None)

Performs OakVar system checkup.

PARAMETER	DESCRIPTION
`outer`	DEFAULT: `None`

RETURNS	DESCRIPTION
`bool`	True if all tests passed. False if not.

md

md(directory=None)

Gets or sets OakVar modules directory.

PARAMETER	DESCRIPTION
`directory`	Path to a new OakVar modules directory. If given, OakVar modules directory will be set to this value. TYPE: `Optional[Union[Path, str]]` DEFAULT: `None`

RETURNS	DESCRIPTION
`Optional[Path]`	Path of the new or existing OakVar modules directory. `None` if `directory` is not given and an OakVar modules directory is not defined in the system configuration.

setup

setup(
    clean=False,
    refresh_db=False,
    clean_cache_files=False,
    setup_file=None,
    email="",
    pw="",
    create_account=False,
    custom_system_conf=None,
    publish_time="",
    outer=None,
    system_worker_state=None,
    sg_mode=False,
)

setup.

PARAMETER	DESCRIPTION
`clean`	Perform clean installation. Installed modules and analysis results are not erased. TYPE: `bool` DEFAULT: `False`
`refresh_db`	Refreshes store server data. TYPE: `bool` DEFAULT: `False`
`clean_cache_files`	Cleans store cache files. TYPE: `bool` DEFAULT: `False`
`setup_file`	Path to a custom system configuration file. If given, the system configuraton from this file will be used instead of default system configuratoin values. TYPE: `Optional[Union[Path, str]]` DEFAULT: `None`
`email`	OakVar store account Email TYPE: `Optional[str]` DEFAULT: `''`
`pw`	OakVar store account password TYPE: `Optional[str]` DEFAULT: `''`
`custom_system_conf`	Custom system configuration as a Dict TYPE: `Optional[Dict]` DEFAULT: `None`
`publish_time`	publish_time TYPE: `str` DEFAULT: `''`
`system_worker_state`	DEFAULT: `None`
`outer`	DEFAULT: `None`