ascat.grids package

Submodules

ascat.grids.grid_registry module

class ascat.grids.grid_registry.GridRegistry

Bases: object

get(grid_name)

Retrieve a grid instance based on its name.

The grid name can be a simple name (e.g. “fibgrid”) or a more complex name with parameters (e.g. “fibgrid_0.1”). The latter will be split into the grid type and its parameters.

Parameters:

(str) (grid_name) –

register(grid_type_name: str, grid_class: type)

Register a grid class with a name for later retrieval.

e.g. register(“fibgrid”, FibGrid) or register(“named”, NamedFileGrid)

class ascat.grids.grid_registry.GridSingleton(*args, **kwargs)

Bases: object

grid

class ascat.grids.grid_registry.GridType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

FIBGRID = 'fibgrid'

NAMED = 'named'

class ascat.grids.grid_registry.NamedFileGrid(grid_name: str)

Bases: object

class ascat.grids.grid_registry.NamedFileGridRegistry

Bases: object

classmethod get(grid_name: str) → str

Retrieve the file path for a registered grid.

classmethod register(grid_name: str, grid_path: str) → None

Register a named grid with its file path.

class ascat.grids.grid_registry.SingletonArgs

Bases: type

Module contents