ersilia.setup.requirements package

Submodules

ersilia.setup.requirements.conda module

class ersilia.setup.requirements.conda.CondaRequirement[source]

Bases: object

A class to handle the installation and checking of the Conda package manager.

is_installed()[source]

Checks if Conda is installed.

install()[source]

Placeholder for installing Conda.

install() → None[source]

Placeholder for installing Conda.

Return type:

None

is_installed() → bool[source]

Checks if Conda is installed.

Returns:

True if Conda is installed, False otherwise.

Return type:

bool

ersilia.setup.requirements.docker module

class ersilia.setup.requirements.docker.DockerRequirement[source]

Bases: object

A class to handle the checking and management of Docker.

is_inside_docker()[source]

Checks if the current environment is inside a Docker container.

is_working()[source]

Checks if Docker is working by running a test container.

is_logged_in()[source]

Checks if Docker is logged in.

is_active()[source]

Checks if Docker is active.

is_installed()[source]

Checks if Docker is installed.

is_active() → bool[source]

Checks if Docker is active.

Returns:

True if Docker is active, False otherwise.

Return type:

bool

is_inside_docker() → bool[source]

Checks if the current environment is inside a Docker container.

Returns:

True if inside a Docker container, False otherwise.

Return type:

bool

is_installed() → bool[source]

Checks if Docker is installed.

Returns:

True if Docker is installed, False otherwise.

Return type:

bool

is_logged_in() → bool[source]

Checks if Docker is logged in.

Returns:

True if Docker is logged in, False otherwise.

Return type:

bool

is_working() → bool[source]

Checks if Docker is working by running a test container.

Returns:

True if Docker is working, False otherwise.

Return type:

bool

ersilia.setup.requirements.eospath module

class ersilia.setup.requirements.eospath.EosHomePathRequirement[source]

Bases: object

A class to check the existence of the EOS home path.

eos_home_path_exists()[source]

Checks if the EOS home path exists.

eos_home_path_exists() → bool[source]

Checks if the EOS home path exists.

Returns:

True if the EOS home path exists, False otherwise.

Return type:

bool

ersilia.setup.requirements.git module

class ersilia.setup.requirements.git.EosvcRequirement[source]

Bases: object

A class to handle checking and installing eosvc in the active Python environment.

ensure_installed() → bool[source]

Ensure eosvc is available in the active Python environment.

install() → bool[source]

Install eosvc into the active Python environment.

is_installed() → bool[source]

Check whether eosvc is importable in the active environment.

class ersilia.setup.requirements.git.GitLfsRequirement[source]

Bases: object

A class to handle the checking and installation of Git LFS.

is_installed(install_if_necessary=True)[source]

Checks if Git LFS is installed.

activate()[source]

Activates Git LFS.

install()[source]

Installs Git LFS.

activate() → None[source]

Activates Git LFS.

This method runs the Git LFS install command.

Return type:

None

install() → None[source]

Installs Git LFS.

This method installs Git LFS using conda.

Return type:

None

is_installed(install_if_necessary=True) → bool[source]

Checks if Git LFS is installed.

Parameters:

install_if_necessary (bool, optional) – Whether to install Git LFS if it is not installed (default is True).

Returns:

True if Git LFS is installed, False otherwise.

Return type:

bool

class ersilia.setup.requirements.git.GithubCliRequirement[source]

Bases: object

A class to handle the checking and installation of the GitHub CLI.

is_installed(raise_exception=False, install_if_necessary=False)[source]

Checks if the GitHub CLI is installed.

install()[source]

Installs the GitHub CLI.

install() → None[source]

Installs the GitHub CLI.

This method installs the GitHub CLI using conda.

Return type:

None

is_installed(raise_exception=False, install_if_necessary=False) → bool[source]

Checks if the GitHub CLI is installed.

Parameters:

  • raise_exception (bool, optional) – Whether to raise an exception if the GitHub CLI is not installed (default is False).

  • install_if_necessary (bool, optional) – Whether to install the GitHub CLI if it is not installed (default is False).

Returns:

True if the GitHub CLI is installed, False otherwise.

Return type:

bool

ersilia.setup.requirements.ping module

class ersilia.setup.requirements.ping.PingRequirement[source]

Bases: object

A class to check internet connectivity.

is_connected()[source]

Checks if the system is connected to the internet.

is_connected() → bool[source]

Checks if the system is connected to the internet.

Returns:

True if the system is connected to the internet, False otherwise.

Return type:

bool

ersilia.setup.requirements.setuptools_req module

ersilia.setup.requirements.setuptools_req.verify_setuptools()[source]

Module contents