Skip to content

grasp.instrument.photometer

grasp.instrument.photometer.photometer_geoms

PathLike module-attribute

PathLike = Union[str, Path]

PhotometerLevel

Bases: Enum

L1 class-attribute instance-attribute

L1 = 'L1'

L2 class-attribute instance-attribute

L2 = 'L2'

list_files_in_archive

list_files_in_archive(archive_path: Optional[PathLike] = None) -> List[str]

load_photometer_geoms

load_photometer_geoms(site_name: str, level: PhotometerLevel, start_date: Optional[Union[str, date]] = None, end_date: Optional[Union[str, date]] = None, base_path: Optional[PathLike] = None) -> xr.Dataset

Used to easily load photometer GEOMS files stored on the cloud server's archive without needing to know where to find it.

Parameters:

Name Type Description Default
site_name str

Full name of the site you are looking for.

required
level PhotometerLevel

Level of the data, from the ones enumerated in PhotometerLevel.

required
start_date Optional[Union[str, date]]

Measurement start date of the data you are looking for.

None
end_date Optional[Union[str, date]]

Measurement end date of the data you are looking for.

None
base_path Optional[PathLike]

Default is the photometer geoms path on the cloud server, can be adjusted if needed.

None

Returns:

Type Description
Dataset

An xarray.Datset of the data in the loaded GEOMS file.

find_photometer_archive_dates

find_photometer_archive_dates(site_name: str, level: PhotometerLevel, start_date: Optional[Union[str, date]] = None, end_date: Optional[Union[str, date]] = None, base_path: Optional[PathLike] = None) -> List[datetime.date]