Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: topo_file->topo + mention support for dataset folders #78

Merged
merged 3 commits into from
Jan 10, 2025
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 33 additions & 6 deletions src/pyaro/timeseries/Filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -1208,21 +1208,48 @@ def filter_stations(self, stations: dict[str, Station]) -> dict[str, Station]:
@registered_filter
class ValleyFloorRelativeAltitudeFilter(StationFilter):
"""
:param topo_file: Topography file path. Must be a dataset openable by xarray, with latitude
and longitude stored as "lat" and "lon" respectively. The variable that contains elevation
data is assumed to be in meters.
:param topo: Topography file path (either a file or a directory). Must be a dataset openable by
xarray, with latitude and longitude stored as "lat" and "lon" respectively. The variable
that contains elevation data is assumed to be in meters. If `topo` is a directory, a
metadata.json file containing the geographic bounds of each file must be present (see below
for example).
:param radius: Radius (in meters)
:param topo_var: Variable name to use in topography dataset
:param lower: Optional lower bound needed for relative altitude for station to be kept (in meters)
:param upper: Optional upper bound needed for relative altitude for station to be kept (in meters)
:raises ModuleNotFoundError: If necessary optional dependencies are not available.
:raises ModuleNotFoundError: If necessary required additional dependencies (cf_units, xarray) are
not available.

Note
----
This implementation is only tested with GTOPO30 dataset to far.

Available versions can be found here:
/lustre/storeB/project/aerocom/aerocom1/AEROCOM_OBSDATA/GTOPO30/
Available versions of gtopo30 can be found here:
`/lustre/storeB/project/aerocom/aerocom1/AEROCOM_OBSDATA/GTOPO30/`

Note
----
metadata.json should contain a mapping from each nc file, to it's geographic latitude/longitude
bounds.

For example:

```
{
"N.nc": {
"w": -180,
"e": 180,
"n": 90,
"s": -10
},
"S.nc": {
"w": -180,
"e": 180,
"n": -10,
"s": -90
}
}
```
"""

def __init__(
Expand Down
Loading