nimphs.operators

Packages

• nimphs.operators.openfoam
• nimphs.operators.shared
• nimphs.operators.telemac
• nimphs.operators.utils

Modules

nimphs.operators.installer

class NIMPHS_OT_Installer

Bases: Operator

Run installation from the installation panel located into Add-on's preferences.

bl_description: Union[str, Any] = 'Run the installation process depending on the chosen configuration'

typing.Union[str, typing.Any]

Type

type

bl_idname: Union[str, Any] = 'nimphs.install'

typing.Union[str, typing.Any]

Type

type

bl_label: Union[str, Any] = 'Install'

typing.Union[str, typing.Any]

Type

type

execute(context: Context) → set

Run installation process.

Parameters

context (Context) -- context

Returns

state of the operator

Return type

set

install_package(package: str, force: bool = False) → None

Install the given python package.

Parameters

• package (str) -- name of the python package.

• force (bool, optional) -- force reinstall. Defaults to False.

install_requirements(requirements: str, force: bool = False) → None

Install python packages from the given requirements file.

Parameters

• requirements (str) -- path to the requirements file.

• force (bool, optional) -- force reinstall. Defaults to False.

is_custom_base_cls = False

register_cls = False

class NIMPHS_OT_ResetInstaller

Bases: Operator

Reset installer state to let the user install dependencies again.

bl_description: Union[str, Any] = 'Reset installer state so you can install dependencies again'

typing.Union[str, typing.Any]

Type

type

bl_idname: Union[str, Any] = 'nimphs.reset_installer'

typing.Union[str, typing.Any]

Type

type

bl_label: Union[str, Any] = 'Reset installer'

typing.Union[str, typing.Any]

Type

type

execute(context: Context) → set

Reset installer state.

Parameters

context (Context) -- context

Returns

state of the operator

Return type

set

is_custom_base_cls = False

register_cls = True