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

Update nwm_client_new routelink source for NWM v3.0 expanded domain #249

Merged
merged 7 commits into from
Mar 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions python/nwm_client_new/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,31 @@ The following example demonstrates how one might use `hydrotools.nwm_client_new`

### Code

<details><summary><b>View compatible configurations</b></summary>

```python
# Import the NWM Client
from hydrotools.nwm_client_new.NWMFileClient import NWMFileClient

# Instantiate model data client
model_data_client = NWMFileClient()

# Print compatible model configurations
# Note that not all data sources contain the full range of available
# National Water Model data. This client defaults to Google Cloud Platform
# Which has the largest amount of *operational* forecast data.
# Also note that not all configurations are available for the entire
# archive of NWM operational forecast data. For example, the configurations
# for Alaska only became available after August 2023.
print(model_data_client.catalog.configurations)
```
### Example output
```console
['analysis_assim', 'analysis_assim_alaska', 'analysis_assim_alaska_no_da', 'analysis_assim_extend', 'analysis_assim_extend_no_da', 'analysis_assim_extend_alaska', 'analysis_assim_extend_alaska_no_da', 'analysis_assim_hawaii', 'analysis_assim_hawaii_no_da', 'analysis_assim_no_da', 'analysis_assim_puertorico', 'analysis_assim_puertorico_no_da', 'analysis_assim_long', 'analysis_assim_long_no_da', 'long_range_mem1', 'long_range_mem2', 'long_range_mem3', 'long_range_mem4', 'medium_range_alaska_mem1', 'medium_range_alaska_mem2', 'medium_range_alaska_mem3', 'medium_range_alaska_mem4', 'medium_range_alaska_mem5', 'medium_range_alaska_mem6', 'medium_range_alaska_no_da', 'medium_range_mem1', 'medium_range_mem2', 'medium_range_mem3', 'medium_range_mem4', 'medium_range_mem5', 'medium_range_mem6', 'medium_range_mem7', 'medium_range_no_da', 'short_range', 'short_range_alaska', 'short_range_hawaii', 'short_range_hawaii_no_da', 'short_range_puertorico', 'short_range_puertorico_no_da']
```

</details>

<details><summary><b>Retrieving data from google cloud</b></summary>

```python
Expand Down
1 change: 1 addition & 0 deletions python/nwm_client_new/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ install_requires =
planetary-computer
adlfs
hydrotools._restclient
dask[dataframe]
python_requires = >=3.8
include_package_data = True

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class NWMClientDefaults:
)
CATALOG: NWMFileCatalog = GCPFileCatalog()
SSL_CONTEXT: ssl.SSLContext = ssl.create_default_context()
ROUTELINK_URL: str = "https://www.hydroshare.org/resource/b5f58460941c49578e311adb9823657a/data/contents/RouteLink.h5"
ROUTELINK_URL: str = "https://www.hydroshare.org/resource/e9fe66730d184bdfbaea19639bd7cb55/data/contents/RouteLink.h5"
VARIABLES: List[str] = field(default_factory=lambda: ["streamflow"])
NWM_TO_SI_UNIT_MAPPING: Dict[str, str] = field(default_factory=lambda: {"m": "m", "m s-1": "m/s", "m3 s-1": "m^3/s"})
SI_TO_US_UNIT_MAPPING: Dict[str, str] = field(default_factory=lambda: {"m": "ft", "m/s": "ft/s", "m^3/s": "ft^3/s"})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,30 +82,42 @@ def list_blobs(
def configurations(self) -> List[str]:
return [
'analysis_assim',
'analysis_assim_alaska',
'analysis_assim_alaska_no_da',
'analysis_assim_extend',
'analysis_assim_extend_no_da',
'analysis_assim_extend_alaska',
'analysis_assim_extend_alaska_no_da',
'analysis_assim_hawaii',
'analysis_assim_long',
'analysis_assim_hawaii_no_da',
'analysis_assim_no_da',
'analysis_assim_puertorico',
'analysis_assim_puertorico_no_da',
'analysis_assim_long',
'analysis_assim_long_no_da',
'long_range_mem1',
'long_range_mem2',
'long_range_mem3',
'long_range_mem4',
'medium_range_alaska_mem1',
'medium_range_alaska_mem2',
'medium_range_alaska_mem3',
'medium_range_alaska_mem4',
'medium_range_alaska_mem5',
'medium_range_alaska_mem6',
'medium_range_alaska_no_da',
'medium_range_mem1',
'medium_range_mem2',
'medium_range_mem3',
'medium_range_mem4',
'medium_range_mem5',
'medium_range_mem6',
'medium_range_mem7',
'medium_range_no_da',
'short_range',
'short_range_alaska',
'short_range_hawaii',
'short_range_puertorico',
'analysis_assim_no_da',
'analysis_assim_extend_no_da',
'analysis_assim_hawaii_no_da',
'analysis_assim_long_no_da',
'analysis_assim_puertorico_no_da',
'medium_range_no_da',
'short_range_hawaii_no_da',
'short_range_puertorico_no_da'
'short_range_puertorico',
'short_range_puertorico_no_da',
]
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "7.3.0"
__version__ = "7.4.0"
2 changes: 1 addition & 1 deletion python/nwm_client_new/tests/test_NWMClient.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Set reference time
yesterday = pd.Timestamp.utcnow() - pd.Timedelta("1D")
reference_time_gcp = yesterday.strftime("%Y%m%dT%-HZ")
reference_time_http = (yesterday+pd.Timedelta("1H")).strftime("%Y%m%dT%-HZ")
reference_time_http = pd.Timestamp.utcnow() - pd.Timedelta("1D")

# Canonical columns
canonical_columns = [
Expand Down