get_star#

eclypse.builders.infrastructure.generators.star.get_star(n_clients, infrastructure_id='star', symmetric=False, update_policies=None, node_assets=None, link_assets=None, center_assets_values=None, outer_assets_values=None, include_default_assets=False, strict=False, resource_init='min', path_algorithm=None, seed=None)[source]#

Create a star infrastructure with n_clients clients around a central node.

The group of the clients can be specified.

Parameters:

  • n_clients (int) – The number of clients in the infrastructure.

  • infrastructure_id (str) – The ID of the infrastructure.

  • symmetric (bool) – Whether the links are symmetric. Defaults to False.

  • update_policies (Callable | list[Callable] | None) – Graph update policies. Defaults to None.

  • node_assets (dict[str, Asset] | None) – The assets for the nodes. Defaults to None.

  • link_assets (dict[str, Asset] | None) – The assets for the links. Defaults to None.

  • center_assets_values (dict[str, Any] | None) – The assets for the center node. Defaults to None.

  • outer_assets_values (dict[str, Any] | None) – The assets for the outer nodes. Defaults to None.

  • include_default_assets (bool) – Whether to include the default assets. Defaults to False.

  • strict (bool) – If True, raises an error if the asset values are not consistent with their spaces. Defaults to False.

  • resource_init (InitPolicy) – The initialization policy for the resources. Defaults to “min”.

  • path_algorithm (Callable[[nx.Graph, str, str], list[str]] | None) – The algorithm to compute the paths between nodes. Defaults to None.

  • seed (int | None) – The seed for the random number generator. Defaults to None.

Returns:

The star infrastructure.

Return type:

Infrastructure

On this page