xhycom
xhycom reads HYCOM model output in the native .ab format directly into xarray Datasets, with coordinates, units, and lazy out-of-memory access attached automatically.
Installation
conda (recommended, includes xESMF for horizontal regridding):
conda install -c conda-forge xhycom
pip (xESMF must come from conda-forge, so create a conda env with it first):
conda create -n hycom-env -c conda-forge xesmf
conda activate hycom-env
pip install xhycom
From GitHub (latest unreleased, clone and install in editable mode):
git clone https://github.com/nansencenter/xhycom.git
cd xhycom
conda env create -f ci/environment-regrid.yml
conda activate hycom-analysis-env
See Installation for details, including setup on the Olivia and Betzy HPC clusters.
Quick example
import xhycom
# Single snapshot: auto-detects file type, attaches lon/lat/time/dens
ds = xhycom.open_dataset("archv.2020_001_00", grid="regional.grid")
ds["temp"].isel(time=0, k=0).plot()
# Multi-year time series: lazy, out-of-memory, no data loaded until .compute()
ds = xhycom.open_mfdataset("data/", grid="regional.grid", chunks={"time": 1})
ds["temp"].isel(k=0).mean("time").compute()
Documentation
Full documentation (why xarray, worked examples, API reference) is at https://xhycom.readthedocs.io.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xhycom-0.2.0.tar.gz.
File metadata
- Download URL: xhycom-0.2.0.tar.gz
- Upload date:
- Size: 12.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9497c7a07ec234599d194bbdba7a588634f3c08dc94a1183722043d8c0be2aa5
|
|
| MD5 |
a262a99c1a1915becb8b4897e754aa10
|
|
| BLAKE2b-256 |
ae4e3b5517da977eb5d2ccc324a6282d4c874b6dfdda74dc7d23a681b1af0059
|
Provenance
The following attestation bundles were made for xhycom-0.2.0.tar.gz:
Publisher:
publish.yml on nansencenter/xhycom
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
xhycom-0.2.0.tar.gz -
Subject digest:
9497c7a07ec234599d194bbdba7a588634f3c08dc94a1183722043d8c0be2aa5 - Sigstore transparency entry: 2450832056
- Sigstore integration time:
-
Permalink:
nansencenter/xhycom@7e9c4bee0102abbdabba00f868f65aa252ef8c3f -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/nansencenter
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7e9c4bee0102abbdabba00f868f65aa252ef8c3f -
Trigger Event:
release
-
Statement type:
File details
Details for the file xhycom-0.2.0-py3-none-any.whl.
File metadata
- Download URL: xhycom-0.2.0-py3-none-any.whl
- Upload date:
- Size: 72.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ed305950bd860b823778db0c58a64ecb90daa3c8e0ccfc7c9594403934ea9bff
|
|
| MD5 |
fb235747641b338c748c247e571937a3
|
|
| BLAKE2b-256 |
3ff2acf9074b4ba4994a9405fa978b416f814c62f05f51a0d83474b53fe9b85c
|
Provenance
The following attestation bundles were made for xhycom-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on nansencenter/xhycom
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
xhycom-0.2.0-py3-none-any.whl -
Subject digest:
ed305950bd860b823778db0c58a64ecb90daa3c8e0ccfc7c9594403934ea9bff - Sigstore transparency entry: 2450832067
- Sigstore integration time:
-
Permalink:
nansencenter/xhycom@7e9c4bee0102abbdabba00f868f65aa252ef8c3f -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/nansencenter
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@7e9c4bee0102abbdabba00f868f65aa252ef8c3f -
Trigger Event:
release
-
Statement type:
