pycsamt.api.view.survey#

Public survey view over EDI collections.

Classes

APISurvey([collection, name, source, ...])

Friendly public facade over an EDICollection.
class pycsamt.api.view.survey.APISurvey(collection=None, *, name=None, source=None, parser=None, meta=None)[source]#

Bases: PyCSAMTObject

Friendly public facade over an EDICollection.

Parameters:
property n_sites: int[source]#

Return number of loaded sites.

property stations: list[str][source]#

Return station names.

property paths: list[str][source]#

Return source paths for loaded stations.

property df: APIFrame[source]#

Return the default summary table.

property data: Any[source]#

Return the underlying EDI collection.

summary(*, fields=None)[source]#

Return an editable APIFrame summary of loaded EDI files.

Parameters:

fields (Sequence[str] | None)

Return type:

APIFrame

errors()[source]#

Return parser errors from the last read operation.

Return type:

list[tuple[Any, BaseException]]

get_site(site, default=None)[source]#

Return one site by station, stem, filename, or path.

Parameters:
Return type:

Any

to_dataframe(*args, api=True, **kwargs)[source]#

Return collection dataframe output, wrapped by default.

Parameters:
to_collection()[source]#

Return the underlying collection.

Return type:

Any

update_meta(**kwargs)[source]#

Update metadata in-place and return self.

Parameters:

kwargs (Any)

Return type:

APISurvey

summary_text()[source]#

Return a compact survey display.

Return type:

str