tiled.client.from_catalog¶
- tiled.client.from_catalog(catalog, authentication=None, server_settings=None, structure_clients='numpy', *, cache=None, offline=False, username=None, special_clients=None, token_cache='/home/runner/.config/tiled/tokens')[source]¶
Connect to a Catalog directly, running the app in this same process.
NOTE: This is experimental. It may need to be re-designed or even removed.
In this configuration, we are using the server, but we are communicating with it directly within this process, not over a local network. It is generally faster.
Specifically, we are using HTTP over ASGI rather than HTTP over TCP. There are no sockets or network-related syscalls.
- Parameters
- catalogCatalog
- authenticationdict, optional
Dict of authentication configuration.
- usernamestr, optional
Username for authenticated access.
- structure_clientsstr or dict, optional
Use “dask” for delayed data loading and “numpy” for immediate in-memory structures (e.g. normal numpy arrays, pandas DataFrames). For advanced use, provide dict mapping structure_family names (“array”, “dataframe”, “variable”, “data_array”, “dataset”) to client objects. See
Catalog.DEFAULT_STRUCTURE_CLIENT_DISPATCH.- cacheCache, optional
- offlinebool, optional
False by default. If True, rely on cache only.
- special_clientsdict, optional
Advanced: Map client_type_hint from the server to special client catalog objects. See also
Catalog.discover_special_clients()andCatalog.DEFAULT_SPECIAL_CLIENT_DISPATCH.- token_cachestr, optional
Path to directory for storing refresh tokens.