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
Metadata
1 maintainer
Release files for xhycom 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| xhycom-0.2.0.tar.gz | 12.7 MB | With provenance | Details for xhycom-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| xhycom-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for xhycom-0.2.0-py3-none-any.whl |
Total release size: 12.8 MB
Release files / xhycom-0.2.0.tar.gz
| Download URL | xhycom-0.2.0.tar.gz |
|---|---|
| Size | 12.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9497c7a07ec234599d194bbdba7a588634f3c08dc94a1183722043d8c0be2aa5
|
|
BLAKE2b-256 checksum How to use checksums |
ae4e3b5517da977eb5d2ccc324a6282d4c874b6dfdda74dc7d23a681b1af0059
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 13, 2026.
Transparency logRelease files / xhycom-0.2.0-py3-none-any.whl
| Download URL | xhycom-0.2.0-py3-none-any.whl |
|---|---|
| Size | 72.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed305950bd860b823778db0c58a64ecb90daa3c8e0ccfc7c9594403934ea9bff
|
|
BLAKE2b-256 checksum How to use checksums |
3ff2acf9074b4ba4994a9405fa978b416f814c62f05f51a0d83474b53fe9b85c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 13, 2026.
Transparency logSecurity for xhycom 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for xhycom-0.2.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
