get_example_inventory

function of dascore.examples source

get_example_inventory(
    example_name = random_das,
    **kwargs ,
)-> ‘Inventory’

Load an example Inventory.

Supported example inventories are:

Name Description
random_das A single-path inventory which resolves the random_das example patch.
tunnel The tunnel deployment the tunnel recipe builds, read from its files.

Parameters

Parameter Description
example_name The name of the example to load. Options are listed above.
**kwargs Passed to the corresponding functions to generate the inventory.

Raises

(UnknownExampleError)[’dascore.examples.UnknownExampleError`] if an unregistered inventory is requested.

Examples

import dascore as dc
inventory = dc.get_example_inventory("tunnel")
len(inventory.networks)
1