ras-commander-fast-dss
A native HEC-DSS engine for Python, written in Rust. It reads and writes DSS version 6 and version 7 files (catalogs, regular and irregular time series, paired data, grids, profiles and location records) without Java, HEC Monolith or any HEC native library. It also imports gridded data (GRIB2, NetCDF, GeoTIFF/ASCII rasters and Zarr v2) into DSS grids, the job HEC-Vortex does for HEC-HMS and HEC-RAS.
ras-commander-fast-dss is the DSS backend of
RAS Commander and hms-commander. It is called
FAST-DSS on the RAS Commander website.
pip install ras-commander-fast-dss
Wheels are abi3 (one wheel covers CPython 3.10 and later) for Windows x86_64 and for Linux x86_64 and aarch64 (manylinux and musllinux). There are no macOS wheels, and CI does not build or test on macOS. macOS users, and other platforms, can build the source distribution with a Rust toolchain; the build has no C dependencies.
Quick example
import numpy as np
import ras_commander_fast_dss as dss
with dss.open("model.dss") as f:
print(f.version, f.version_string) # 7 '7-IU'
catalog = f.catalog() # DataFrame, one row per record
flow = f.read_timeseries("/BASIN/LOC/FLOW//1HOUR/OBS/")
rating = dss.read_paired_data("model.dss", "/BASIN/LOC/STAGE-FLOW///RATING/")
grid = dss.read_grid("model.dss", "/SHG/BASIN/PRECIP/01JAN2020:0000/01JAN2020:0100/RADAR/")
# Write a regular time series into a new DSS7 file.
dss.create("out.dss", version=7)
dss.write_timeseries(
"out.dss",
"/BASIN/LOC/FLOW/01JAN2020/1HOUR/SIM/",
np.array([10.0, 12.5, 15.0]),
start="2020-01-01 01:00",
units="CFS",
data_type="INST-VAL",
)
Time series come back as pandas DataFrames with HEC missing markers mapped to NaN; paired data
and grids come back as NumPy arrays with their metadata. Errors are typed
(ras_commander_fast_dss.exceptions), and a file that HEC software holds open for writing is
refused rather than written (DssLockedError). The gridded importer and tools are in
ras_commander_fast_dss.gridded.
Interrupted writes, sync= and repair
Writers order their steps so that a DSS7 or DSS6 file that was consistent before a write
can be reconciled after the writing process dies part-way through; the next native write
does this from the file itself. The crash model is process death, not power loss. The
format notes (dss7.md, dss6.md) give the exact steps, what is
and is not guaranteed, and the known limitations.
sync=onwrite_timeseries,write_paired_data,write_grid,write_profileandwrite_location. The default,sync=True, flushes (fsync) at the write's flush points between steps.sync=Falseis opt-in and faster for many small writes: it skips those flushes but keeps the write order that process-death recovery relies on. Neither mode claims durability on power loss.repair(src, dest)copies the readable records of a damaged DSS7 file into a new file: every readable record that its documented discovery procedure reaches (dss7.md, copy-out repair). It does not find everything a catalog might: a bin block whose declared span does not fit the file is reported as unclassified rather than salvaged, while the catalog walk salvages the whole bins of such a partial block.srcis opened read-only, each copied record is verified against the source, and an existingdestis never replaced. Always check the result: when the recovery is partial,completeisFalseandnot_copiedlists what was left out.
report = dss.repair("damaged.dss", "recovered.dss")
if not report["complete"]:
print(report["not_copied"])
FEATURES lists optional capabilities by name (repair_copy_out, write_sync_policy,
...), so callers can test for them.
With ras-commander and hms-commander
RAS Commander reads DSS boundary data through RasDss. With this package installed, select the
native backend:
from ras_commander import RasDss
RasDss.backend = "native" # or set RAS_COMMANDER_DSS_BACKEND=native
catalog = RasDss.get_catalog("model.dss")
hms-commander uses the same package for its DSS reads. See the native engine documentation for the backend options and the differences from the Java path.
Qualification
The engine is a clean-room implementation of the DSS formats, written from HEC's
MIT-licensed hec-dss source and
the format notes in docs/format/, which cite the heclib file and function
behind every rule. HEC software is used only as a test oracle; none of its code is copied,
linked or shipped.
- Reads were compared with HEC Monolith through ras-commander's Java path on the 53 public RasExamples DSS files (11,045 comparisons): every non-missing value is bit-identical and every missing position agrees; the remaining differences are documented corrections.
- Writers are checked in this repository's tests against files written by HEC's own C
library and by HEC Monolith (
fixtures/public/): the native writer, given the same input, produces word-identical records apart from write times and the program name. - Gridded import is checked against HEC-Vortex 1.1.0 output on public NOAA products and Vortex's own test resources, bit for bit where the fixtures say so.
- Hostile input: parsers bounds-check every offset and length and return errors;
dss-coreforbidsunsafecode; fuzz and allocation-limit tests run in CI.
This is qualification for the files and versions named, not a claim that every possible DSS record is covered. Comparison with HEC software does not imply HEC or USACE endorsement.
Repository layout
| Path | Contents |
|---|---|
crates/dss-core |
The format engine: DSS6 and DSS7 readers and writers (#![forbid(unsafe_code)]) |
crates/dss-vortex |
Gridded import and grid tools |
crates/dss-py |
PyO3 binding, built with maturin into ras_commander_fast_dss._native |
crates/dss-wasm |
Read-only WebAssembly binding |
python/ras_commander_fast_dss |
The Python API |
vendor/ |
hdf5-reader and netcdf-reader 0.12.1 with local patches (PATCHES.md) |
fixtures/public/ |
Public and synthetic test files, each with its provenance in README.md |
docs/format/ |
DSS6 and DSS7 format specifications |
Some comments, test names and synthetic fixture pathnames carry development labels (P20,
P46, ...) that date when a rule or test was added. They are labels only: the rules
themselves are stated in the code, the committed tests and docs/format/.
Build from source
cargo test --locked # dss-core
cargo test --locked --workspace --exclude dss-py
python -m pip install maturin
python -m maturin build --release --locked --out dist
python -m pip install dist/*.whl pytest
python -I -m pytest # tests/python against the installed wheel
dss-vortex needs Rust 1.92 or later; the other crates build with 1.80.
Attributions and acknowledgments
FAST-DSS (ras-commander-fast-dss) is an independent, pure-Rust implementation of the HEC-DSS file format, versions 6 and 7. It could not have been built without the open-source software and data published by the U.S. Army Corps of Engineers Hydrologic Engineering Center (HEC), and by the wider water-resources community.
How it was developed
The engine was written from HEC's published hec-dss C and Fortran source, which is MIT licensed. Every format rule in the code cites the HEC source file and routine it was derived from. No HEC code is copied into the engine, and no HEC library is linked or bundled: the engine has no C dependencies at build or run time.
HEC's own software served as the reference ("oracle") throughout development. Each reader and writer was compared against it on public example files, synthetic files, and a private corpus of real project files. Files written by the engine were also read back with HEC software:
- HEC-DSS C library (
hec-dss, through HEC'shecdssPython package): the reference for DSS7 reads and writes, and for file checks such aszcheckFile. - HEC Monolith, the Java DSS library used by HEC-RAS, HEC-HMS and HEC-DSSVue: the reference for DSS6, paired data, grids, and Java-path parity in ras-commander and hms-commander.
- HEC-Vortex (MIT), versions 1.1.0 and 0.13.3: the reference for the gridded importer and grid tools. Its bundled PROJ 7.2.0 and GDAL 3.2.1 were the reference for projections and resampling.
- HEC-DSSVue, HEC-RAS and HEC-HMS example data (public USACE data): the source of the real-data test fixtures.
- HEC-RAS and HEC-HMS: model runs through ras-commander and hms-commander confirmed that the software reads DSS files written by the engine.
Independent validation with pydsstools
As a final check, outputs were validated with pydsstools (MIT, https://github.com/gyanz/pydsstools), a widely used third-party Python library for HEC-DSS. The comparison covered 4,727 records (21.6 million values) from 122 DSS6 and DSS7 files, covering regular and irregular time series, patterns, paired data, and HRAP, Albers and specified grids. 4,080 records were identical bit for bit and 182 more under a documented rule (for example, pydsstools returns paired data as float32). Of the 196 records that differed, 183 differed only in metadata. pydsstools could not read 209 records that the engine read, the engine could not read 1 record type that is out of its scope (irregular profiles), and 32 corrupt or zeroed records were unreadable by both. Every difference was traced to pydsstools, to behaviour HEC's own readers share, or to a documented engine convention, with HEC Monolith used to break ties. In the write tests, each library read back exactly every time-series and paired-data value the other wrote. The check found three minor engine issues, all in edge cases of files not written by HEC software and none changing a value read from a HEC-written file; all three were fixed before this release to follow HEC's behaviour (DSS6 units and type text, DSS6 specified-grid header byte counts, and the record types used for time-invariant grids).
Thanks
Thanks to the HEC developers for publishing hec-dss, HEC-Vortex and their example data as open source, and to the pydsstools maintainers for a library the industry relies on.
FAST-DSS is an independent open-source project. It is not affiliated with, endorsed by or supported by HEC or USACE. HEC-DSS, HEC-RAS, HEC-HMS, HEC-DSSVue and HEC-Vortex are products of the U.S. Army Corps of Engineers.
License
MIT; see LICENSE. Some modules port code under other permissive licences (BSD-3-Clause, MIT): NOTICE names each one and carries its notice, and THIRD_PARTY_NOTICES.md covers the Rust dependencies.
HEC-DSS, HEC-RAS, HEC-HMS, HEC-DSSVue and HEC-Vortex are products of the US Army Corps of Engineers Hydrologic Engineering Center. This project is independent of HEC and USACE.
If you use this package in published work, please consider citing RAS Commander: https://rascommander.info/ras/cite/.
Metadata
Release files for ras-commander-fast-dss 0.1.1
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 |
|---|---|---|---|---|
| ras_commander_fast_dss-0.1.1.tar.gz | 2.5 MB | Without provenance | Details for ras_commander_fast_dss-0.1.1.tar.gz |
Built distributions (wheels)
Total release size: 17.8 MB
Release files / ras_commander_fast_dss-0.1.1.tar.gz
| Download URL | ras_commander_fast_dss-0.1.1.tar.gz |
|---|---|
| Size | 2.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2c7abf6f106071e5db879701da7f9073a201840ecfdb4d41713525e5dc46cac
|
|
BLAKE2b-256 checksum How to use checksums |
27969e35849c3e4cdc649a1d11bbc9f74b3cfd36072979109e4408f33042e617
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ras_commander_fast_dss-0.1.1-cp310-abi3-win_amd64.whl
| Download URL | ras_commander_fast_dss-0.1.1-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 3.0 MB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
a43cd281c57dfbeb3611bc521dc92437758d339aaedfc93a98772886277827f2
|
|
BLAKE2b-256 checksum How to use checksums |
039e663f4ba3def8cd1195ad1949321792cc3af8e11d5825165d8644ca8bb22b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ras_commander_fast_dss-0.1.1-cp310-abi3-musllinux_1_2_x86_64.whl
| Download URL | ras_commander_fast_dss-0.1.1-cp310-abi3-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 3.3 MB |
| Tags | CPython 3.10 Linux musl 1.2+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
93c2760719f9583c4274eea36fcfd1b39166771934738a07531de29d96fbbc88
|
|
BLAKE2b-256 checksum How to use checksums |
9e1ab4568bd314464a58eac41e1a5718d795a0b846b59ef56105f2682daf6083
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ras_commander_fast_dss-0.1.1-cp310-abi3-musllinux_1_2_aarch64.whl
| Download URL | ras_commander_fast_dss-0.1.1-cp310-abi3-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 3.1 MB |
| Tags | CPython 3.10 Linux musl 1.2+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
21ecab54c8f16612ee10aa758007dab3536009b2c10e21ab599240e4313eb880
|
|
BLAKE2b-256 checksum How to use checksums |
d65f1cb27b055926f0e3695eff6c7372df2a0678babcc3569387a43cb71e95e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ras_commander_fast_dss-0.1.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | ras_commander_fast_dss-0.1.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 3.1 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
93e6c55d4163a2ea86e102eb885dcc9deec2213272667e52ba4f04f596c724b8
|
|
BLAKE2b-256 checksum How to use checksums |
b60ba168df77feaca77074c70668e56f1fbc633c642e09e038c3a87f9519472c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ras_commander_fast_dss-0.1.1-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | ras_commander_fast_dss-0.1.1-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 2.9 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
5d6b9e6ee17c16a515f791c4d480b3b5b426317a322c88cb5de792cb3cacbd03
|
|
BLAKE2b-256 checksum How to use checksums |
053ee9b3cbcbca1a61786a936abc7a31e94de365d8b8331ed91755d6244fe767
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for ras-commander-fast-dss 0.1.1
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.